SDK Documentation PUBLIC

SAP Cloud Applications Studio – Version May 2018 (1805)

SAP Cloud Applications Studio 1805 (May 2018)

Table Of Contents

1 Working with the Studio Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

2 Upgrade Information for Customer-Specific Solutions . . . . . . . . . . . . . . . . . . . . . . 16

3 Log on to the Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

4 What's New (1805) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

4.1 What's New in the SAP Cloud Applications Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

5 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
5.1 Getting Started with the Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
5.2 About the SAP Cloud Applications Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
5.3 Feature Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
5.4 First Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Installing and Updating the SAP Cloud Applications Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
User Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
User Setup Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
5.5 Introduction to the Integrated Development Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Working in the Integrated Development Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Using Help Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Help Content: Questions and Answers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
My Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Repository Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Execute a Query to Explore a Business Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Solution Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Add New Item Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Properties Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Trace Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Working with the Wizards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Icon Library (Studio) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Icon Library (UI Designer) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
5.6 Public Solution Model (PSM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
About the Public Solution Model (PSM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
5.7 Introduction to Business Object Modelling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Business Object Modeling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Business Object Modeling: Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Look Up the Representation Term of a Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Business Object Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

SAP Cloud Applications Studio – Version May 2018 (1805)

Table Of Contents P U B L I C • © 2018 SAP SE. All rights reserved. 3
5.8 Example: Build a Simple Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Example: Building a Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Sample Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Further Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
5.9 Using the Localization Toolkit (SAP Business ByDesign) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

6 Administration and Lifecycle Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

6.1 Overview of Administration and Lifecycle Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
6.2 Lifecycle Management of Customer-Specific Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
6.3 Quality Criteria for Customer-Specific Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
6.4 Developing on a Customer's Tenant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Lifecycle Management for Customer-Specific Solutions on a Customer's Test Tenant . . . . . . . . 143
Create a Patch on a Customer's Test Tenant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
What You Need to Consider When a Change Project Is on the Same Test Tenant . . . . . . . . . . . . 146
6.5 Developing on Your Development Tenant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Lifecycle Management of Customer-Specific Solutions on Your Development Tenant . . . . . . . . . 147
Create a Patch on Your Development Tenant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Switch a Customer Assignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
6.6 Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Administration Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Implementation Manager Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Migration Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
6.7 Solutions, Solution Templates, and Patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Solution Templates Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Solution Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Create a Solution Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Create a Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Enable or Disable Your Solution in the SAP Cloud Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
6.8 Bug Fix in Production and Pre-production Tenants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
6.9 Maintenance Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

7 Scripting Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

7.1 Overview of Scripting Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
7.2 Scripting Language for the Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Scripting Language Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Business Object Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Business Object Extension Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Business Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
SAP Reuse Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Basic SAP Reuse Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
SAP Reuse Libraries for Business Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
SAP Built-In Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Basic Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
7.3 Front-End Script for the UI Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

SAP Cloud Applications Studio – Version May 2018 (1805)

4 © 2018 SAP SE. All rights reserved. • P U B L I C Table Of Contents
 Front-End Script Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Lexical Structure of Front-End Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Syntax of Front-End Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Front-End Code Snippets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Interacting with Runtime Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Global Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

8 Developer Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

8.1 Overview of the Developer Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
8.2 Business Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Business Configuration Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Business and Technical Background . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
8.3 Business Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
Business Objects Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
Business and Technical Background . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
8.4 Extensibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Business Object Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
Process Extension Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
Create an ODATA Service Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
Enhancement Implementations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
8.5 Reuse Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Reuse Library Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Create Your Reuse Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
8.6 Code List Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
Create a Code List Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
Example: Create a Code List Data Type (Purchase Order Request) . . . . . . . . . . . . . . . . . . . . . . 408
8.7 Data Protection and Privacy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Enable Data Disclosure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Enable Data Removal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
Enable Read Access Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
Enable Personal Data for Extension Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
8.8 Approval Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Approval Process Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Example: Create an Approval Process (Price Request) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
Business and Technical Background . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
8.9 Notification Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Enable Notification Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Example: Enable Notification Rules (Price Request) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
8.10 Print Forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
Print Forms Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
Associating an .xdp File with Adobe LiveCycle Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
Create a Print Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438

SAP Cloud Applications Studio – Version May 2018 (1805)

Table Of Contents P U B L I C • © 2018 SAP SE. All rights reserved. 5
 Test a Print Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
8.11 Analytics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Analytics Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Business and Technical Background . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
8.12 Mass Data Run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
Mass Data Run Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
Mass Data Run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
Create a Mass Data Run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Assign MDR Work Center View to UI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
Test the Mass Data Run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
Example: Changing the Status of a Price Request (Mass Data Run) . . . . . . . . . . . . . . . . . . . . . . 470
8.13 Mashups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Mashups Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Business and Technical Background . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
8.14 Service Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
Service Integration Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
Condition Evaluation for Internal Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
8.15 Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
Web Services Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
Web Service Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537
External Web Service Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
8.16 Report an Incident . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
8.17 Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
Debugging Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
Business and Technical Background . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
8.18 Tracing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
Tracing Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
Tracing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
Trace Class and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
8.19 Dump Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
Dump Analysis Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
8.20 Translation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Translation Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Business and Technical Background . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590

9 User Interface Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594

9.1 User Interface Designer Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
9.2 Getting Started with the User Interface Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Features of the User Interface Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595

SAP Cloud Applications Studio – Version May 2018 (1805)

6 © 2018 SAP SE. All rights reserved. • P U B L I C Table Of Contents
9.3 Modeling Floorplans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Floorplan Modeling Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
9.4 Modify Your Floorplans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621
Floorplan Modification Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621
Business and Technical Background . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
9.5 Modify an SAP Floorplan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Change Transactions Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Business and Technical Background . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
9.6 User Interface Modifications for Mobile Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
Mobile Floorplans Quick Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
Mobile Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673

10 Style Guides and Reference Guides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682

10.1 Overview of Style Guides and Reference Guides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
10.2 Style Guides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Style Guide for Writing System Message Texts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Standards for Errors and Failures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
Standards for Inability to Perform Action, Status and Authorization Problems . . . . . . . . . . . . . . 688
Standards for Existence and Availability of Objects, Missing Data, and Search Results . . . . . . . . 691
Standards for Invalid Data and Value Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
Standards for Comparison Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
Standards for Object Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
Standards for Application Log Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
General Standards for Message Long Texts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
10.3 Reference Guides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
Reference Guide for Documentation for Cloud Solutions from SAP . . . . . . . . . . . . . . . . . . . . . . 708

11 Copyright / Legal Notice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724

12 Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725

13 Important Disclaimers on Legal Aspects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760

SAP Cloud Applications Studio – Version May 2018 (1805)

Table Of Contents P U B L I C • © 2018 SAP SE. All rights reserved. 7
1 Working with the Studio Library

In this library you can view reference documentation about the SAP Cloud Applications Studio (“studio”). The library
contains reference documentation to help you get started with the studio, as well as information related to quality
assurance, information for studio administrators, and detailed information on development activities in the studio.
The library also contains reference documentation for the user interface designer (UI designer), and references the
general concepts and tools in the SAP cloud solutions.
You can access the library as follows:
● In the studio, select Help SAP Cloud Applications Studio Help . The library opens in your browser and
is displayed using a content player. This option does not offer a function to search the library.
● In the studio, select Help Manage Help Settings . You can install the help content manually and view the
content using Microsoft Help Viewer, which includes a search function. For more information, see Using Help
Content [page 42].
● If you install the help content using Microsoft Help Viewer, you can also access context-sensitive help for
wizards, dialog boxes, and tool windows by pressing F1 or clicking the Help icons on the UI.

This documentation does not describe the standard features and technologies in Microsoft Visual Studio. For
information about Microsoft Visual Studio, see http://www.microsoft.com .

Any software coding or code lines/strings (“Code”) provided in this documentation are only examples
and are not intended for use in a productive system environment. The Code is only intended to better
explain and visualize the syntax and phrasing rules for certain SAP coding. SAP does not warrant the
correctness or completeness of the Code provided herein and SAP shall not be liable for errors or damages
cause by use of the Code, except where such damages were caused by SAP with intent or with gross
negligence.

SAP Cloud Applications Studio – Version May 2018 (1805)

8 © 2018 SAP SE. All rights reserved. • P U B L I C Working with the Studio Library
Getting Started

First Steps

Learn about the following: ● Features of the Studio

● Installing SAP Cloud Applications Studio [page 28] The studio enables you to adapt and enhance the
You have to install the latest version of the SAP Cloud solution capabilities of the SAP cloud solution. Using
Applications Studio (“studio”) from the SAP Service the studio, you can develop, deploy, and test specific
Marketplace. This document takes you through the add-on functionality.
requirements and steps to install the studio For an overview of the studio features, see About SAP
Cloud Applications Studio [page 24].
Prior to working in the studio, you must change
the initial password provided to you in the SAP This documentation covers the studio as a
cloud solution. whole; therefore it describes all features
that are available within the studio. Not all of
● User Setup Quick Guide [page 31] these features are available for every SAP
Before you can begin working in the studio, the initial cloud solution. Before using a particular
user has to create the required users for the studio and feature, you should consult the Feature
for the SAP cloud solution. This quick guide explains Matrix to determine whether the feature is
the entire process from creating service agents, available for the SAP cloud solution for
requesting users for these service agents, assigning which you are creating a solution. If the
an ID and an initial password to each user, and feature is available, it is marked with an X in
assigning the required work centers. In addition, it also the relevant column of the matrix.
explains the process to create business users for To check which features are available for
testing purposes in the SAP cloud solution. which SAP cloud solution, see Feature
● User Roles [page 30] Matrix [page 25].
Find out about the different user roles in the studio:
○ For development purposes: Studio ● Localization Toolkit (SAP Business ByDesign only)
Administrator and Developer [page 135]
The localization toolkit is a set of development tools
○ For testing purposes: Business User
and instructions that enable SAP partners to extend
and adapt the capabilities of the SAP Business
ByDesign solution to provide a locally-compliant
solution for customers in countries where a fully-
localized SAP country version is not available.

SAP Cloud Applications Studio – Version May 2018 (1805)

Working with the Studio Library P U B L I C • © 2018 SAP SE. All rights reserved. 9
Get an Introduction to Business Object Modeling and the Public Solution Model

● Introduction to Business Object Modeling Solution Examples

[page 78] This documentation contains various solution examples. They
the SAP cloud solutions are built using the concept of include coding and show you how to use particular functions
business objects to model the business environment. of the studio. You also learn how to create a complete solution
● Public Solution Model [page 75] in the studio, configure the screens in the UI designer and how
The SAP public solution model (PSM) contains all to use the functions in SAP’s cloud solution.
entities in the SAP cloud solution that are released for Build a solution to manage the allocation of car parking spaces
use by external consumers. External consumers can to employees:
be partners who develop solutions on top of the SAP ● Example: Building a Solution [page 93]
cloud solution, such as add-ons and integration
Try out particular functions of the studio:
scenarios, or administrators in the SAP solution, who,
● Example: Context-Dependent Code List
for example, use SAP data sources to create new
● Example: Create a Code List Data Type (Purchase
reports.
Order) [page 408]
● Repository Explorer [page 50]
● Example: Enable Notification Rules (Price Request)
The Repository Explorer tool window displays SAP
[page 434]
content that is released with the public solution model
(PSM) such as business objects, data types, ● Example: Changing the Status of a Price Request
enhancement options, inbound service interfaces, and (Mass Data Run) [page 470]
reuse UIs. You can explore the content to gain an ● Example: Calculate Duration of Campaign
understanding of the repository structure and the (References to Customer-Specific Fields)
business context and use of SAP content, which you [page 392]
can reuse and enhance in your solution. ● Example: Create an Approval Process (Price Request)
[page 420]
● Example: Consume a REST Service [page 554]

SAP Cloud Applications Studio – Version May 2018 (1805)

10 © 2018 SAP SE. All rights reserved. • P U B L I C Working with the Studio Library
Administration and Lifecycle Management

Get Informed About Administration and Lifecycle Management of Customer-Specific Solutions

● Administration Quick Guide [page 151] ● Developing on Your Development Tenant

The Administration toolbar provides access to a ○ Lifecycle Management on Your Development
number of administrative tasks, such as creating a Tenant [page 147]
new solution, deleting a solution, and managing user You can develop a customer-specific solution on
sessions. your development tenant and after having
● Implementation Manager Quick Guide [page 153] tested, assembled, and downloaded the solution,
You use the Implementation Manager to manage the you can upload it to the customer's tenant.
lifecycle of customer-specific solutions. ○ Switch a Customer Assignment [page 151]
● Lifecycle Management [page 138] If you are developing customer-specific
The studio supports the full end-to-end lifecycle solutions on your development tenant, you can
management of customer-specific solutions. This create solutions for more than one customer. For
includes developing, testing, and deploying your example, if you are working on a solution for
solution, as well as creating patches to deliver updates customer A, you can save your solution and then
to your customer. switch to work on the solution for customer B. For
this, you need to switch the customer
● Developing on a Customer's Tenant [page 143]
assignment. Afterwards, in the My Solutions tool
You can develop a customer-specific solution on the
window in the studio, only the solutions of
customer's test tenant. The finalized solution is then
customer B are listed and you can create new
uploaded and activated on the customer's production
solutions only for this specific customer.
tenant.
● Quality Criteria [page 139]
Customer-specific solutions for the SAP cloud
solution are installed in a multi-tenant environment.
The solution provider needs to ensure that all solutions
are of the highest quality and have the lowest possible
Total Cost of Ownership (TCO). SAP requests you to
conform to the criteria described in this document in
order to ensure the quality of your solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

Working with the Studio Library P U B L I C • © 2018 SAP SE. All rights reserved. 11
Get Informed About Solution Templates, Patches, Maintenance Mode, and Upgrade Information

● Solution Templates [page 160] ● Maintenance Mode [page 170]

With a solution template you can organize common A customer-specific solution is in maintenance mode
development content that you want to reuse for if it has been assembled and downloaded, that is, the
customer-specific solutions. Solution templates solution status is Assembled. You can make changes
enable you to rapidly start the development of to the solution in a patch; however, you can only make
customer-specific solutions, for example, for a restricted changes to certain content types. These
specific industry change and delete restrictions ensure that you do not
● Patches [page 166] make changes to a solution that could lead to loss of
A patch is needed if you want to make changes or data or create inconsistencies or errors on a
corrections to a customer-specific solution after it has customer's production tenant.
been assembled. The customer-specific solution is ● Upgrade Information [page 16]
then in maintenance mode and you can only make Upgrade information is relevant if your customer's
restricted changes for certain content types. system is upgraded to a new release. The upgrade is
maintained by SAP to ensure high quality upgrade of
the customer's production tenant. The upgrade does
not have any impact on your customer-specific
solution. However, be aware of the downtime period
during the upgrade and follow the rules listed in this
document.

Scripting Languages

Get Informed About Scripting Languages for the Studio

● Scripting Language Reference [page 173] ● Syntax for the Implementation of Business Logic
The scripting language is used to define business [page 210]
objects and business object extensions as well as to You use these methods and keywords to implement
implement the business logic for cloud partner the business logic of your solution. For this task, you
solutions. This lightweight language is easy to learn can also use predefined built-in functions and reuse
and to use with its focused set of features. services:
The keywords, methods and functions of the scripting ○ Built-In Functions [page 276]
language are described in separate sections according ○ Basic Reuse Libraries [page 238]
to the task you want to perform:
○ Reuse Libraries for Business Areas [page 268]
○ Syntax for Business Object Definitions
[page 174] ● Basic Data Types [page 284]
You use these keywords and functions to define The scripting language supports basic data types such
the structure and interface of business objects. as string, numeric and Boolean values. In addition, the
existing metadata of the SAP underlying cloud
○ Syntax for Business Object Extension Definitions
platform for core data types (CDTs) and global data
[page 197]
types (GDTs) is made available.
You use these keywords and functions to define
the structure and interface of business object
extensions.

Get Informed About Scripting Languages for the UI Designer

● Front-End Script for the User Interface Designer [page 289]

The front-end script is the programming language used in the UI designer to define a set of rules and the logic of the
behavior of UI controls. For example, you can write a front-end script to enable an edit button only when a field is
selected on the user interface.

SAP Cloud Applications Studio – Version May 2018 (1805)

12 © 2018 SAP SE. All rights reserved. • P U B L I C Working with the Studio Library
Developer Desktop

Choose a Help Topic for the Developer Desktop

● Business Configuration [page 314] ● Analytics [page 440]

Learn how to create and change business topics, Learn how to create and change data sources, and
business options, and business configuration sets for create and manage reports, and get informed about
your solution. Also find out how to configure a business analytical report content, transformation rules, and
configuration view and assign it to the Business aggregation.
Configuration work center and how to check your In addition, find information on the tools available in
content in the business adaptation catalog. the SAP cloud solution to assist you in defining your
In addition, find information on the tools available in reports.
the SAP cloud solution to assist you in creating and ● Mashups [page 475]
editing your business configuration content. Learn about creating mashups using the studio and
● Business Objects [page 346] the UI designer.
Learn how to create a business object, define its nodes ● Service Integration [page 519]
and relevant elements, create script files, activate your Learn how to configure internal communication to
business object, and generate the screens for your communicate with business objects in different
business object. deployment units, and create XML file input to import
● Extensibility external XML data into a business object.
○ Business Object Extensions [page 378] In addition, find information on the tool for file input in
Learn how to create a business object extension, the SAP cloud solution.
define business logic for a business object ● Web Services [page 529]
extension, screens, reports, and the Enterprise Learn how to create, modify, authorize and test a Web
Search. service, and how to remove authorization to a Web
○ Process Extension Scenarios [page 395] service.
A process extension scenario links the data from ● Mass Data Run [page 464]
one business context to other related business Learn how to create a mass data run for your custom
contexts. Learn how to create a process business object.
extension scenario from a list of predefined
● Print Forms [page 438]
extension scenarios.
Learn how to create a print form, add a preview button
○ Enhancement Implementations [page 400] to it, and test the print form. In addition, find
SAP provides enhancement options based on information on the tools available in the SAP cloud
SAP technology that allow you to enhance the solution to assist you in creating and editing your print
standard behavior of specific applications of the forms.
SAP cloud solution without modifying the
● Approval Process [page 425]
standard solution. Learn how to create
Learn how to create a default approval process, assign
enhancement implementations of SAP
it to the UI, and test it.
enhancement options.
In addition, find information on the tools available in
● Reuse Libraries [page 403] the SAP cloud solution to assist you in creating and
Learn how to create and define your own reuse editing your approval process.
libraries and reuse functions to organize complex code
in your solution or to reuse your code in script files.
● Code List Data Type [page 406]
Learn how to define a code list data type for your
solution and use it when you create your custom
business object or business object extension.
● Notification Rules
Learn how to enable your custom business object for
notification rules.

SAP Cloud Applications Studio – Version May 2018 (1805)

Working with the Studio Library P U B L I C • © 2018 SAP SE. All rights reserved. 13
Find out about Debugging, Tracing, Dump Analysis, and
Translation

● Debugging [page 566] ● Dump Analysis [page 582]

Learn how to use the debugger to observe the runtime The Dump Analysis tool window presents dump
behavior of your solution and to locate logic errors. The information in a reader friendly format. Learn how the
debugger works with your script files and allows you tool window supports you in finding the root cause of
to break the execution of your solution at specified a dump.
breakpoints to examine your code and to display
● Report an Incident [page 565]
values of variables defined in your solution.
If you encounter a problem during development, you
● Tracing [page 573]
can report an incident in the SAP cloud solution to
Learn how to use tracing to record information about
request help in solving the problem.
your code as it is being executed. From the Trace
● Translation [page 584]
Explorer, you can run a local trace, run a trace for a
Find out how you can translate your solution content
business user in the SAP cloud solution, use incident
into the languages supported by the SAP cloud
traces for troubleshooting purposes, and view the
solution.
results of a recorded trace.

User Interface Designer

Get Informed About the UI Designer

● Introduction to the UI Designer [page 594]

The user interface designer (UI designer) is integrated into the studio, and you can use it to create new screens, or
modify the screens provided by SAP. The UI designer can also be used to design screens for use on mobile devices.
● Features of the UI Designer [page 595]
Get a quick overview of the common features available to develop a user interface.

Check Out How to Model and Modify Floorplans

● Floorplan Modeling [page 599] ● Change Transactions [page 654]

Get an overview of the steps involved in modeling Get an overview of the changes you can make to SAP
different types of floorplans. floorplans. These changes are termed as change
● Floorplan Modification [page 621] transactions and need anchors to be executed.
Get informed about the modifications and ● Mobile Floorplans [page 668]
enhancements you can make to the floorplans you Get an overview about how to adapt floorplans for use
created. on mobile devices and the steps involved in
configuring navigation between floorplans.

SAP Cloud Applications Studio – Version May 2018 (1805)

14 © 2018 SAP SE. All rights reserved. • P U B L I C Working with the Studio Library
Style Guides and Reference Guides

Check Out the Style Guides Check Out the Reference Guides

Style Guide for Writing System Message Texts [page 682] Reference Guide for Documentation of Cloud Solutions from
This style guide provides you with the standards and SAP [page 708]
guidelines for writing system messages to be displayed on the This reference guide provides an overview of the main
user interface (UI) of your solution. It also provides the reference documentation types specific to the SAP cloud
standards and guidelines for writing system messages that solution.
are relevant for SAP Support; these messages are not
displayed on the UI.
In addition, this style guide provides guidance on writing long-
text documents providing additional information to a system
message that helps the user to solve very complex error
situations. These long-text documents can be incorporated
into the Solution Documentation.

Discussion Forum
Ask your peers questions and search for answers.
You can find the discussion forum in the SAP Community at SAP Cloud Applications Studio Community .

SAP Cloud Applications Studio – Version May 2018 (1805)

Working with the Studio Library P U B L I C • © 2018 SAP SE. All rights reserved. 15
2 Upgrade Information for Customer-Specific
Solutions

The following information is relevant, if the tenants of your customer are upgraded to a new version. The steps you
need to take to upgrade your customer-specific solution differ according to the tenant type on which you are
developing.

Customer's Tenant
SAP maintains the upgrade to a new version to ensure high quality upgrade of the customer's production tenant and
test tenants.

What you need to consider before the upgrade

The upgrade does not have any impact on your customer-specific solution. However, during the upgrade process
you cannot continue development.

Please take into account that you cannot access the customer's tenant during the upgrade preparation phase
(this is one week before the downtime period of the upgrade) and during the upgrade period itself.

What you need to consider after the upgrade

After the tenants have been upgraded, you continue working on your solution in the studio version that matches the
SAP upgraded cloud solution version. For example, if the SAP cloud solution has been upgraded from version 1305
(May 2013) to version 1308 (August 2013), you continue working with the studio version 1308.
Please be aware of the following:
● If the solution still has the status In Development and you have activated its items before the upgrade, you
must open the solution after the upgrade in the corresponding studio version and reactivate the solution
items. Only then can you download the solution to upload it to the upgraded tenant.
● If you have downloaded a solution just before the upgrade, and then want to upload this solution to the
upgraded tenant, you must first open the solution in the studio version matching the SAP upgraded cloud
solution version. Then you must download it again, so that your solution is compatible with the version of the
SAP cloud solution. Now you can upload your solution to the upgraded tenant.

Development Tenant
SAP does not upgrade your development tenant. However, if your solution has been deployed in a customer's tenant,
it will automatically be upgraded when SAP upgrades that tenant. You can then download the upgraded version of
your solution, upload it to the next studio version, and then create a patch for this solution.
You can upload solutions that have not yet been deployed in a customer's tenant as well as solution templates to
the next studio version or the subsequent studio version, for example:

SAP Cloud Applications Studio – Version May 2018 (1805)

16 © 2018 SAP SE. All rights reserved. • P U B L I C Upgrade Information for Customer-Specific Solutions
 If you have created your solution or
solution template in this version ... ... you can upload it to this version ... and to this version

SAP Solutions OnDemand Studio 1302 SAP Solutions OnDemand Studio 1305 SAP Cloud Applications Studio 1308
(February 2013) (May 2013) (August 2013)

SAP Cloud Applications Studio – Version May 2018 (1805)

Upgrade Information for Customer-Specific Solutions P U B L I C • © 2018 SAP SE. All rights reserved. 17
3 Log on to the Repository

Overview
Before you start working in the studio, you must connect to the repository, which contains any solutions that you
develop as well as the SAP public solution model (PSM) content.

Prerequisites
You have a user and password for the repository. For more information, see User Setup Quick Guide [page 31].

Procedure
1. Open the studio.
2. The Connect to Repository dialog box is displayed. Select the System that contains the repository to which
you want to connect.

In most cases, only one System is available; this is your development repository.
To edit the repository system connection, from the Administration menu, click the pencil icon ( ) to
the right of the System field or select Options and Settings and edit the settings on the Connectivity
tab.

3. Enter your User ID and Password; then click OK.

There is an information icon to the right of each entry field. When you click one of them, the system displays
information about the corresponding entry field.
To change your password, click the pencil icon ( ) to the right of the Password field. The SAP cloud solution
opens where you can change your password: Enter your credentials and click Change Password. You are then
prompted to enter a new password.

If you face an error, it may be due to any of the following reasons:

● While logging to the SAP Cloud Application Studio for the first time , you have not maintained
the correct proxy settings. To solve the issue, follow the steps below:
1. Go to SAP Cloud Application Studio Connect Repository and click on Edit System Entries.
2. Go to the Connectivity tab and select your host system.
3. Choose your Proxy Settings as http://proxy:8080 and select Use HTTP Proxy.
4. Save the settings and then click on OK.
● Network Issues
This is generally a temporary issue. As a work around you can switch the network connection
and change it back to the previous one.
● Incorrect URL
The host URL should be the tenant URL only.

SAP Cloud Applications Studio – Version May 2018 (1805)

18 © 2018 SAP SE. All rights reserved. • P U B L I C Log on to the Repository
Result
After you have logged on to the repository, any solutions that you have created appear in the My Solutions tool
window. This is what you can do from here:
● You can open a solution to view and work on the solution content in the Solution Explorer.
● You can create a new solution. For information about creating solutions, see Create a Customer-Specific
Solution [page 165].
● When you hover over a solution in the My Solutions window, a quick info text is displayed. It shows the name,
description, type, and status of the solution and tells you, if the solution is a patch solution. This is an example
of such a quick info text:

Name: Y77VXGW3Y_

Description: My Test Solution

Type: Customer-Specific Solution

Status: In Development

Patch Solution: No

See Also
My Solutions [page 49]
Solution Explorer [page 55]
Repository Explorer [page 50]

SAP Cloud Applications Studio – Version May 2018 (1805)

Log on to the Repository P U B L I C • © 2018 SAP SE. All rights reserved. 19
4 What's New (1805)

4.1 What's New in the SAP Cloud Applications Studio

This document provides information about what is new in the SAP Cloud Applications Studio version 1805 (May
2018).

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Any software coding or code lines/strings (“Code”) provided in this documentation are only examples
and are not intended for use in a productive system environment. The Code is only intended to better
explain and visualize the syntax and phrasing rules for certain SAP coding. SAP does not warrant the
correctness or completeness of the Code provided herein and SAP shall not be liable for errors or damages
cause by use of the Code, except where such damages were caused by SAP with intent or with gross
negligence.

What Is New in All Cloud Solutions

In version 1805 of the SAP Cloud Applications Studio, the following features are new:
● Deletion and Depersonalization of Personal Data
You can remove and depersonalize data from the following:
○ Extension Nodes
○ Custom Business Objects
○ Custom Business Object Nodes

You can also remove the change history from the custom objects.
To depersonalize data of standard business objects, use the
DataPrivacyDestructionOfCustomDataBOBased enhancement option.
You can use the BADI filter to specify which business object you want to depersonalize. If no filter is specified,
the implementation is executed for all the business objects.
For more information, see Depersonalize Transactional Data
● Sensitive Personal Data for Extension Node Fields
You can now define fields that contain sensitive personal data for business partners in extension node fields.
When these fields are viewed by a business user, a Read Access Log (RAL) entry is created. Fields can be
defined as sensitive personal only if the extension node is enabled for change history.
● Change History Deletion for Extension Nodes
Change history for extension nodes is included in the data removal process. When you remove the business
partner using the data privacy tool, you can also remove change history for extension nodes that may have
personal data.
Note that the extension node should be enabled for change history using the [ChangeHistory] annotation.

SAP Cloud Applications Studio – Version May 2018 (1805)

20 © 2018 SAP SE. All rights reserved. • P U B L I C What's New (1805)
 ● Read Access Logging for Custom Form templates
You can now enable read access logging for sensitive fields displayed in custom form templates. When a user
opens, downloads, or prints a PDF form containing sensitive data, a read access log is created.
● Lazy Loading for Embedded Components
Lazy loading for embedded components is enabled by default. You have an option to disable it.

SAP Cloud Applications Studio – Version May 2018 (1805)

What's New (1805) P U B L I C • © 2018 SAP SE. All rights reserved. 21
5 Getting Started

5.1 Getting Started with the Studio

Getting Started encompasses the following reference material:

First Steps

Learn about the following: ● Features of the Studio

● Installing SAP Cloud Applications Studio [page 28] The studio enables you to adapt and enhance the
You have to install the latest version of the SAP Cloud solution capabilities of the SAP cloud solution. Using
Applications Studio (“studio”) from the SAP Service the studio, you can develop, deploy, and test specific
Marketplace. This document takes you through the add-on functionality.
requirements and steps to install the studio For an overview of the studio features, see About SAP
Cloud Applications Studio [page 24].
Prior to working in the studio, you must change
the initial password provided to you in the SAP This documentation covers the studio as a
cloud solution. whole; therefore it describes all features
that are available within the studio. Not all of
● User Setup Quick Guide [page 31] these features are available for every SAP
Before you can begin working in the studio, the initial cloud solution. Before using a particular
user has to create the required users for the studio and feature, you should consult the Feature
for the SAP cloud solution. This quick guide explains Matrix to determine whether the feature is
the entire process from creating service agents, available for the SAP cloud solution for
requesting users for these service agents, assigning which you are creating a solution. If the
an ID and an initial password to each user, and feature is available, it is marked with an X in
assigning the required work centers. In addition, it also the relevant column of the matrix.
explains the process to create business users for To check which features are available for
testing purposes in the SAP cloud solution. which SAP cloud solution, see Feature
● User Roles [page 30] Matrix [page 25].
Find out about the different user roles in the studio:
○ For development purposes: Studio ● Localization Toolkit (SAP Business ByDesign only)
Administrator and Developer [page 135]
The localization toolkit is a set of development tools
○ For testing purposes: Business User
and instructions that enable SAP partners to extend
and adapt the capabilities of the SAP Business
ByDesign solution to provide a locally-compliant
solution for customers in countries where a fully-
localized SAP country version is not available.

SAP Cloud Applications Studio – Version May 2018 (1805)

22 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 Get an Introduction to Business Object Modeling and the Public Solution Model

● Introduction to Business Object Modeling Solution Examples

[page 78] This documentation contains various solution examples. They
the SAP cloud solutions are built using the concept of include coding and show you how to use particular functions
business objects to model the business environment. of the studio. You also learn how to create a complete solution
● Public Solution Model [page 75] in the studio, configure the screens in the UI designer and how
The SAP public solution model (PSM) contains all to use the functions in SAP’s cloud solution.
entities in the SAP cloud solution that are released for Build a solution to manage the allocation of car parking spaces
use by external consumers. External consumers can to employees:
be partners who develop solutions on top of the SAP ● Example: Building a Solution [page 93]
cloud solution, such as add-ons and integration
Try out particular functions of the studio:
scenarios, or administrators in the SAP solution, who,
● Example: Context-Dependent Code List
for example, use SAP data sources to create new
● Example: Create a Code List Data Type (Purchase
reports.
Order) [page 408]
● Repository Explorer [page 50]
● Example: Enable Notification Rules (Price Request)
The Repository Explorer tool window displays SAP
[page 434]
content that is released with the public solution model
(PSM) such as business objects, data types, ● Example: Changing the Status of a Price Request
enhancement options, inbound service interfaces, and (Mass Data Run) [page 470]
reuse UIs. You can explore the content to gain an ● Example: Calculate Duration of Campaign
understanding of the repository structure and the (References to Customer-Specific Fields)
business context and use of SAP content, which you [page 392]
can reuse and enhance in your solution. ● Example: Create an Approval Process (Price Request)
[page 420]
● Example: Consume a REST Service [page 554]

Any software coding or code lines/strings (“Code”) provided in this documentation are only examples
and are not intended for use in a productive system environment. The Code is only intended to better
explain and visualize the syntax and phrasing rules for certain SAP coding. SAP does not warrant the
correctness or completeness of the Code provided herein and SAP shall not be liable for errors or damages
cause by use of the Code, except where such damages were caused by SAP with intent or with gross
negligence.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 23
5.2 About the SAP Cloud Applications Studio

The SAP Cloud Applications Studio (“studio”) for the SAP cloud solutions enables SAP partners, resellers, and
customers to adapt and enhance the solution capabilities of the SAP cloud solutions.
The development tools provided are presented in an integrated development environment (IDE) based on Microsoft
Visual Studio. Using the studio, you can develop, deploy, and test specific add-on functionality. Furthermore, you
can create and integrate new business content, services, and user interfaces to provide complete micro-vertical
business solutions.
The studio allows SAP partners, resellers, and customers to work with the same entities that SAP uses in the core
development of its cloud solutions and to develop solution capabilities that have the same look and feel as the SAP
standard cloud solutions.

Customer-Specific Solutions
The development of a customer-specific solution is triggered by a customer requirement. The solution is typically
developed by a reseller for a specific customer.
For information about the development scenarios for customer-specific solutions, see Lifecycle Management of
Customer-Specific Solutions [page 138].

Features

Integrated Development Environment

The studio is based on a local integrated development environment (IDE) that:
● Provides access to a hosted repository.
● Provides access to all tools you need to create and enhance the functionality of the SAP standard cloud
solution.
● Is integrated with the tools that administrators work with in the SAP cloud solution.
● Allows you to manage the entire the entire lifecycle of customer-specific solutions, including development,
testing, and assembly.
● Makes it easy and quick for you to perform activities through features such as wizards for multistep tasks.
● Simplifies programming through features such as code completion.

For information about the specific features and tools provided by the studio, see Working in the Integrated
Development Environment [page 37].

Lightweight Scripting Language

You use the scripting language to define business objects and business object extensions and to implement the
business logic for solution capabilities. The scripting language is a lightweight scripting language. Its syntax is easy
to learn and to enter using a simple code editor.
For information, see Scripting Language Reference [page 173].

SAP Cloud Applications Studio – Version May 2018 (1805)

24 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
Model-Based Development
The SAP public solution model (PSM) contains all entities in the SAP cloud solution that are released for use by
external consumers. External consumers can be partners who develop solutions such as add-ons and integration
scenarios on top of the SAP cloud solution or administrators who, for example, use SAP data sources to create new
reports in SAP' cloud solution.
For information about the basic principles of the PSM and SAP content types, see About the Public Solution Model
(PSM) [page 75].

Designer for Desktop and Mobile User Interfaces

You use the UI designer to create new and replace existing user interfaces (UI). You can create and modify UI
components using floorplans, patterns, and UI controls.
For information about the UI designer, see Introduction to the User Interface Designer [page 594].

Integration with Services

You can generate web services to access SAP business objects and the business objects of add-on solutions. You
can also set up communication between business objects residing in different deployment units and import external
XML data into business objects.
For information about web services, see Web Services Quick Guide [page 529].
You can also integrate data from the SAP cloud solution with data provided by an online web service or application
by creating mashups. Mashups can include web searches, company or industry-specific business information or
online map searches.
For information about mashups, see Mashups Quick Guide [page 475].

Translation Support
You can extract text from certain project items and export it in an XML-based file format for translation into one of
the languages supported by the SAP standard cloud solution.
For information about the functions that support translation of a solution, see Translation Quick Guide
[page 584].

End-to-End Software Lifecycle Management

Integration with the SAP cloud solution provides a strong lifecycle management backbone that supports the full life
cycle of solutions.
For information about the development scenarios for customer-specific solutions, see Lifecycle Management of
Customer-Specific Solutions [page 138].

Cloud Readiness
The studio supports the development of solution capabilities that are tailored for specific customers. The
development and deployment of these solution capabilities causes no disruption to daily business because the
upload process of a solution to a customer's production system does not require any system downtime.

5.3 Feature Matrix

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes all
features that are available within the studio. Not all of these features are available for every SAP cloud solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 25
Before using a particular feature, please consult the matrix below to determine whether the feature is available for
the SAP cloud solution for which you are creating a solution. If the feature is available, it is marked with Yes in the
relevant column.

General Features

SAP Business SAP Hybris Cloud SAP Cloud for Travel and
ByDesign for Customer Expense

Business Objects Yes Yes Yes

Query Yes Yes Yes

Print Forms Yes Yes No

Translation Yes Yes Yes

Analytics Yes Yes Yes

Approval Process Yes Yes Yes

Notification Rules No Yes No

Code List Data Type Yes Yes Yes

Mass Data Run Yes Yes Yes

Scripting Language

SAP Business SAP Hybris Cloud SAP Cloud for Travel and
ByDesign for Customer Expense

Business objects Business objects Activity Business objects

● Activity Task ● Activity business object ● Activity Task
● Appointment Activity Task plus type code ● Appointment
● ● Appointm Activity
Email Activity
ent ● Email Activity
● Phone Call Activity
Activity
● Phone Call
● Email Activity
Activity
● Phone
Call
Activity

Business Configuration

SAP Business SAP Hybris Cloud SAP Cloud for Travel and
ByDesign for Customer Expense

BAC Elements Yes Yes Yes

Business Configuration Object Yes Yes Yes

Business Configuration Set Yes Yes Yes

Business Configuration View Yes Yes Yes

Fine-Tuning Project Template Yes No No

Tax Decision Tree Yes No No

SAP Cloud Applications Studio – Version May 2018 (1805)

26 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
Extension

SAP Business SAP Hybris Cloud SAP Cloud for Travel and
ByDesign for Customer Expense

Business Object Extensions Yes Yes Yes

Enhancement Implementations Yes Yes Yes

Embedded Components Yes Yes Yes

Process Extension Scenarios Yes Yes Yes

References to Customer-Specific Fields Yes Yes Yes

For a list of supported Business Object Extensions, check the documents below:
● Node (Business Object Extension) [page 204]
● Action (Business Object Extension) [page 199]

Mashups

SAP Business SAP Hybris Cloud SAP Cloud for Travel and
ByDesign for Customer Expense

All types of mashups Yes Yes Yes

Screens

SAP Business SAP Hybris Cloud SAP Cloud for Travel and
ByDesign for Customer Expense

Thing Inspector, Quick Create, Quick View No Yes Yes

All other screen types Yes Yes Yes

Object-Based Navigation Yes Yes Yes

Thing-Based Navigation No Yes Yes

UI Switch Yes Yes Yes

Service Integration

SAP Business SAP Hybris Cloud SAP Cloud for Travel and
ByDesign for Customer Expense

Communication Scenario Yes Yes Yes

External Web Service Integration Yes Yes Yes

Internal Communication Yes Yes Yes

Web Service Yes Yes Yes

XML File Input Yes Yes Yes

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 27
5.4 First Steps

5.4.1 Installing and Updating the SAP Cloud Applications Studio

Installing the Studio

To build solutions for the SAP cloud solutions from version August 2013 (1308) on, you install the SAP Cloud
Applications Studio.

Prerequisites
● To download the studio from the SAP Software Download Center, you need a valid S user.
● You are using one of the following operating systems:
○ Microsoft Windows XP
○ Microsoft Windows Vista
○ Microsoft Windows 7 or higher
● You have installed the following:
○ Relevant version of Microsoft .NET Framework
○ Relevant version of Microsoft Visual Studio 2010 Shell (Isolated)
○ Relevant version of Microsoft Silverlight

Partners are required and solely responsible to regularly install security updates or patches provided by
Microsoft Corporation for the Microsoft .NET Framework and Microsoft Visual Studio 2010 Shell (Isolated).
As these components need to be installed/obtained by the partner, SAP is not responsible for installation of
any related security updates or patches. For more information, see http://www.microsoft.com .

● The studio version must match the release version of the SAP cloud solution for which you are creating a
solution.

Release of the SAP Cloud Solution Version of the Studio

SAP Business ByDesign 1702 SAP Cloud Applications Studio 1702

SAP Cloud for Customer 1702

SAP Business ByDesign 1711 SAP Cloud Applications Studio 1711

SAP Cloud for Customer 1711

To determine the release version in the SAP cloud solution, click Help About [SAP cloud solution] and
verify that the Technical Release details match the latest build version of the studio.
● Previous Build
If relevant, you have removed the previous build. Check the sections below on updating your studio installation

SAP Cloud Applications Studio – Version May 2018 (1805)

28 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 ● You have signed the relevant contract and you have an S-User for the SAP Software Download Center and
for the Business Center for Cloud Solutions from SAP.
If you do not have access or you do not see any search results, contact solution partner management.
● You have maintained your access details and those of any additional contacts in your company by using the
Manage My Partnership Application at www.sappartneredge.com Partner Login My Partnership
Manage My Partnership Application .

Steps
1. Go to the SAP Software Download Center at https://support.sap.com/swdc .
2. Select the Software Downloads tab. The system opens a new window.
3. In the Search field, enter Studio XXXX where XXXX stands for the studio release version. The system gives
you a list of the available studio versions. .
4. Click on the required SAP CLOUD APP STUDIO product Version. The system takes you to your company’s
download catalog.

If the search does not produce any results, you might not have a valid S user. In such a case, please
contact solution partner management.

5. Click on the Downloads tab, select your solution and under the Action header, click on the arrow icon. Choose
Download from the list of available actions.

If you encounter any issues, please contact SAP Partner Management by writing an e-mail to
[email protected].

Updating Your Studio Installation

Once you have installed the studio, you should make sure that you keep your studio installation up-to-date. SAP
usually publishes new studio builds every two weeks in the SAP Software Download Center. You can check the build
date of your installation under Help About SAP Cloud Applications Studio .
Please note that as from version 1302 of the studio you can use the Check for Updates function in the Help menu.
When you select this function, the studio checks if a newer version of your studio is available on the SAP Software
Download Center . In case a new version is available, you are informed accordingly and you can directly start an
update process. The update process automatically removes the studio, downloads the latest version from the SAP
Software Download Center and installs it. Please make sure to save your work before updating the studio. You require
the same authorization for this process as for the manual download of the studio from the SAP Software Download
Center . If you experience problems with the automatic download, please check if you can manually download the
studio from the SAP Software Download Center .

Automatic Check for Updates

You can enable the studio to check for updates automatically. To do this, in the studio, go to Administration
Options and Settings Update , click the checkbox and enter how often the system should check for updates.

Automatic Update of Local Help

When you install a new build of the studio the local help is now also installed automatically.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 29
5.4.2 User Roles

The studio has the following user roles:

Developer
Developers can perform the following tasks:
● Create and maintain all types of development objects, such as business objects and user interfaces, in the
studio, user interface (UI) designer, and administrator tools for the SAP cloud solutions
● Access work center views for Analytics

For more information about what the developer role can do, see the reference documentation in the section
Developer Desktop [page 312].

Studio Administrator

The studio administrator must not be confused with the administrator in the SAP cloud solution. These
users have different roles.

Studio administrators can perform all tasks that a developer can perform. In addition, studio administrators can
perform the following tasks:
● Create new solutions
● Delete solutions
● Submit solutions for certification
● Submit patch requests
● Delete sessions and locks for other users

For more information about the tasks that only a studio administrator can perform, see:
● Administration Quick Guide [page 151]
● Implementation Manager Quick Guide [page 153]

Business User
The business user role is used for testing within the development or test tenant of the SAP cloud solution. Business
users have authorizations and restrictions equivalent to users on a customer tenant; they have no authorization
within the studio.
Business Users can perform the following tasks (depending on their access rights):
● Create additional business users
● Assign work center views to other business users
● Grant instance-based authorizations to other business users
● Perform business configuration scoping and deployment
● Start a trace from within the SAP cloud solution

SAP Cloud Applications Studio – Version May 2018 (1805)

30 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
Setting Up the Users
For information on how to set up the users for each of the roles, see User Setup Quick Guide [page 31].

5.4.3 User Setup Quick Guide

Before you can begin administrating, developing, or testing solutions in the SAP Cloud Applications Studio (“studio”),
you have to create development users (studio administrator and developer user roles) and business users. You
create these users in the SAP cloud solution
After these users have been created, the development users must change their initial passwords and maintain
contact data. Business users only need to change their initial passwords.

Development users with studio administrator or developer user roles are for use in the studio only.
Business users are for use in the SAP cloud solution.

Business and Technical Background

User Roles
The user roles are Studio Administrator, Developer, and Business User.
For more information, see User Roles [page 30].

Administration Toolbar and Implementation Manager

The studio administrator user has authorization for the Administration toolbar and the Implementation Manager,
which provides access to a number of administrative tasks.
For more information, see:
● Administration Quick Guide [page 151]
● Implementation Manager Quick Guide [page 153]

User and Access Management in the SAP Cloud Solution

To manage users and assign access rights, choose:

SAP Cloud Solution Work Center View

SAP Business ByDesign Application and User Management User and Access Management Business Users

SAP Cloud for Customer Administrator General Settings Users Business Users
or Application and User Management Business Users

SAP Cloud for Travel and Application and User Management User and Access Management Business Users
Expense

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 31
Tasks

Prerequisites
● Prerequisites for creating service agents, assigning user IDs and passwords, assigning work centers, and
creating business users:
○ You have an initial business user. The initial user is provided to you during the tenant provisioning
process. Only use the initial business user in the SAP cloud solution. Do not use it in the studio.
○ To create the service agent, you need access to the following work center views:

SAP Cloud Solution Work Center View

SAP Business ByDesign Business Partner Data Service Agents

Project Management Service Agents
Resource Management

SAP Cloud for Customer Business Partners Service Agents

SAP Cloud for Travel and Expense Business Partners Service Agents

For SAP Cloud for Travel and Expense:

To ensure you have access to the Business Partners work center, follow the instructions related
to the initial user in the Master Guide for SAP Cloud for Travel and Expense in the sections Define
Project Scope and Create Service Agent.
Before you start working with the Master Guide, make sure you have the latest version. You can
find the latest version at the following location: http://service.sap.com/instguides under
Cloud Solutions from SAP SAP Cloud for Travel and Expense .

○ To assign access rights to the business user, you need access to the following work center views:

SAP Cloud Solution Work Center View

SAP Business ByDesign Application and User Management Business Users

SAP Cloud for Customer Administrator General Settings Users Business Users
or Application and User Management Business Users

SAP Cloud for Travel and Expense Application and User Management Business Users

● Prerequisites for maintaining contact data:

You have a service agent user ID that matches the technical ID of the service agent.

Tasks of the Initial User

Before starting to develop in the studio, you have to create the required development users with the relevant
administration or developer rights. You do this by creating service agents in the SAP cloud solution, and assigning
the relevant user ID, password, and work centers to those service agents.

Create a Service Agent and Request a User (for Development Users)

1. Open the Service Agents view as follows:

SAP Cloud Applications Studio – Version May 2018 (1805)

32 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 SAP Cloud Solution Work Center / Work Center View

SAP Business ByDesign Business Partner Data —> New Service Agent
Project Management —> New Service Agent
Resource Management —> New Service Agent

SAP Cloud for Customer Business Partners —> New Service Agent
Project Management —> New Service Agent
Resource Management —> New Service Agent

SAP Cloud for Travel and Expense Business Partners —> New Service Agent

2. Click New and select Service Agent.

The New Service Agent quick activity opens.
3. Enter a service agent ID and a name.

If the Service Agent ID field is enabled, your entry must have the prefix EXT.
If internal number assignment is active, the system determines the new ID.
For the ID, the system uses the naming convention <LastName><FirstName><ServiceAgentID>.
For example, the service agent ID for Kate Jacob could be JACOBKATEEXT999.

4. Note down the service agent ID.

5. Save the service agent and click Request User .
The system creates a user for the service agent.
6. Click Save and close the editor.

Assign a User ID and a Password to the Service Agent (for Development Users)
1. Open the Business Users view by clicking Application and User Management User and Access
Management Business Users .
2. Search for the service agent (business user) that you created. For the search, enter one of the following:
● *<ServiceAgentID> (for example, *EXT999)
● Name
3. Click Edit and select Attributes.
The Business User quick activity opens.
4. In the User Data screen area, define a user ID, for example, the last name of the service agent.
5. In the Language field, set the language to English.
You must set the language to English to ensure the consistency of your solution, because the logon language
of both the SAP cloud solution and the studio is English
6. In the fields Password and Confirm Password, assign an initial password.
7. Click Save or Save and Close .

Assign Work Centers to the Service Agent (for Development Users)

1. Open the Business Users view as follows:

SAP Cloud Solution Work Center View

SAP Business ByDesign Application and User Management Business Users

SAP Cloud for Customer Administrator General Settings Users Business Users
or Application and User Management Business Users

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 33
 SAP Cloud Solution Work Center View

SAP Cloud for Travel and Expense Application and User Management Business Users

2. Search for the service agent (business user) that you created. For the search, enter one of the following:
● *<ServiceAgentID> (for example, *EXT999)
● Name
3. Click Edit and select Access Rights.
The Edit Access Rights quick activity opens.
4. In the Edit Access Rights editor, on the Work Center and View Assignment tab assign the following work centers
and views by selecting Assigned to User.

The work centers and views that are available for assignment depend on the SAP cloud solution,
therefore not all work center views may be available to you.
For more information about the features that are available to you in the studio and for some of
which you require these access rights, see Feature Matrix [page 25].

You can also use business roles to assign access rights to users. In the Edit Access Rights editor,
click the Business Roles tab. For more information, see the Business Roles Quick Guide in your SAP
cloud solution.

Work Center ID / Work Center

Name Work Center View ID / Name
(in Available Work Centers) (in Available Views in Work Center: <Name of Work Center>

PDI_PARTNER_DEVELOMPENT ● Developer User Role

/ Partner Development Select the following views:
○ PDI_DEVELOPMENT / Development
● Studio Administrator User Role
Select all of the following views:
○ PDI_ADMINISTRATION / Administration
○ PDI_DEVELOPMENT / Development

You need at least one user with a studio administrator role

For more information, see User Roles [page 30]

ANA_BUSINESSANALYTICS / Select all of the following views, if available:

Business Analytics ● ANA_DESIGNREPORTS / Design Reports
● ANA_DESIGN_DSO / Design Data Sources
● ANA_KUA_KF_OWL_WOC_VIEW / Design Key Figures

SAP Cloud Applications Studio – Version May 2018 (1805)

34 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 Work Center ID / Work Center
Name Work Center View ID / Name
(in Available Work Centers) (in Available Views in Work Center: <Name of Work Center>

● In SAP Cloud for Select all of the following views, if available:

Customer: Administrator ● APPROVALPROCESSES_WCVIEW / Approval Processes
or ● ITS_FORMTEMPLATEMAINT / Form Template Maintenance
TS_APPLICATIONUSER
● ITS_MASTERTEMPLATEMAINT / Master Template Maintenance
MANAGEMENT /
Application and User ● ITS_INCIDENTS / Incidents
Management ● ITS_OFFICETEMPLATEMAINT / Microsoft Office® Template Maintenance
● In all other SAP cloud ● ITS_KEYUSERCHANGELOG / Flexibility Change Log
solutions: ● MAS_MASHUPAUTHORING / Mashup Authoring
ITS_APPLICATIONUSER
● MAS_WEBSERVICEAUTHORING / Mashup Web Services
MANAGEMENT /
Application and User ● NOTIFICATION_DEFINITION / Notification Rules
Management

Work Center and View Assignment

5. Click Save or Save and Close .

6. Notify the users that you have created a user ID and an initial password.

The users must change the initial password. To do this, they must log on for the first time to the
SAP cloud solution using the assigned user ID. The system requests a new password.
The user can use the same password in both the SAP cloud solution and in the studio.

In addition to the users for the studio, you also have to create business users for use in the SAP cloud solution only.
These business users are for test purposes and are not for use in the studio.

Create and Assign Business Users (Test Users)

The Business User role is used for testing within development tenant or test tenant of the SAP cloud solution.
Business users have authorizations and restrictions equivalent to users on a customer tenant.

Do not assign the Partner Development work center and its views to a business user role. These users
must not have access to the studio.

You use business users to perform the following in the SAP cloud solution:
● Scoping and deployment of your business configuration entities
● Testing of your solution
● Starting a trace from within the SAP cloud solution

Steps
1. Create the required business users (administrator users and end users) in the SAP cloud solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 35
 2. Assign the required work centers and work center views to the business users.

To enable testing of business configuration entities, at least one standard business user must be
assigned to the Business Configuration work center.
Do not test or change business configuration entities with a development user.

3. Grant instance-based authorizations to the business users.

Development Users

Change Your Initial Password

After receiving your user details, before logging on to the studio, you must first change your initial
password in the SAP cloud solution. This is important, because you cannot change the initial password
in the studio.

1. Launch the SAP cloud solution.

2. Enter your user ID and the initial password that has been created for you by the initial user.
The system requests a new password.
3. Enter a new password and confirm the entry.
You can now also log on to the studio with your user ID and the new password.

Do not change the logon language defined for your user ID, as this causes inconsistencies in the solution.
The logon language must be English.

Maintain Your Contact Details

As a development user, you may have to create incidents for SAP Support. To ensure that these incidents are sent
directly to SAP Support, you must maintain your telephone number and e-mail address.
For information about reporting an incident in the SAP cloud solution, see Report an Incident [page 565].

If you do not maintain your contact details, when you create an incident the system forwards the incident
automatically to a development user in your organization, who has maintained contact data.

1. Log on to the SAP cloud solution with your development user and proceed as follows:

SAP Cloud Solution Work Center View

SAP Business ByDesign Home Self-Services Self-Services Overview Company Address Book Edit My
Contact Data

SAP Cloud for Customer [Your User Name] Profile

SAP Cloud for Travel and Personalize My Data

Expense

2. Enter your telephone number and e-mail address and save your entries.

Business Users

SAP Cloud Applications Studio – Version May 2018 (1805)

36 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
Change Your Initial Password

After receiving your user details, you must first change your initial password in the SAP cloud solution.

1. Launch the SAP cloud solution.

2. Enter your user ID and the initial password that has been created for you by the initial user.
The system requests a new password.
3. Enter a new password and confirm the entry.

5.5 Introduction to the Integrated Development Environment

5.5.1 Working in the Integrated Development Environment

The development tools provided by the release are presented in an integrated development environment (IDE) based
on Microsoft Visual Studio. The user interface (UI) of the release, referred to as the developer desktop, is composed
of different elements. Many elements are standard features and tools of Microsoft Visual Studio, for example, the
Menu toolbar, the Standard toolbar, various tool windows, and the document window. In addition, the developer
desktop provides UI elements that represent specific features and tools of the release development environment.
To get an idea of the integrated development environment, have a look at the following screenshot:

What the integrated development environment looks like

The UI elements of the developer desktop are docked or auto-hidden on the left, bottom, and right. The tool windows,
menus, and toolbars available depend on the type of solution or item you are working on as well as on the settings
you have applied. You can move and position the UI elements to suit your working behavior.

Availability

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 37
 This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Product Documentation
You can access the release documentation from the Help menu by selecting SAP Cloud Applications Studio Help.
The library documentation appears in your browser.
For more information, see Using Help Content [page 42].

This documentation does not describe the standard features and technologies in Microsoft Visual Studio. For
information about Microsoft Visual Studio, see http://www.microsoft.com .

Developer Desktop
The following sections describe the tools that you can use for the administration and lifecycle management of a
solution and how you can access the corresponding user interface (UI) elements.

Administration toolbar
The Administration toolbar provides a number of administrative tasks, such as creating and deleting customer-
specific solutions or solution templates and managing user sessions. You can also access the Session
Administration tool window from the Administration toolbar.

You can access the Administration toolbar in the View menu by clicking Toolbars Administration .
For more information, see Administration Quick Guide [page 151].

Session Administration
The Session Administration tool window displays a list of users in the release with open sessions. If you are assigned
the Administrator role, you can delete user sessions and any item locks that are applied for the corresponding
sessions. All other users can delete their own sessions and item locks, but they cannot delete other users' sessions
and item locks.
You can access the Session Administration tool window in the View menu and in the Administration menu.

Implementation Manager
The Implementation Manager ( ). is a tool for managing the lifecycle of customer-specific solutions. You can access
the lifecycle management functions provided by the release from a toolbar and a tool window:
● Implementation Manager tool window
The tool window provides a view of the solution status and implementation log at each stage in the process.
You can access the Implementation Manager tool window in the View menu and in the Administration menu.
● Implementation Manager toolbar
The toolbar provides buttons that allow you to assemble, upload, and create a patch for your solution.
You can access the Implementation Manager toolbar in the View menu by clicking Toolbars
Implementation Manager .

For more information, see Implementation Manager Quick Guide [page 153].

SAP Cloud Applications Studio – Version May 2018 (1805)

38 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
Administration menu
You can access existing administration and lifecycle management functions from the Administration menu. The
Administration menu also gives you access to most of the functions provided by the My Solutions tool window.
The functions available on the Administration menu are:
● Log On
For information, see Log on to the Repository [page 18].
● Log Off
● Create Solution
For information, see Create a Customer-Specific Solution [page 165].
● Delete Solution
● Session Administration
● Solution Administration
Here you can access the following functions: Trigger Test Deployment, Request Quality Review, and Create
Patch.
● Implementation Manager
● Admin Log
● Switch Customer
For information, see Switch a Customer Assignment [page 151].
● Open UI Designer
If you have opened a solution, you can navigate to the UI designer by using this function.
For more information, see Introduction to the User Interface Designer [page 594].
● Switch On/Off Admin Mode in SAP Solution
If you want to define analytics content or create a mashup, you must switch on the admin mode in the studio.
This makes sure that the system saves your content and any changes you make in your solution. Here is a
list of the functions that use the admin mode:
○ Mashups (Data, HTML, URL), see Creating Mashups [page 477]
○ Mashup Web Services (SOAP, REST, RSS/Atom), see Create a Mashup Web Service [page 501]
○ Combined Data Sources, see Create a Combined Data Source [page 457]
○ Joined Data Sources, see Create a Joined Data Source [page 459]
○ Create a Key Figure, see Create a Key Figure [page 462].
○ Reports, see Create a Report [page 460]

You cannot switch on the admin mode for solution templates. For more information, see Solution
Templates [page 162].

● Log On to System via Browser

You can open the SAP cloud solution from the studio by selecting this option.
● Update Authorizations and Access Rights
For more information about when to use this function, see Assign Access Rights [page 368].
● Options and Settings

Help Menu
The functions available on the Help menu are:
● SAP Cloud Applications Studio Help
Open the built-in help.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 39
 ● Help Content Installation
Read how to install the local help.
● SAP Community Network Forum
Access the Studio area of the SAP Community Network to read blogs and ask questions.
● View Help
Once you have installed the local help, you can access it via this menu option.
● Manage Help Settings
Install and uninstall local help files.
● Check for Updates
Check for a new build of the studio. For more information, see "Updating Your Studio Installation" in Installing
SAP Cloud Applications Studio [page 28].

For more information, see Using Help Content [page 42].

The following sections describe the tools that you can use to develop a solution and how you can access the
corresponding user interface (UI) elements.

My Solutions
The My Solutions tool window provides functions that allow you to create solutions and to access the repository. You
must log on to a repository system to create and edit solutions in the studio.
For more information, see My Solutions [page 49].

Repository Explorer
The Repository Explorer tool window displays SAP content that is released with the public solution model (PSM)
such as business objects, data types, enhancement options, inbound service interfaces, and reuse UIs. You can
explore the content to gain an understanding of the repository structure and the business context and use of SAP
content, which you can reuse and enhance in your solution.
For more information, see Repository Explorer [page 50].

Solution Explorer
The Solution Explorer tool window displays a solution and the project items created for this solution, for example, a
business object or a screen. In the Solution Explorer, you can open items for editing and add new items to a solution.
You can also search for files within a solution.
For more information, see Solution Explorer [page 55].

Add New Item dialog box

The Add New Item dialog box displays the installed item templates that SAP provides for solution development. You
can add items such as business objects, different user interface (UI) components, and Web services to your solution.
For more information, see Add New Item Dialog Box [page 58].

Properties window
The Properties window displays information about the item in your solution that is currently selected in the Solution
Explorer. When you select the solution, you can view solution properties such as the solution status. When you select
an item such as a business object or a UI component, you can view item properties such as the activation status of
runtime objects.
For more information, see Properties Window [page 66].

SAP Cloud Applications Studio – Version May 2018 (1805)

40 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
Options dialog box
You can use the Options dialog box to configure the studio to meet your needs. You can view or define settings for
the code editor as well as those relating to connectivity, debugging, runtime metadata, external tools, debugging
and tracing, and update.
You can access the Options dialog box in one of the following ways:
● On the Connect to Repository screen, click the pencil icon ( ) to the right of the System field.
● In the Administration menu, click Options and Settings.

You can change your settings for the following options:

Text Editor
Define the default behavior of the code editor for business objects, business object extensions, and actions and
events. For example, you can display line numbers in the code editor for reference purposes. To access these
settings, in the navigation pane of the Options dialog box, expand the Text Editor node and then expand the subnode
for your project item.
SAP
Click the tabs on the right to access the following options:
● Connectivity: Enter the name, host, and proxy settings of your repository system. You can also enter your
user and password and set a default system. Click Save to save your settings.
● Runtime Metadata: Clear the cache.
● Debugging and Tracing: Enter your debugging and tracing options.
For more information, see About Debugging [page 567].
● Update: Select the Check for Updates checkbox. Next time you log on to the studio, if a new studio build is
available, the system prompts you to confirm that the system should be updated.
For more information, see Installing and Updating the SAP Cloud Applications Studio [page 28].

Document windows
In the release, document windows provide a view of the items that you add to your solution. Examples of items that
you can open, edit, and save in a document window are business object definitions, extensions for existing business
object definitions, data sources, and business object queries. The type of document window in which an item opens
depends on the type of item. For example, when you open a business object definition, the business object file is
displayed in the code editor.
Document windows are displayed on tabs in the center of the developer desktop. You can switch between open
document windows by using the tabs. You can also view multiple document windows side-by-side.
You can open an item in a document window by double-clicking the item in the Solution Explorer.

If you double-click an item that represents a user interface component, such as a quick activity floorplan (QAF)
screen or a business configuration view, the item file opens in a separate window in the UI designer.

Error List window

The Error List displays errors, warnings, and messages produced as you edit code, such as syntax errors.
You can display the Error List in the View menu by selecting Error List and then use the Errors, Warnings, and
Messages buttons to select the entries you want to display. By default, the Error List is displayed at the bottom of
the developer desktop below the document windows.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 41
Output window
The Output window provides several views depending on the mode you are working in. The following views are
available:
● Solution
If you are in design mode, this view displays status messages for business objects. These messages include
errors that occur when you activate, check or clean a solution or a business object. For example, the
Output window displays a message if it is not possible to compile a business object.
For more information, see “How you can solve business object activation errors" in Activate a Business Object
[page 362].
● Debug
If you have started debugging, this view displays tracing information that the system is collecting during the
debug run. For more information, see Debugging User Interface [page 571].

You can access the Output window in the View menu by clicking Output.

Wizards
The wizards in the studio guide you through a logical sequence of steps, making it easier and quicker for you to
perform development activities that are complex, unfamiliar, or infrequently performed. All wizards are easy to
access and follow similar user interface (UI) patterns.
For more information, see Working with the Wizards [page 68].

Debug user interface

The release's debugging user interface is composed of several elements, which enable you, for example, to choose
debugging functions, to view information provided by the debugger, and to specify debug settings. For more
information, see Debugging User Interface [page 571].

Trace Explorer
The Trace Explorer is a tool for gathering and analyzing diagnostic information.
For more information, see Trace Explorer [page 68].

5.5.2 Using Help Content

The studio documentation is also called Help content. When you want to know something about a certain topic, you
can either search the integrated Help content or the local Help content.
Integrated Help Content
This Help content is integrated in the studio and installed automatically when you install the studio. The Help content
is displayed in the standard content player, and you can search for information in individual topics. This type of Help
content is very easy to access. However, we recommend using the local Help content in addition because it offers a
lot of advantages.
Local Help Content
To display the local Help content, you need to install a Help Viewer. The local Help content is also installed
automatically when you install the studio. If this does not work, you can install the local Help content manually. One
of the advantages of the local Help content is that you can search the entire studio documentation.

The following table shows the differences between the integrated and the local Help content and the advantages of
the local Help content:

SAP Cloud Applications Studio – Version May 2018 (1805)

42 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 Help Content Integrated in the
Activity Studio Local Help Content

Download Help The integrated Help content comes If you want to install the local Help content manually (see
together with the studio. below for more information), download the MS Help files from
the SAP Help Portal or SAP Business Center.
For more information, see Install Local Help Content Manually
[page 44].

Install Help The Help content is installed The local Help content is installed automatically. However, you
automatically together with the can also install it manually, for example, to install a different
studio. version.
For more information, see Install Local Help Content Manually
[page 44].

Display Help In the standard content player in In the Help Viewer that you have installed:
your browser ● Microsoft Help Viewer 1.0
● Microsoft Help Viewer 1.1
● H3Viewer (by The Helpware Group)

For more information, see Install the Help Viewer

[page 43].

Open Help In the studio, go to Help SAP If the local Help content is installed, you can access it as
follows:
Cloud Applications Studio Help
● In the studio, go to Help View Help
● In the studio, press F1 to access context-sensitive
F1 Help.
For more information, see Use Context-Sensitive F1
Help [page 46].

Search Help Search in individual documents Use the Help Viewer search function and search the entire
local Help content.
For more information, see View Local Help Content
[page 45].

Update Help The integrated Help content is The local Help content is automatically updated when you
updated automatically when you update your studio build. You can also update it manually by
update your studio build. installing a new version of the local Help content.
For more information, see Installing For more information, see Installing and Updating the SAP
and Updating the SAP Cloud Cloud Applications Studio [page 28] under “Updating Your
Applications Studio [page 28] Studio Installation” and Install Local Help Content Manually
under “Updating Your Studio [page 44].
Installation”.

Remove Help You cannot remove the integrated You can remove the local Help content.
Help content. For more information, see Remove Local Help Content
[page 45].

Working with Local Help Content

Install the Help Viewer

If you want to use the local help content, you need to install a Help Viewer. Please use one of the following options:

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 43
 ● Help Viewer 1.0: Install Microsoft Visual Studio 2010 Shell (Isolated) Redistributable
Package to install Help Viewer 1.0.
● Help Viewer 1.1: This is a standalone Help Viewer that you can install together with Microsoft Visual
Studio 2010 Service Pack 1.
● H3Viewer: This is a third-party tool developed by The Helpware Group.

For more information, see Help Content: Questions and Answers [page 46].

Install Local Help Content Manually

1. Download the Help content files by doing the following:
a. In the Business Center, open the Topics in Detail page.

If you cannot open the Topics in Detail page by clicking the link, you can navigate to the page
by opening the Business Center at https://www.sme.sap.com ; then select SAP Business
ByDesign Solution Information Wiki Info Exchange SAP Solutions OnDemand Studio .
In the Partner/Developer Information section, select Topics in Detail and then
Documentation — SAP Cloud Applications Studio.

b. At the top of the page, click the Documentation — SAP Cloud Applications Studio tab and navigate to the
Installing the Help Content in Microsoft Help Viewer Format section.
c. Click the Download now button for the relevant version, save the .zip file to your local computer, and
extract the two Help files (an .msha file and an .mshc file) from the .zip file.

You can also find the Help content in the SAP Help Portal : Go to Software Development Kits (SDKs),
select your version of the studio and then click the Help Content link.

2. Open the studio as an administrator by doing the following:

a. On your desktop, click the Start button and in the programs list, find the studio version you have installed:
SAP Cloud Applications Studio [version no.].
b. Right-click the program entry and select Properties.
c. In the Properties dialog box, on the Compatibility tab, select Run program as an administrator.

You can also right-click the program entry while holding the SHIFT key.

d. Open the studio.

You do not need to log on to the repository to install the Help.
3. In the studio, install the Help content files by doing the following:
a. In the Help menu, click Manage Help Settings
Help Library Manager (HLM) opens. The first time you launch HLM, you will be prompted to set the
location where local content will be installed. By default, a path is entered in this field. Make sure that it
is a location on your C: drive; otherwise, the Help doesn't work.
b. In Help Library Manager, click the Choose online of local help link and select local help as your help
preference.
c. Click Install content from disk.
d. Navigate to the directory that contains the HelpContentSetup.msha content setup file.
e. Select the HelpContentSetup.msha file and then click OK.

SAP Cloud Applications Studio – Version May 2018 (1805)

44 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 f. Select the content to install by clicking Add next to the content title (for example, SAP Cloud Applications
Studio), and then click Update at the bottom of the screen.
g. When the security alert appears, click Yes to proceed and then click Finish.

View Local Help Content

To access the installed Help from the studio, from the Help menu, click View Help.
● If Microsoft Help Viewer 1.0 is installed on your computer, the documentation opens in your default browser.
● If Microsoft Visual Studio 2010, SP1 is installed on your computer, the documentation opens in Microsoft Help
Viewer 1.1, which is a standalone help viewer.

For more information, see Search for Topics [page 45] and Use Context-Sensitive F1 Help [page 46].

Remove Local Help Content

Before you install a new version of the studio Help content, remove the earlier version by doing the following:
1. In the studio, from the Help menu, click Manage Help Settings.
Help Library Manager (HLM) opens.
2. Click Remove Content.
3. In the Remove Content window, next to the studio entry, click Remove and then click the Remove button.

You can now install the current version of the Help as described under Install Local Help Content Manually
[page 44].

Search for Topics

Depending on which Help Viewer you have installed, you can find content more easily by using the following features:
● Search Function
Searches local content for the query you enter in the text box and presents the results in a list of topics. The
list also displays a short description of the topic content.
Microsoft Help Viewer supports full-text search. You can combine the following Boolean operators: AND, OR,
and NOT. You can also use a wildcard character in searches by specifying an asterisk ( *) in your search terms.
Stop Words
For best search results, avoid using stop words in your search queries. A stop word is a word that occurs
frequently in natural language, such as a or the. If you enter a phrase that contains one or more stop words
in the search text box, the Help Viewer does not display any results in the results list. For example, enter
create report and not create a report in the search text box.
Further examples of common stop words are:
○ Articles — a, an, the
○ Pronouns — you, your, they, their, it, its, ...
○ Prepositions — at, on, in, from, through,...
○ Auxiliary verbs — is, are, be, has, have, done, ...
○ Modal verbs — can, could, may, ...
○ Conjunctions — and, or, but, ...
○ Standard vocabulary for documentation — caution, tip, information, use, see, ...
○ ...
● Sync to ToC Function
Highlights the current topic in the table of contents so that you can explore surrounding content.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 45
Use Context-Sensitive F1 Help
If the Help content is installed locally, you can also access context-sensitive help:

Context-sensitive help is available for ... What you need to do to access context-sensitive help

... wizards, dialog boxes, and tool windows ● In the studio, press F1 when you open a wizard or dialog box or
when you select a tool window.
●
In the studio, click the Help icon ( ) located in the top right of
the user interface element.

... keywords when you create a business object In the code editor, when you define a business object for your solution and
press F1 , an overview document opens (Syntax for Business Object
Definitions [page 174]), which contains a list of functions and keywords
with links to further information.

... keywords when you create a script file In the code editor, place your mouse cursor on a keyword and press F1 .
If documentation is not available for a keyword, an overview document
opens (Syntax for Implementation of Business Logic [page 210]).

View Public Solution Model (PSM) Documentation

In the studio, you can explore SAP content and PSM documentation using the Repository Explorer tool window. For
information, see Repository Explorer [page 50].

Questions and Answers

We have collected questions and answers that may come up when you are using the help content. For more
information, see Help Content: Questions and Answers [page 46].

5.5.3 Help Content: Questions and Answers

We have collected some questions that may come up when you are using the help content. Read the sections below
to get answers to your questions and additional information about using the Help content for the studio.
If you want to know how to manually install and use the Help content, see Using Help Content [page 42].

Frequently Asked Questions

Do I have to install Microsoft Help Viewer?

No. Help Viewer 1.0 is installed when you install the Microsoft Visual Studio 2010 Shell (Isolated) Redistributable
Package. Help Viewer 1.1 ships with Service Pack 1 of Visual Studio 2010.

I cannot complete the installation of Microsoft Visual Studio 2010 Shell (Isolated)
Redistributable Package. What do I do?
Uninstall the unfinished installation and restart your computer. Make sure that you have installed the latest Microsoft
updates and switch off your antivirus software. Reinstall Microsoft Visual Studio 2010 Shell (Isolated) Redistributable
Package, restart your computer, and switch on your antivirus software again.

SAP Cloud Applications Studio – Version May 2018 (1805)

46 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
What is the difference between Microsoft Help Viewer 1.0 and Microsoft Help Viewer 1.1?
● Microsoft Help Viewer 1.0 is installed with the Microsoft Visual Studio 2010 Shell (Isolated) Redistributable
Package and with Microsoft Visual Studio 2010 editions. It displays the documentation in your default
browser. So really, the viewer is your browser, for example, Microsoft Internet Explorer 9.
● Microsoft Help Viewer 1.1 ships with Service Pack 1 of Visual Studio 2010. Microsoft Help Viewer 1.1 is a
standalone Help Viewer. If Microsoft Help Viewer 1.0 is installed on your computer and you then install
Microsoft Visual Studio 2010, SP 1, Microsoft Help Viewer 1.0 is removed from your computer.

I have installed Microsoft Visual Studio 2010, SP1, but I still see Help Viewer 1.0, not 1.1. Which
version do I have?

To see which Help Viewer version is installed, open Control Panel Programs Programs and Features .
You will find an entry for either Microsoft Help Viewer 1.0 or Microsoft Help Viewer 1.1.
The Help Library Manager that you open from the Help menu → Manage Help Settings is a component of the Help
Viewer. In Microsoft Visual Studio 2010, SP1, Help Viewer 1.1 is still shipped with Help Library Manager 1.0. The title
bar of the Help Library Manager dialog box therefore displays Help Library Manager — Microsoft Help Viewer 1.0 even
when Help Viewer 1.1 is installed.

What is H3Viewer?
H3Viewer is a third-party tool developed by The Helpware Group that you can install and use instead of the Microsoft
Help Viewer. The advantage of using H3Viewer is that it displays the full table of contents (TOC), whereas Microsoft
Help Viewer 1.0 doesn't display the TOC. If you install H3Viewer, you can still use Microsoft Help Viewer.

Is the documentation installed with the studio?

Yes. If this doesn't work for some technical reason, install the Help content manually on your local computer by
following the instructions in Using Help Content [page 42] under “Install Local Help Content Manually”.

I don't have administrator privileges, so how can I install the Help content?
You need to run the studio as an administrator to install Help content on your local computer.
If the message The content publisher cannot be verified. Installing this content requires administrator privileges. is
displayed, please do the following:
1. On your desktop, click the Start button and in the programs list, find SAP Cloud Applications Studio [x.x].
2. Right-click the program entry and select Properties.
3. In the Properties dialog box, on the Compatibility tab, select Run program as an administrator.

You can also right-click the program entry while holding the SHIFT key.

4. Open the studio.

You do not need to log on to the repository to install the Help.

You can now install the Help content manually on your local computer by following the instructions in Using Help
Content [page 42] under “Install Local Help Content Manually”.

Is the Help content removed when I install a new build?

No. When you uninstall and install a build of the studio, any Help content you previously installed is still available.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 47
Is this format of the documentation updated automatically?
Yes, it is updated automatically when you update your studio. However, if that doesn't work for some technical
reason, you need to install the Help content manually on your local computer by following the instructions in Using
Help Content [page 42] under “Install Local Help Content Manually”.

Why is the message “No content was found on your computer.” displayed?
Please check whether the studio Help content is installed. If no studio Help content is installed, you need to install
the Help content manually on your local computer by following the instructions in Using Help Content [page 42]
under “Install Local Help Content Manually”.
If you have already installed the Help content and tried to open the Help by pressing F1 , please report this issue
and describe exactly what you did before the message appeared. For information about reporting problems, please
see Report an Incident [page 565].

When I try to view the studio Help, why does the MSDN Library open in my browser and display
the message “Page Not Found”?
Please do the following:
1. In the studio, from the Help menu, click Manage Help Settings.
Help Library Manager (HLM) opens. The first time you launch HLM, you will be prompted to set the location
where local content will be installed. By default, a path is entered in this field. You should not need to change
the path. However, make sure that it is a location on your C: drive.
2. In Help Library Manager, click the Choose online of local help link, select I want to use local help, and then
OK.
3. If the Help content hasn't been installed automatically, you need to do this manually by following the
instructions in Using Help Content [page 42] under “Install Local Help Content Manually”.

When I try to view the studio Help, why is the Visual Studio documentation displayed in my
browser?
If the Help content hasn't been installed automatically, you need to do this manually by following the instructions in
Using Help Content [page 42] under “Install Local Help Content Manually”.

How can I change the library location?

The first time you launch Help Library Manager (HLM), you will be prompted to set the location where local content
will be installed. By default, a path is entered in this field. You can only change this path later by reinstalling the Help
Viewer.

How can I reinstall the Help Viewer?

To reinstall the Help Viewer, we recommend that you do the following:
1. Uninstall the studio.
2. Uninstall one of the following:
● Microsoft Help Viewer 1.0
Microsoft Visual Studio 2010 Shell (Isolated) Redistributable Package.
● Microsoft Help Viewer 1.1
Microsoft Visual Studio 2010 Service Pack 1.
3. Look in the Control Panel Programs Programs and Features list and, if you still see an entry for
Microsoft Help Viewer [x.x], uninstall Microsoft Help Viewer [x.x] .

SAP Cloud Applications Studio – Version May 2018 (1805)

48 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 4. Reinstall one of the following and make sure that you select the Microsoft Help Viewer [x.x] component for
installation.
● Microsoft Help Viewer 1.0
Microsoft Visual Studio 2010 Shell (Isolated) Redistributable Package.
● Microsoft Help Viewer 1.1
Microsoft Visual Studio 2010 Service Pack 1.
5. Open the studio as an administrator and install the latest Help content as described in Using Help Content
[page 42] under “Install Local Help Content Manually”.
You can either leave the default path for the library location (recommended) or specify another path.

Why isn't the studio Help displayed in the contents even though I can access studio Help topics
by clicking F1 and from the Help menu?
You probably installed the Help content while the Help Viewer was open. Try closing and reopening the Help Viewer.

The layout of the studio Help topics looks strange in the Help Viewer. What can I do?
Try reinstalling the Help Viewer and make sure that you do not change the default path for the library location.

Why doesn't the context-sensitive help (F1) work?

To view context-sensitive help, the Help content must be installed locally on your local computer. If his hasn't
happened automatically when you installed the studio, follow the instructions in Using Help Content [page 42] under
“Install Local Help Content Manually”. Also make sure that you have the most current version of the Help content.

Why doesn't the search find the topic I'm looking for even though I know that documentation
exists?
Avoid using stop words in your search queries. A stop word is a word that occurs frequently in natural language, such
as a or the. If you enter a phrase that contains one or more stop words in the search text box, the Help Viewer doesn't
display any results in the results list.
For example, enter create report and not create a report in the search text box.

The stop word files for Microsoft Help Viewer 1.0 and 1.1 are stored on your local computer in c:\program
files\Microsoft Help Viewer\v1.0\ folder. Depending on which Help Viewer you have installed, the
location may differ.

If you still cannot find the topic you are looking for, try using the following Boolean operators: AND, OR, and NOT.
For more information, see Using Help Content [page 42] under “Search for Topics”.

5.5.4 My Solutions

The My Solutions tool window provides functions that allow you to create solutions and to access the repository. You
must log on to a repository system to create and edit solutions in the studio.

Features
When you open the studio, you first log on to the repository. By default, the My Solutions tool window is displayed
on the left of the developer desktop. You can also open the My Solutions window in the View menu.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 49
The My Solutions window shows all solutions that are available in the repository. The solutions are displayed as
follows: [Solution Type] [Solution Description] (Technical Name), for example: CarParkSolution (YQE1PZ2IY) or
BCTest (YA2F975KJ).
You can access the following functions from the My Solutions tool window:
● Log On
For information about logging on to the repository, see Log on to the Repository [page 18].
● Create Solution
For more information about creating solutions, see the following documents:
○ Create a Customer-Specific Solution [page 165]
○ Create a Solution Template [page 164]
● Refresh
● Search
You can search solutions by entering the name of the solution in the search field. If you do not know the exact
name of an solution, you can just enter your search term and press Enter . The search is not case-sensitive.
The first solution containing the search term is displayed at the top of the list. To get to the next hit, press
Enter .
● Log Off
● Delete Solution
To delete a solution, right-click the solution and select Delete Solution.
● Open Solution
To open a solution, right-click the solution and select Open Solution. You can also open a solution by double-
clicking it.
● Solution Properties
If you want to display the solution properties, in the My Solutions window, right-click the solution and select
Solution Properties. In the Solution Properties window, you can also add or change the contact information.

You can also access some of these functions from the Administration menu.

See Also
Solution Explorer [page 55]

5.5.5 Repository Explorer

The Repository Explorer tool window displays SAP content that is released with the public solution model (PSM)
such as business objects, data types, enhancement options, inbound service interfaces, and reuse UIs. You can
explore the content to gain an understanding of the repository structure and the business context and use of SAP
content, which you can reuse and enhance in your solution.

Prerequisites
To display SAP content in the Repository Explorer, you must log on to the repository. For information, see Log on to
the Repository [page 18].

SAP Cloud Applications Studio – Version May 2018 (1805)

50 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
Features
You can open the Repository Explorer tool window in the View menu by clicking Repository Explorer. You can dock
the tool window on the edge of the developer desktop or as a tabbed document. For best readability, we recommend
that you dock the Repository Explorer as a tabbed document.
The Repository Explorer displays different content types on separate tabs. The window is split into two panes: a tree
view of the entities and a documentation pane. You can view the documentation for an entity by clicking the entity
in the tree view. You can position the documentation pane at the bottom by clicking the Horizontal button or on the
right by clicking the Vertical button.

Business Objects Tab

On the Business Objects tab, you can explore all SAP business objects that are released with the public solution
model (PSM) by doing the following:
● Explore the repository — When you open the Repository Explorer, the tree view displays all SAP business
objects. You can expand the tree view to display the business objects nodes, the node elements, and the
relationship between business object nodes, which is called an association. You can also show and hide
entities in the business object model by using the following buttons:
○ Actions
○ Associations
○ Nodes
○ Queries
You can execute the query by selecting Execute Query in the context menu of the query. For more
information, see Execute a Query [page 53].
● Search business objects — You can search for an SAP business object by entering the name of the business
object in the search field. You can also filter the search results by namespace and/or deployment unit.

If the system cannot find any entities that match your search term, you can try the following:
● Click the Clear Search button ( ) to search in all namespaces and development units (for
business objects) or usage categories (for data types).
● Enter a different spelling or search term.

● View information — You can hover over an entity in the tree view to display information about the entity such
as the object category or the subelement type. The information also indicates whether write access is allowed
for an entity and whether the entity is deprecated.
● View documentation — You can click a business object and its elements to display comprehensive
documentation in the documentation pane. On the Description tab, you see the business object (element)
documentation; the data type information is displayed on the Data Type tab of the documentation pane and
is also accessible via the Data Types tab as described below.

Data Types Tab

On the Data Types tab, you can explore all SAP data types that are released with the public solution model (PSM) by
doing the following:
● Search data types — You can search for an SAP data type by entering the name of the data type in the search
field. You can also filter the search results by namespace and/or usage category, for example, Action, Key,
or Message.
● View information and documentation — You can hover over an entity in the tree view to display information
about the entity such as the namespace. The information also indicates whether you can extend a data type

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 51
 and the usage category of the data type. The usage category describes in which context a data type can be
used. For more information, see the following table.

Examples of Usage Categories for Data Types

Usage Category Description

Action Can only be used to define the parameter structure of an action.

Code Data Type Context Can only be used as context structure of a code data type.

Core A core data type according to CCTS that has unrestricted usage.

Enhancement Option Can only be used in enhancement implementations.

Filter Can only be used to define the filter structure of associations.

Key Can be used as key in business object node structures, but not in messages.

Message Can only be used to type messages

Message Intermediate Can only be used in message types, but only at intermediate levels and not for the message type
itself.

Message Unrestricted Can be used in messages but not in business objects.

Unrestricted Can be used in all data type elements.

Enhancement Options Tab

On the Enhancement Options tab, you can explore all SAP enhancement options that are released with the public
solution model (PSM) by doing the following:
● Search enhancement options — You can search for an SAP enhancement option by entering the name of the
enhancement option in the search field. You can also filter the search results by namespace.
● View information and documentation — You can hover over an entity in the tree view to display information
about the entity such as the namespace. The information also indicates the usage type of the enhancement
option (single use or multiple use) and the related business object.
The documentation of the enhancement options describes how you can use an enhancement option, when
the enhancement option is called, and what it does. Furthermore, it gives information about the business
configuration content you need to develop for an enhancement implementation, the scoping requirements
in the customer system, as well as information about the filters, the input parameters and output parameters,
and testing activities.

Inbound Service Interfaces Tab

On the Inbound Service Interfaces tab, you can explore all SAP inbound service interfaces and service operation that
are released with the public solution model (PSM) by doing the following:
● Search inbound service interfaces — You can search for an SAP inbound service interface by entering the
name of the inbound service interface in the search field. You can expand the tree view to display the service
operations. You can also filter the search results by namespace.
● View information and documentation — You can hover over an entity in the tree view to display information
about the entity such as the namespace.

Reuse UIs Tab

On the Reuse UIs tab, you can explore the SAP reuse UIs that are released with the public solution model (PSM). The
reuse UIs are grouped by UI type:
● Embedded Component

SAP Cloud Applications Studio – Version May 2018 (1805)

52 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 ● Modal Dialog
● Object Instance Floorplan
● Object Value Selector
● Quick Activity Floorplan

You can do the following:

● Search reuse UIs — You can search for a reuse UI by entering a case-sensitive search term in the Search field.
● View information — You can click a reuse UI to display the UI Type and Repository Path.
● Navigate to UI designer — You can open the reuse UI by right-clicking the UI and selecting Open in UI
Designer.

See Also
About the Public Solution Model (PSM) [page 75]
Look Up the Representation Term of a Data Type [page 91]

5.5.6 Execute a Query to Explore a Business Object

The studio enables you to execute queries for SAP business objects and custom business objects to help you better
understand the business object data model.
For custom business objects, you can execute the QueryByElements query, which is generated automatically, and
complex custom queries. For more information, see Create a Query [page 363]
The following table shows you where to access the function:

SAP Business Object Custom Business Object

Repository Explorer Solution Explorer

You cannot execute a query on a customer's production tenant.

Procedure
1. To execute a query for SAP business objects, proceed as follows:
a. In the studio, select View Repository Explorer.
b. Select the Business Objects tab and make sure that the Queries button is selected.
c. Select a business object (or search one using the Search field) and expand the tree view.
d. Select a query ( ), right-click it, and select Execute Query.
The Query Parameter Selection window opens.

To execute a query for custom business objects, proceed as follows:

In the studio, in the Solution Explorer, right-click a business object or a query and select Execute Query. The
Query Parameter Selection window opens.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 53
 If your business object contains various queries, choose the query that you want to execute in the
Select Query window.

2. Optional: In the Query Parameter Selection window, you can do the following:
● Add or Remove parameters
● Paste Values from Clipboard into the Lower Boundary field
● Define the Maximum Number of Records
● Calculate the Available Number of Records for Selection
3. To define the selection parameters, do the following:
a. Click the Parameter field to select a parameter.
b. To exclude records from the results, click the Include/Exclude field and select Exclude. The default
value is Include.
c. Click the Option field to select one of the following selection options: Equal to, Between, Contains
Pattern, Less Than, Less Than or Equal to, Greater Than, Greater Than or Equal to.
d. Enter a Lower Boundary Value and an Upper Boundary Value, if required.
4. Click OK to execute the query.

Result
The results list is displayed in the documentation pane. You can use the following options:
● Navigate by Association
Explore the query results by following the associations of the business object. Please note that this is not
possible, if the debugger is active.
● Reopen Search
Click this button to reopen the Query Parameter Selection and adjust the selection parameters.
● Single-Record View
Select a record and press the button to display the record in the Single-Record View window.
● Search window
Search for a string or term in the query results.
● Output Formatting Active
Toggle between the technical view and the user view. If you select Output Formatting Active, the user view is
displayed.
● Generate Code
Click this button to generate the .absl code that executes the query with the selection parameters used.
You can then copy this code into a new or existing .absl file. In case there is already coding in your .absl
file, there may be conflicts due to duplicate imports or variables, which you need to resolve.

If you cannot see all the buttons, click the down arrow on the right or enlarge the query results window.

SAP Cloud Applications Studio – Version May 2018 (1805)

54 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
5.5.7 Solution Explorer

The Solution Explorer tool window displays a solution and the project items created for this solution, for example, a
business object or a screen. In the Solution Explorer, you can open items for editing and add new items to a solution.
You can also search for files within a solution.
When you double-click a solution in the My Solutions tool window, the solution opens in the Solution Explorer. By
default, the Solution Explorer tool window is displayed on the right of the developer desktop. You can also open the
Solution Explorer in the View menu by clicking Solution Explorer.
In the Solution Explorer window, the solution is displayed with its description (= the name you have given your
solution) and the status information (for example, In Development). Below the solution, you can see all the items
and item objects of the solution.
At the top of the Solution Explorer window, you can: view the properties of your solution and items, add a new item,
refresh your solution, search for specific files within the solution, create correction and close correction during a
production bug fix. The following table describes the icons that are available in the toolbar.

View the properties of the solution and items Refresh the solution

Add a new item to the solution Search for files in the solution

Create a correction during production bug fix Close a correction during production bug fix

The Solution Explorer uses icons in front of the items and item objects to display status information. Depending on
the status, the icons used for items and objects change. For example, added to an item or object means "checked
out by me" and means that the item has no up-to-date runtime objects. As an example, the following table shows
the icons used for business objects:

Runtime objects of business object are up-to- Business object has been checked out by me
date

Runtime objects of business object are not up-to- Business object has been checked out by another
date user

The activation status of the runtime objects of an solution is displayed in the Properties window. For more information,
see Properties Window [page 66].

Project
The project node displays the name of the project and the status of the solution, for example, In Development. When
you create a solution for the first time, the status of the solution is In Development and you can use all available
functions. When the status of the solution changes, for example, to Assembled, you can view the solution, but you

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 55
cannot make any changes. For more information about the life cycle of a solution, see Lifecycle Management of
Customer-Specific Solutions [page 138].
You can create folders to structure the items according to your preferences. Currently, items cannot be moved
between folders in the Solution Explorer.

Generic Actions
Depending on the status of your solution, you can perform various actions for an item or the solution by right-clicking
a node or item. Actions that you cannot choose for the solution or item you have selected are grayed out. Here is an
overview of the actions that are available in the Solution Explorer:
● Activate
You can activate an item or solution to generate the runtime objects that are required for an item or the
solution to function. You must activate any new or modified items before you can test them in the SAP cloud
solution.
○ To activate all items of your solution, select Activate All Items .
○ To activate only the new or modified items, select Activate New and Changed Items . This option
speeds up the activation process.
○ To determine if an item has been activated, in the Solution Explorer, select the item. The activation status
is displayed in the Properties.

For more information on the activation of business objects, see Activate a Business Object [page 362].
● Check
You can use the following check functions:
○ For a selected item of the solution:
Right-click the element and select Check.
○ For all items of the solution:
Right-click the project node and select Check Items .
○ For all items and runtime objects of the solution:
Right-click the project node and select Check Items and Runtime Objects . This option checks the
consistency of the design-time files and of the generated runtime objects.
○ For running consistency check in background mode:
1. Right-click the project node and select Check Enable Background Mode .
2. Click on Check Items or Check Items and Runtime Objects to trigger the background
job. When the mode is triggered, you can continue to work on other solutions, and avoid the timeout
errors for large solutions.
3. Click on Check Display Logs to see the results of your check. The system shows the results
in a pop-up window confirming if the consistency check is successful or not.
Click on Check Disable Background Mode to switch to the earlier context menu option that
runs the check in fore-ground mode.
● Check In/Check Out/Check In All Files/Revert
Items that you have checked out (for example, when changing them) are locked by you and other users cannot
edit these items. A red check mark identifies items that you have checked out. When you have finished editing
an item, you can check it in to make it available for other users to edit. You can also check in all items at the
same time by right-clicking the solution and selecting Check In All Files. Items checked out by other users are
identified by a blue user icon. The Properties window displays the user that has checked out the items.
The .absl file that you have changed during production bug fix can be reverted to its previous checked in and
activated version when you use the Revert action.
● Add

SAP Cloud Applications Studio – Version May 2018 (1805)

56 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 You can access the following functions via the Add option:
○ Add New Item
Opens the Add New Item dialog box that displays the installed item templates that SAP provides for
solution development. For more information about the items you can add to your solution, see Add New
Item Dialog Box [page 58].

You can also open the Add New Item dialog box by clicking the button at the top of the Solution
Explorer tool window.

○ Add Existing Item

To document your solution, you can add file types such as doc, ppt, xls, pdf, txt, and xlf to your
solution. In addition, you can copy files from other solutions to your solution, for example,
a .uicomponent file.
○ Add New Folder
To organize the files of your solution, you can add folders and subfolders to your solution.
● Clean
You can use the clean function to delete any runtime objects that have been created for an item or the solution.
The system creates theses runtime objects when you activate an item or the solution. When you clean an
item, the associated test data such as business object instances are deleted.
● Delete
You can use the delete function to delete an item and its corresponding runtime objects.
● Translation
You can translate language-dependent item texts such as on-screen texts and business configuration content
into one of the languages supported by the SAP cloud solution. Access the translation submenu by right-
clicking the project node or one of the items and selecting Translation and then one of the following
options :
○ Export Text
Export translatable text strings in XML Localization Interchange File Format (XLIFF).
○ Import Text
Import a translated XLIFF file.
○ Check Status
Check the completeness of the translation.

For more information, see Translation Quick Guide [page 584].

Bug Fixing in Pre-production and Production Tenants

You can make changes to .absl files directly in the pre-production and production tenant to fix any bugs.
In general, if you want to make any code changes to a productive add-on, the recommended way is to create a patch
in the test/development tenant where the add-on was originally developed. The patch is then uploaded to the
production system only after thorough testing in the source tenant. With this feature, you can make the code changes
directly in the production and pre-production system.
For more information, see Bug Fix in Production and Pre-production Tenants [page 169].

See Also
Working in the Integrated Development Environment [page 37]

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 57
5.5.8 Add New Item Dialog Box

Overview
The Add New Item dialog box displays the installed item templates that SAP provides for solution development. You
can add items such as business objects, different user interface (UI) components, and Web services to your solution.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Adding New Project Items

To add an item to your solution:
● In the Solution Explorer, right-click the project and select Add New Item .

You can also open the Add New Item dialog box by clicking the button at the top of the Solution
Explorer tool window.

The Add New Item dialog box opens. By default, all items are displayed in the center pane in alphabetical
order.
You can also display items by category by selecting one of the categories from the list in the Installed
Templates pane under SAP:
○ Analytics
○ Business Configuration
○ Data Protection and Privacy
○ Extension
○ Mashups and Web Services
○ Screens
○ Service Integration

When you select an item, a brief description of the item appears in the right pane. You can add the following
items.

SAP Cloud Applications Studio – Version May 2018 (1805)

58 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
Installed Item Templates — General Items

File
Installed Template Icon Extension Description How To...

Business Object .bo You can create a business object definition that ... Create a Business
specifies the structure and organization of the Object [page 346]
business object. On the basis of your business
object definition, you can then implement the
business logic and generate screens.

Code List Data Type .codeli Code list data types can, for example, be used in ...Create a Code List
st business objects or business object extensions. Data Type [page 406]
You can define configurable code list data types
via business configuration objects and business
configuration sets.

Form .xdp You can create a print form for a business object. ... Create a Print Form
Print forms are read-only portable document [page 438]
format (PDF) documents that are generated
from data stored in the business object. You can
define the data that you want to include in the
form and design the layout.

Mass Data Run .run A run that specifies the automatic mass ...Create a Mass Data
processing of a business object action. It contains Run [page 467]
the selection criteria and the processing results.

Query .qry You can create a query that contains search ... Create a Query
parameters and fields from different business [page 363]
object nodes. You can then create an object work
list (OWL) that uses your query data in search and
information retrieval operations.

Reuse Library .librar You can create a reuse library and define its ...Reuse Library Quick
y functions to organize the code in your solution or Guide [page 403]
to reuse code in several script files.

Tax Decision Tree .bcctax You can create a tax decision tree for a country. ...Create a Tax Decision
Based on this decision tree, the system Tree [page 341]
determines the tax event for this country when
you create an invoicing document, such as a
customer or supplier invoice.

Installed Item Templates — Analytics

File
Installed Template Icon Extension Description How To...

Analytical Report .report You can create a report based on an SAP data ... Create a Report
source or based on a custom data source you [page 460]
have created.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 59
 File
Installed Template Icon Extension Description How To...

Combined Data Source .cds A combined data source combines data from two ... Create a Combined
or more data sources that share common or Data Source
similar characteristics. [page 457]

Data Source .ds You can create a data source that includes key ... Create a Data Source
figures and characteristics and transformation [page 455]
and aggregation rules. You can also reference
other data sources. You can then create a report
that uses your data source. To join or combine
data from different data sources, you can create
joined and combined data sources using the
administrator tool for Analytics.

Joined Data Source .jds A joined data source joins data from two or more ... Create a Joined Data
data sources that share common characteristics. Source [page 448]

Key Figure .kf You can create a calculated or restricted key ...Create a Key Figure
figure based on an SAP data source or based on [page 462]
a custom data source you have created. You can
use the key figure in a report. A calculated key
figure is determined using calculation rules or
formulas. A restricted key figure is restricted to a
specified characteristic value.

Installed Item Templates — Business Configuration

File
Installed Template Icon Extension Description How To...

BAC Elements .bac You can create business options, business ... Create a Business
topics, and country options. Option [page 324]
... Create a Business
Topic and Business
Options [page 326]
... Create a Country and
Business Options
[page 329]

Business Configuration .bco You can create a business configuration object ... Create a Business
Object (BCO) as the basis of a business configuration set Configuration Object
(BC set). [page 334]

Business Configuration .bcc You can create a business configuration set (BC ... Create a BC Set
Set set) based on a business configuration object Using an SAP BCO
(BCO). You can then assign your BC set to a [page 332]
business option using the Business Configuration ... Create a BC Set
Wizard. Using a Custom BCO
[page 336]

SAP Cloud Applications Studio – Version May 2018 (1805)

60 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 File
Installed Template Icon Extension Description How To...

Business Configuration QA.uico You can create a business configuration view (BC ... Create a Business
View mponent view) for a business configuration set (BC set) to Configuration View
allow administrators to change the values defined [page 337]
in the BC set during fine-tuning. You model the
view using the UI designer.

Implementation Project .bct Fine-tuning project templates provide sample ... Create a Fine-Tuning
Template content for a specific scenario that is defined by Project Template
SAP. The fine-tuning activities you need to [page 340]
complete for the template are explicitly listed.

Installed Item Templates — Data Protection and Privacy

File
Installed Template Icon Extension Description How To...

Personal Data .pdd You can enable disclosure of personal data stored ... Enable Data
Disclosure in custom BOs. The data protection officer can Disclosure [page 410]
access the data in the Data Protection and
Privacy work center.

Sensitive Personal Data .psd You can define data protection and privacy level ... Enable Read Access
of personal data. The fields defined as sensitive Logging [page 416]
personal data will be enabled for read access ... Enable Personal Data
logging. The fields defined as personal data will for Extension Fields
be enabled for destruction during the data [page 418]
removal process.

Installed Item Templates — Extension

File
Installed Template Icon Extension Description How To...

Business Object .xbo You can create business object extensions to ... Create a Business
Extension enhance SAP business objects by adding Object Extension
extension fields to them. You can then add the [page 381]
extension fields to forms, screens, reports, and
search categories. You can also use the extension
fields in script files.

Embedded Component EC.uico An embedded component is a reusable user ... Model an Embedded
mponent interface component that you can add to other Component
floorplans. The parent floorplan influences the [page 618]
behavior of the embedded component. You can
model this component in the UI designer.

Enhancement .enht You can create an enhancement of an SAP ...Create an

Implementation enhancement option to allow customers to apply Enhancement
business rules that meet specific requirements, Implementation
for example, country-specific requirements, [page 401]
without modifying the standard SAP's cloud
solution. An enhancement implementation
consists of a message definition, a filter, and a
script file.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 61
 File
Installed Template Icon Extension Description How To...

Process Extension .xs You can create a process extension scenario to ... Create a Process
Scenario link business contexts to other related business Extension Scenario
contexts. You can then use the Scenario [page 397]
annotation to specify that an extension field is
available for all the business contexts in the
scenario.

References to .ref You can select the customer-specific fields that ... Create References to
Customer-Specific you want to use in script files. Customer-Specific
Fields Fields [page 391]

Installed Item Templates — Mashups and Web Services

File
Installed Template Icon Extension Description How To...

Data Mashup .MC.uim You can create a mashup that combines and ... Create a Data
ashup displays data from both internal and external Mashup [page 494]
sources. You can then use the Data Mashup
Builder in SAP's cloud solution to transform or
merge external Web services with internal
business data using industry-standard Web
service protocols.

HTML Mashup .MC.uim You can create a mashup that embeds HTML or ... Create an HTML
ashup JavaScript code in a screen. Mashup [page 497]

Mashup Port Binding PB.uima Create a port binding to add a mashup to your ... Create a Port Binding
shup floorplan. for a Mashup
[page 491]

REST Mashup Web .WS.uim You can create a Web service based on the REST ... Create a Mashup
Service ashup architectural style. For REST Web services, you Web Service
need to know the request URL and any relevant [page 501]
query parameters. You define the REST Web
service using the administrator tools for mashup
and Web service authoring. To integrate the Web
service in a screen, you must add the Web service
to a data mashup.

RSS/Atom Mashup .WS.uim You can create a Web service based on RSS or ... Create a Mashup
Web Service ashup Atom feeds. For RSS or Atom feeds, you need to Web Service
know the end-point URL of the Web service or the [page 501]
WDSL location. You define the RSS/Atom Web
service using the administrator tools for mashup
authoring and Web service authoring. To
integrate the Web service in a screen, you must
add the Web service to a data mashup.

SAP Cloud Applications Studio – Version May 2018 (1805)

62 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 File
Installed Template Icon Extension Description How To...

SOAP Mashup Web .WS.uim You can create a Web service based on SOAP. For ... Create a Mashup
Service ashup SOAP Web services, you need to know the WSDL Web Service
location (URL). You define the SOAP Web service [page 501]
using the administrator tools for mashup
authoring and Web service authoring. To
integrate the Web service in a screen, you must
add the Web service to a data mashup.

URL Mashup .MC.uim You can create a mashup that sends data from ... Create a URL Mashup
ashup SAP's cloud solution to the URL of an online [page 492]
service provider. The service provider uses the
data, for example, to perform a search, and the
results are displayed in a new browser window.

Installed Item Templates — Screens

File
Installed Template Icon Extension Description How To...

Fact Sheet (FS) FS.uico An FS is a one-page read-only overview of an ... Model a Fact Sheet
mponent object. It displays the object properties, can have [page 601]
different views, and can contain links for
navigating to related objects. You can model this
overview in the UI designer.

Guided Activity GAF.uic A GAF is a floorplan for an activity that can be ... Model a Guided
Floorplan (GAF) omponen divided into a logical sequence of steps. It Activity Floorplan
t consists of a series of screens that guide the user [page 610]
through an activity to complete a specific task.
You can model this floorplan in the UI designer.

Modal Dialog (MD) MD.uico An MD is a small movable and resizable window ... Model a Modal Dialog
mponent that helps users perform a simple task. You can [page 616]
model this dialog in the UI designer.

Object Instance OIF.uic An OIF allows users to create, delete, view, and ... Model an Object
Floorplan (OIF) omponen edit a business object such as an employee, a Instance Floorplan
t purchase order, or a supplier's record. You can [page 605]
model this floorplan in the UI designer.

Object Value Selector OVS.uic An OVS supports users in selecting values for an ... Create an Object
(OVS) omponen input field. An OVS is most commonly called from Value Selector Dialog
t an input field. You can configure an OVS Box [page 608]
component in the UI designer. You can also
configure an OVS Control (an input field with a
value selection helper) in the UI designer and
consume the OVS component.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 63
 File
Installed Template Icon Extension Description How To...

Object Work List (OWL) OWL.uic An OWL is a list pane that contains business ... Model an Object
omponen objects such as purchase orders or Work List [page 607]
t opportunities. Users can perform tasks on
objects and trigger follow-on processes. You can
embed an OWL in a view. You can model this list
in the UI designer.

Port Type Package PTP.uic A PTP hosts one or more port types. A port type ... Create a Port Type
(PTP) omponen is a blueprint for an inport or an outport. You can Package [page 615]
t create a PTP to facilitate navigation between
components that have inports and outports
within the same PTP without any mapping. You
can configure these components in the UI
designer.

Quick Activity Floorplan QA.QA.u A QAF allows users to quickly perform a self- ... Model a Quick
(QAF) icompon contained or short subtask of a larger task, for Activity Floorplan
ent example, create a bidder within the creation of a [page 603]
request for quotation. A QAF is a simple task-
specific alternative to an OIF. You can model this
floorplan in the UI designer.

Quick Create Floorplan QC.uico A QC allows casual users to quickly create, delete, ... Generate Screens for
(QC, not available for mponent view, and edit a business object record, such as a Business Object
SAP Business an account or an opportunity. A QC is a slide-in [page 370]
ByDesign) window, that allows users to edit the record
without navigating away from the UI they are
currently seeing. UIs that are created with QCs
are intended to be used on tablets and on PCs.

Quick View Floorplan QV.uico A QV is a preview on a thing. A thing is the ... Generate Screens for
(QV, not available for mponent representation of one or several entities in the a Business Object
SAP Business system and is intended to match the data record [page 370]
ByDesign) currently displayed on the UI. The QV combines
several pieces of detailed information on a thing
without navigating away from the UI that the user
currently sees. Data displayed in a QV cannot be
edited. QVs are intended to be used on tablets
and PCs.

Thing Inspector TI.uico A TI allows the user to get a complete view of a ... Generate Screens for
Floorplan (TI, not mponent thing. The TI shows all aspects of a thing and is a a Business Object
available for SAP compact summary of all primary attributes, the [page 370]
Business ByDesign) tags, and the actions that can be carried out. TIs
are intended to be used on tablets and PCs.

Thing Type Floorplan TT.uida A TT describes the general UI properties of a ... Generate Screens for
(not available for SAP taobjec thing, such as its name and various icons on the a Business Object
Business ByDesign) t UI, its binding against a business object, and its [page 370]
key. It is used for navigating between the screens
that are thing-based and for the provisioning of
REST services for a thing.

SAP Cloud Applications Studio – Version May 2018 (1805)

64 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 File
Installed Template Icon Extension Description How To...

UI Switch .uiswit A UI switch is used to control role-specific ... UI Switches

ch changes of SAP UIs. In the UI designer, you can [page 655]
use the switch to restrict the visibility of SAP UI
changes. Only those user roles that have the UI
switch assigned in the SAP solution can see the
respective UI changes.

Work Center (WoC) .uiwoc A WoC groups task-specific activities such as ... Model a Work Center
managing purchase orders or planning and [page 614]
budgeting. Each WoC has multiple views. You can
model a WoC in the UI designer.

Work Center View .uiwocv A view contains information or tasks related to a ... Model a Work Center
iew specific topic. Views can contain a worklist and View [page 612]
can link to other activity floorplans such as QAFs
or GAFs. Views must be assigned to a WoC. You
can model views in the UI designer.

Installed Item Templates — Service Integration

File
Installed Template Icon Extension Description How To...

Communication .csd You can select a set of inbound and outbound ... Define a
Scenario services that allows customers to create Communication
communication arrangements in SAP's cloud Scenario [page 557]
solution to exchange business documents
electronically.

External Web Service .wsid You can create an external Web service ... Integrate an External
Integration integration of type SOAP or REST. You can then Web Service Using
address the Web service in your business logic to SOAP [page 551]
enable access from the SAP cloud solution to a ... Integrate an External
remote application. Web Service Using
REST [page 552]

Internal .pid You can create a service integration definition to ... Configure Internal
Communication exchange data between two business objects Communication
that are located in different deployment units. [page 523]
The definition contains the configuration for
asynchronous communication between the
business objects.

Web Service .webser You can create a Web service based on a business ... Create a Web Service
vice object. Web services enable remote access to the [page 545]
business object data using SOAP-based
communication.

XML File Input .pid You can create an XML schema definition that ... Create XML File Input
allows customers to create an XML file, which can [page 524]
then be used to import third-party data from
other systems into SAP's cloud solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 65
5.5.9 Properties Window

Overview
The Properties window displays information about the item in your solution that is currently selected in the Solution
Explorer. When you select the solution, you can view solution properties such as the solution status. When you select
an item such as a business object or a UI component, you can view item properties such as the activation status of
runtime objects.

Features
You can access the Properties window in the View menu by clicking Properties Window or by pressing F4 . You
can view the following solution properties or item properties by selecting the solution project node or an item in the
Solution Explorer.

Solution Properties

Property Description

Advanced

Project File Name of the project file: [solution name].myproject

Project Folder Path of the project file in the repository

General

Compiler Version Version of the scripting language compiler that is used to check or activate the solution. This field
typically contains two numbers separated by a slash, for example, 1302 / 1211. The first number
indicates the compiler version of the .absl files. The number after the slash indicates the compiler
version of the.bo and .xbo files.

Created By User who created the project

Created On Date and time when the project was created

Deployment Unit Name of the default deployment unit of the solution

Description Description of the solution defined when the solution was initially created

Last Changed By User who last changed the project

Last Changed On Date and time when the project was last changed, that is, when an item was last added to or deleted
from the solution

Name Name of the solution generated automatically by the studio

Namespace Container used to group all items in the solution

SAP Cloud Applications Studio – Version May 2018 (1805)

66 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 Property Description

Status Lifecycle status of the solution

For customer-specific solutions, this property can have one of the following values:
● In Development
● Assembled
● Disabled
● In Deployment
● Deployed

For information about lifecycle management, see:

● Lifecycle Management of Customer-Specific Solutions [page 138]

Type Type of the solution defined when the solution was initially created; this property characterizes the
focus and content of a solution.
For a customer-specific solution, this property can have one of the following values:
● Customer-Specific Solution
For information, see Create a Solution [page 165].
● Solution Template
For information, see Create a Solution Template [page 164].

Item Properties

Property Description

Advanced

Local Path Full path of the project item on the client computer

Repository Path Path of the project item in the repository

General

Business Object Type Code representation of the type of the business object in the repository
Code
(for business objects
only)

Checked Out By User who has currently checked out the project item

Check Out On Date and time when the project item was checked out

Created By User who created the project item

Created On Date and time when the project item was created

File Name The name of the file or folder

Last Changed By User who last changed the project item

Last Changed On Date and time when the project item was last changed

Status

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 67
Property Description

Activation Status Status of the (runtime) objects of an item displayed in the Properties window:
This property can have one of the following values:
● Runtime objects up to date
● Runtime objects out of date
● Runtime objects do not exist
● Runtime objects contain errors
● Check pending/Check not possible

Make sure that the status of the runtime objects is Runtime objects up to date when you
perform runtime tests. Otherwise, you may test on outdated runtime data. To update the runtime
objects, activate the item by right-clicking the item and selecting Activate.
To illustrate the activation status in the Solution Explorer, a red dot ( ) is displayed next to the item
icons whenever the runtime objects are not up-to-date.

For detailed Information about how the status of items and object items is displayed by icons
in the Solution Explorer, see Solution Explorer [page 55].

5.5.10 Trace Explorer

The Trace Explorer is a tool for gathering and analyzing diagnostic information.
For more information about tracing, see Tracing Quick Guide [page 573].

Features
You can access tracing functions in the studio as follows:
● Functions in the Debug toolbar
The Debug toolbar provides debug functions and in addition functions that allow you to start and stop tracing.
You can also access the Trace Explorer tool window from this toolbar.
You can access the Debug toolbar in the View menu by clicking Toolbars Debug .
● Trace Explorer tool window
The Trace Explorer tool window displays active and completed traces. You can run a local trace, run a trace
for a business user, use incident traces for troubleshooting purposes, and view the results of a recorded trace.
You can access the Trace Explorer tool window in the View menu. You can also access the Trace Explorer tool
window from the Debug toolbar.

5.5.11 Working with the Wizards

Overview
The wizards in the studio guide you through a logical sequence of steps, making it easier and quicker for you to
perform development activities that are complex, unfamiliar, or infrequently performed. All wizards are easy to
access and follow similar user interface (UI) patterns.

SAP Cloud Applications Studio – Version May 2018 (1805)

68 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Wizard Features
The wizards in the studio:
● Guide you through a logical sequence of dependent or independent working steps.
● Consist of three steps or more.
● Contain a review step.
The Review step:
○ Displays all data that you entered in the wizard in the previous steps and all objects that were
automatically generated.
○ Is always the last step, for example, first step (1/3), second step (2/3), Review step (3/3).
○ Is display-only.
You cannot change any entries in the Review step. To change an entry, click Back.
● Remain open until you have finished defining the item and the system has generated the item.
Most generated items appear in the Solution Explorer. When you define BAC elements, you can double-click
the .bac file or right-click the file and select Open to display and change the BAC elements you have defined.

Each wizard step displays the following buttons: Back, Next, Finish, Cancel. The appearance of the buttons depends
on the wizard step displayed, that is, whether the function is available. For example, the Back function is not available
in the first wizard step.

Available Wizards
You can access the following wizards in the studio:

Studio Wizards

Wizard Use

Approval Wizard Create an Approval Process [page 427]

Business Configuration Wizard ● Create a Business Option [page 324]

● Create a Business Topic and Business Options [page 326]
● Create a Country and Business Options [page 329]

Business Configuration Object Wizard Create a Business Configuration Object [page 334]

Business Configuration Set Wizard ● Create a BC Set Using an SAP BCO [page 332]
● Create a BC Set Using a Custom BCO [page 336]

Code List Data Type Wizard Create a Code List Data Type [page 406]

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 69
Wizard Use

Communication Scenario Definition Wizard Define a Communication Scenario [page 557]

Data Source Wizard Create a Data Source [page 455]

External Web Service Integration Wizard Integrate an External Web Service Using SOAP [page 551]
Integrate an External Web Service Using REST [page 552]

Form Wizard Create a Print Form [page 438]

Mass Data Run Wizard Create a Mass Data Run [page 467]

Notification Rules Wizard Enable Notification Rules [page 432]

Query Wizard Create a Query [page 363]

Service Integration Wizard ● Configure Internal Communication [page 523]

● Create XML File Input [page 524]

Tax Decision Tree Wizard Create a Tax Decision Tree [page 341]

Web Service Creation Wizard Create a Web Service [page 545]

5.5.12 Icon Library (Studio)

The following tables show some of the most frequent icons used in the studio.

Main Menu

Icon Icon Description Icon Icon Description

Save All Save and Activate

Help Menu

Icon Icon Description Icon Icon Description

Help Manage Help Settings

For more information, see Using Help Content [page 42].

SAP Cloud Applications Studio – Version May 2018 (1805)

70 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
My Solutions

Icon Icon Description Icon Icon Description

Log On Log Off

Create Solution Refresh

Open Solution Delete Solution

Customer-Specific Solution in Development Patch Solution

Solution Template Multi-Customer Solution

For more information, see My Solutions [page 49].

Solution Explorer
Generic Actions

Icon Icon Description Icon Icon Description

Properties Refresh Solution

Add New Item Customer-Specific Solution in Development

Activate Clean

Open Delete

Check Out Content Check In All Files, Check In Content

For more information, see Solution Explorer [page 55].

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 71
Solution Node Context Menu

Icon Icon Description Icon Icon Description

Add New Item Translation Context Menu:

Add Existing Item Export Text
Add New Folder Import Translation
For more information, see Add New Item Dialog Box Check Status
[page 58]. For more information, see Translation Quick Guide
[page 584].

Business Object Context Menu

Icon Icon Description Icon Icon Description

Create Script Files Create Screens

Node ABSL file

Deploy Business Configuration Open in UI Designer

For more information, see Business Objects Quick Guide [page 346] and Add New Item Dialog Box [page 58].

Implementation Manager

Icon Icon Description Icon Icon Description

Assemble and Download Solution Upload Solution

Create Patch Reset to Last Active Version

Import Solution Template

For more information, see Implementation Manager Quick Guide [page 153].

SAP Cloud Applications Studio – Version May 2018 (1805)

72 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
Trace Explorer

Icon Icon Description Icon Icon Description

Local Traces Incident Traces

Get Trace Details Delete Selected Traces

For more information, see Tracing Quick Guide [page 573].

See Also
Icon Library (UI Designer) [page 73]

5.5.13 Icon Library (UI Designer)

The following tables show some of the most frequent icons used in the user interface designer (UI designer).
For more information about what you can do with the tools, see Introduction to the User Interface Designer
[page 594].

Main Menu

Icon Icon Description Icon Icon Description

Import Save and Activate

Display<->Edit Activate

Configuration Explorer BO Browser

Properties Window Toolbox

Output Window Version History

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 73
 Icon Icon Description Icon Icon Description

Extensibility Explorer Update Metadata

Add Flex Layout Row Add Flex Layout Column

Remove Flex Layout Row Remove Flex Layout Column

Controller

Icon Icon Description Icon Icon Description

Add Operation Remove Operation

Bind Action Unbind Action

Add Parameter Delete Parameter

Data Model

Icon Icon Description Icon Icon Description Icon Icon Description

Add Item Rename

Structure Dedicated Structure Root Structure

Data Field Dedicated Field Data List Field

Data List Dedicated Data List

SAP Cloud Applications Studio – Version May 2018 (1805)

74 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
BO Browser

Icon Icon Description Icon Icon Description Icon Icon Description

Element Composition Association Intra-Business–Object

Association

Cross-Business-Object Association Composition that allows multiple Dependent-Object

instances of the target node Association

Intra-Business-Object Association Cross-Business-Object Association

that allows multiple instances of the that allows multiple instances of the
target node target node

5.6 Public Solution Model (PSM)

5.6.1 About the Public Solution Model (PSM)

The SAP public solution model (PSM) contains all entities in the SAP cloud solution that are released for use by
external consumers. External consumers can be partners who develop solutions on top of the SAP cloud solution
such as add-ons and integration scenarios or administrators who, for example, use SAP data sources to create new
reports. The modular and homogenous architecture of the SAP cloud solution allows SAP to offer external consumers
a highly flexible means of developing additional functionality without modifying the standard solution.

Basic Principles

Understanding PSM Entities

The Repository Explorer tool window displays SAP content that is released with the public solution model (PSM)
such as business objects, data types, enhancement options, inbound service interfaces, and reuse UIs. You can
explore the content to gain an understanding of the repository structure and the business context and use of SAP
content, which you can reuse and enhance in your solution.
For more information, see Repository Explorer [page 50].

Working with the Layer Strategy

The architecture of the SAP cloud solution is structured in three layers:
● Presentation — the user interface
● Application — the business logic
● Persistence — the database and search index

The SAP Cloud Applications Studio (“studio”) allows SAP partners, resellers, and customers to work with the same
entities that SAP uses in the core development of its cloud solutions and to develop solution capabilities that have
the same look and feel as the SAP standard cloud solutions. The content developed using the studio resides on a

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 75
different layer to the SAP content; therefore, SAP content that is released with the public solution model (PSM) can
be reused or enhanced without modifying the standard cloud solution. This content can be released for read-only
access or for read/write access.

Enhancing SAP Content

External consumers can extend or include additional business logic in a variety of SAP entities to enhance the
business functionality of the solution. Examples are new extension fields in business objects, which can be included
in user interfaces, reports, extension scenarios, or new embedded components that can be included in standard
SAP user interfaces to enhance the screens.

Reusing SAP Content

External consumers can reuse specific SAP content without modifying the standard solution. For example, external
consumers can reuse complete SAP user interfaces and enable navigation from a custom floorplan to an SAP
floorpan and from an SAP floorplan to a custom floorplan. It is also possible to reuse SAP application logic including
application logic that is relevant for legal requirements, for example, by reusing parts of SAP business objects or
data types.

Understanding Deprecation
The current structures and processes defined within the public solution model (PSM) remain stable for the current
and upcoming release. If it is necessary for SAP to make changes to PSM entities to meet technical or business
requirements, SAP uses a deprecation mechanism that allows external consumers to update their solutions in an
appropriate time frame.

SAP plans to make changes to specific business object elements in the future:
● The business object elements are set to deprecated and, if an element is deprecated, all children
are also deprecated. For example, if a business object node is deprecated, all actions, queries, and
elements that belong to this node are also deprecated.
● SAP identifies the use of deprecated elements in a solution, informs the partner or other external
consumer who developed the solution, and provides information about the successor element.
● The external consumer creates a new version of the solution before another SAP release becomes
available.
● The new version of the solution is made available to customers for activation with the new release
of the SAP solution
● SAP revokes the respective business object element.

Requesting Release of Additional PSM Entities

If you need to access business content for the SAP cloud solution that has not been released for consumption through
the PSM, you can request SAP to release this business content. To do this, proceed as follows:
1. Create an incident in the SAP cloud solution and use the prefix PSM.
For information on how to create an incident, see here [page 565].
2. Describe the use case of your solution and what you are trying to achieve (that is, what is the purpose of your
development/solution?).
3. Describe the required business content/entities to be released in PSM, and why you need them.
4. If you require business content such as the fields of a business object from a UI, provide a screenshot of that
UI and highlight the elements that need to be enabled for read-access and for write-access.
5. Add your contact information - that is, e-mail address and telephone number - so that SAP can easily get back
to you in case of questions.

SAP Cloud Applications Studio – Version May 2018 (1805)

76 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
SAP Content Types

Deployment Units
A deployment unit is a piece of software that can be operated on a separate physical system, isolated from other
pieces of software. the SAP cloud solutions are organized in deployment units that group semantically related
business objects. For example, the Customer Relationship Management deployment unit groups business objects
such as Campaign, Lead, Opportunity, and Sales Order. The Foundation deployment unit mainly contains master
data objects, such as Material, Employee, and Customer.

Business Objects
A business object is a code representation of a self-contained, independent, real-world business concept, such as a
company, an employee, a sales order, an opportunity, or a product. The definition of a business object describes the
structure and behavior of a real-world business concept. Each business object resides in a deployment unit and
consists of a hierarchy of nodes, which represent the data.
Business object elements can be published for read-only access or for write access; write access means that an
external consumer can create, update, or delete instances of that business object by calling the core services
Create, Update, or Delete.

Data Types
A data type is a classification of a particular type of information.

Enhancement Options
An enhancement option is a repository object provided by SAP for a specific application to allow the standard
behavior of the application to be enhanced without modifying the standard solution. Enhancement options are
defined with metadata and documentation. A distinction is made between single-use enhancement options and
multiple-use enhancement options. If an enhancement option is for single use, it can be implemented only once in
a solution. If an enhancement option is for multiple use, it can be implemented more than once in a solution.
For information about creating an implementation of an SAP enhancement option, see Create an Enhancement
Implementation [page 401].

Inbound Service Interfaces

An inbound service interface is an interface used to query or manage certain entities or a group of entities within the
SAP solution from an external application. Examples of inbound service interfaces are B2B messages or web
services. Inbound service interfaces consist of inbound service interface operations which offer specific business
functionality for an external consumer.

Embedded Components
An embedded component is a reusable user interface component that you can add to other floorplans. The parent
floorplan influences the behavior of the embedded component.

Object Value Selectors

The object value selector (OVS) is a user interface (UI) pattern that supports users in selecting values for an input
field. It helps users to select one item from a table of business object instances. It is most commonly called from an
input field by means of a selection dialog icon. If an input field contains data, it is transferred to the selection modal
dialog. Unlike other input and value help controls, an OVS does not appear attached to an input field; it appears within
a modal dialog that floats above the entire window. It is possible to save and organize queries. Examples of SAP
object value selectors are Employee, Campaign, and Sales Order.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 77
Business Adaptation Catalog (BAC) Elements
The full set of the SAP cloud solution's capabilities are outlined in a central business adaptation catalog (BAC). This
catalog organizes and structures the capabilities into a hierarchy of business areas, packages, topics, and options.
Solutions created in the studio require business configuration content that then appears as elements (BAC elements)
in the catalog and allows administrators to implement solutions in the production environment.
For more information, see Business Adaptation Catalog [page 320].

Data Sources
A data source is an object that provides a multidimensional, analytical view of business data. Data sources are the
basis of analytical report content and are associated with a specific access context or can be unrestricted.

Reuse Libraries
● Basic reuse libraries
The basic reuse libraries of the scripting language extend the scope and functions that you use to implement
your business logic in the studio. These “language-near” libraries provide basic functions that are used quite
often, for example, to retrieve context data, such as the current date or time for the current identity.
For more information, see Basic Reuse Libraries Reference [page 238].
● Reuse libraries for business areas
The reuse libraries for business areas provide additional, very specific services to the scripting language that
are relevant for functions in the SAP solution's business areas, for example, in the Financial Management
business area. These services are all based on entities provided by SAP.
For more information, see Reuse Libraries for Business Areas Reference [page 268].

Extension Scenarios
Extension scenarios enable you to create an extension field in one business context and then add that extension field
to multiple other business contexts. The data stored in the extension field is then passed from one business context
to the next as part of a business process. The following extension scenarios have been predefined by SAP:
● Account - General Information to Lead - General Information
● Account - General Information to Opportunity - General Information
● Lead - General Information to Opportunity - General Information

5.7 Introduction to Business Object Modelling

5.7.1 Business Object Modeling

Overview
The SAP cloud solutions are built using the concept of “business objects” to model the business environment. This
document provides an introduction to the structure and behavior of SAP business objects.

Architecture of the SAP Cloud Solution

The cloud solutions are based on a 3-tier architecture:

SAP Cloud Applications Studio – Version May 2018 (1805)

78 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 ● User Interface
● Business Logic
● Persistence Layer (database, search index)

All business logic is implemented in business objects that model real-world objects and processes.

The business object model is the central anchor for script coding, the user interface (UI), forms, and business tasks.

Changes to the business object may require corrections to scripts, UI screens, forms, and so on. Therefore,
when developing an cloud solution, we recommend that you complete the business object design as far as
possible before proceeding.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 79
What is a Business Object ?
A business object is a self-contained, independent business concept that is well known in the business world. Typical
business objects are Sales Order, Employee, and Product.
In the cloud solutions, business objects:
● Encapsulate business logic and business data
● Act as a service consumer and provider
● Are accessible exclusively through a standardized set of (core) services
● Are described by a business object model that defines:
○ Structure
○ Type of the attributes
○ Aspects of the behavior
○ Service interfaces

SAP Cloud Applications Studio – Version May 2018 (1805)

80 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 The business object is the type and not the instance:
● business object = purchase order
● business object instance = purchase order with ID 32452

Business Object Categories

Business objects are classified into categories. For more information, see here [page 91].

Deployment Unit
Each business object belongs to a deployment unit, which is a piece of software that can be operated on a separate
physical system, isolated from other pieces of software. For more information, see here [page 187].

Creating your Business Object

There are three starting points for the development of a business object model:
● The user interface (UI), which represents all the information the user has to interact with (such as data entry,
analytics, and reporting).
● An integration scenario with the message choreography, for example with SAP or a business-to-business
partner. Each message represents a business document with more or less structured information.
● The engines that provide services concerning a specific topic (such as a pricing engine or tax engine).

Determining and Naming the Objects

By analyzing the business scenario you want to model, you determine which processes and objects should be
modeled as separate business objects. Information that describes the business object in more detail is modeled as
elements within the business object.
To ensure the right naming according to the business semantics, the business object name is constructed / chosen
according to ISO 11179 naming standards.
● The names are in British English
● Abbreviations and acronyms are allowed only when used normally within business terms

Creating the Structure

The internal structure of a business object (BO) is described by nodes, which are connected by relationships. The
creation of a node is primarily based on the business understanding of the BO.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 81
For a simple BO, you may decide not to create any nodes, in which case all elements belong to the root node of the
BO, which is created implicitly.
A separate node represents a logical / semantic group of elements that can be treated as a group even if the elements
could be assigned directly to the higher-level node.
● Elements in one node can be mandatory or optional.
● Elements with multiplicity larger than 1 require a separate node.
● Nodes are related by a strict hierarchical relationship
○ Compositions with multiplicity
○ No n:m relationship

The creation of a node implicitly introduces a composition, that is, a relationship between the parent node and the
child node. Compositions can be used to access features of the child node from the parent node (for example, in
action implementations). For each composition, a reverse association to the parent node is created implicitly.

Example: Purchase Order

A Purchase Order is a buyer’s request to a seller to provide or deliver certain quantities of products at one or several
dates.
We can model the purchase order with the following nodes:
● Item – we can have one or more items, so this node is given a multiplicity of [1,n]
● Buyer – the buyer of the goods or services
● Seller – the seller of the goods or services
● Delivery Terms

Creating Sub-types
An object or object node can “play” different roles. You have to decide which roles are important from a business
point of view and should be represented explicitly by sub-types.
Analyze all objects and object nodes to determine whether some roles can be merged – this is an indication for the
existence of sub-types. Merging the roles leads to generalized objects or components.

Example: Purchase Order – Sub-types

In our Purchase Order we can see that Buyer and Seller are two types of the more general component “Party”. There
could also be other parties involved in this transaction, such as a Bill To party.

SAP Cloud Applications Studio – Version May 2018 (1805)

82 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
Internal Association for Navigation
Internal association (also referred to as intra-BO association) enables navigation between nodes that is not provided
directly by structural relationships.
Association for Navigation:
● Enables you to create a “navigation shortcut” to facilitate / optimize navigation
● Can be used where the target object node is determined by algorithm (“calculated / derived” relationships):
○ Navigation to multiple instances (“range”) – target multiplicity: [0,n] or [1,n]
○ Navigation to a single instance – target multiplicity: [0,1] or [1,1]

Example: Purchase Order – Internal Association

In our purchase order we can use association for navigation to simulate specialization by role.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 83
Creating the Elements
Once you have defined the business objects and nodes you can assign elements of a particular data type to the
nodes.
To homogenize the use of data types, SAP defines global data types that represent business-related content in
conformance with widely used Web and business standards, such as DateTime, Amount, Currency, Text, String, and
Boolean.
All business objects and service interfaces share the same pool of global data types. For more information, see Data
Types [page 87].

SAP Cloud Applications Studio – Version May 2018 (1805)

84 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
Creating External Associations
External association (also referred to cross-BO association) is used to build relationships between business objects.
These relationships are classified as aggregations and associations and are described from a business point of view.
Attributes with a name related to another object are replaced by the ID of the referenced object. The attributes are
then removed from the current structure and included in the referenced object. This integration produces a local
view of the object model.

Example: Purchase Order

The Purchase Order business object model contains:
● Party
● Product
● Location

In the element structure these associations are represented by the corresponding reference component.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 85
Defining the Behavior
Business object nodes offer services (operations) that can be accessed using interfaces. Operations and their
implementation are generated from the business object definition.
Business logic is added in script coding, which may call operations from other business object nodes.

Core Services and Actions

Core Services
The core services of Create, Retrieve, Update, and Delete ("CRUD") are automatically handled by the studio.
Save
The Save service checks the consistency of the business object and saves to the database. This is automatically
handled by the studio.
Create with Parameters
This service creates a business object or business object node instance based on specific input parameters. For
example:
● CreateWithReference (for example, create sales order from sales quote)
● CreatePaymentCard (for example, for a sales order)
● Copy

Status and Action Management

Status actions check the data of the business object and transfer the business object to another status, or refuse
the requested status change. For example:
● Release
● Approve
● Complete

The status of a business object can determine which actions are allowed.

Queries
A query is a service that returns a list of business object instances based on query parameters. Queries support
sorting, paging, and the use of "search engine" indexes.

SAP Cloud Applications Studio – Version May 2018 (1805)

86 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 ● Simple queries for all elements in a business object node (QueryByElements) are automatically handled by
the studio
● Complex queries can also be created that allow joining over business object nodes and business logic (for
example, complex time dependencies)

See Also
Example: Building a Solution [page 93]

5.7.2 Business Object Modeling: Data Types

Each element of a business object must be assigned a data type. To homogenize the use of data types, SAP defines
consolidated global data types (GDTs) that represent business-related content in conformance with widely used
Web and business standards. All business objects and service interfaces share this same pool of GDTs.

You can access the data types that are available via the Repository Explorer [page 50]: Data Types.

SAP data types are located in the namespace: AP.Common.GDT (namespace: http://sap.com/xi/BASIS/
Global)..

Data Types
The studio uses the following data types:

Basic Data Type

The basic data type does not contain any elements.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 87
Example

Enterprise Search Name Enterprise Search Namespace Initialization

CurrencyCode http://sap.com/xi/BASIS/ element <currency code> :

Global CurrencyCode = "EUR";

Structured Data Types

There are two different structured data types. The first structured data type consists of content and one or several
attributes.

Example

Enterprise Search Name Enterprise Search Namespace Initialization

Amount http://sap.com/xi/AP/ element <amount> : Amount =

Common/GDT {content = "15",
CurrencyCode = "EUR"};

The second structured data type consists of content and technical attributes. These are hidden in the studio so that
only the content is visible.

Example

Enterprise Search Name Enterprise Search Namespace Initialization

ProductID http://sap.com/xi/AP/ element <identifier> :

Common/GDT ProductID = {content =
"MCP-100"};

Aggregated Data Type

The aggregated data type consists of several basic or structured data types. It does not support labels, tooltips, or
default values. A typical example of an aggregated data type is Price.

Example

Enterprise Search Name Enterprise Search Namespace Initialization

Price http://sap.com/xi/A1S/ element <price>: Price;

Global

Identifier
You use the ID data type to identify a business object or business concept.
element <ID_name> : ID;
The ID data type has up to 60 characters, is not structured and does not contain the Content element. The data
type supports, for example, upper case conversion and alpha conversion. Alpha conversion fills purely numeric user
input like “4711” with leading zeros to allow better sorting in character fields. For example, if alpha conversion is not
used, an alphabetic sorting would lead to results such as: “1”, “10”, “100”, “1000”, “2”, “20”, “200”, and so on.

SAP Cloud Applications Studio – Version May 2018 (1805)

88 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
String
Instead of a “string” data type, you use the data types Name, Description and Text, which are technically strings.
You use Name as the short text for a business object, Description as the long text, and Text for additional notes.
For rapid prototyping, you can use language-independent Name, Description, and Text to avoid language
handling, which costs extra effort in coding and on the user interface.
element <name> : LANGUAGEINDEPENDENT_SHORT_Name;
element <description> : LANGUAGEINDEPENDENT_LONG_Description;
element <additional_text> : LANGUAGEINDEPENDENT_EXTENDED_Text;
The length of the string can be one of the following:
● SHORT = 10 characters
● MEDIUM = 40 characters
● LONG = 80 characters
● EXTENDED = 255 characters

Boolean
You use the Indicator data type to identify a Boolean element.
element <some_indicator> : Indicator;

Date and Time

You use the following data types to identify dates and times:
element <some_date> : Date;
element <some_time> : Time;

element <some_date> : Date = "2012–04-24";

element <some_time> : Time = "16:35:14";

Number
You use the following data types to declare numbers, amounts, quantities, and measures:
element <some_number> : NumberValue;
element <some_amount> : Amount;
element <some_quantity> : Quantity;
element <some_measure> : Measure;
● Use the NumberValue data type for integers.
● Use the Amount data type for money. This is a structured data type that consists of a number and a currency
code (for example: 25 EUR).
● Use the Quantity data type for all other quantities (pieces, length, weight, and so on). This is a structured
data type that consists of a number and a code for the measurement unit (for example: 25 KGM represents
25 kilograms).
● Use the Measure data type for measures (pieces, length, weight, and so on). This is a structured data type
that consists of a number and a code for the measurement unit (for example: 25 MTR represents 25 meters).

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 89
Percent and Ratio
You use the following data types to declare percent and ratio values:
element <some_percent> : Percent;
element <some_ratio> : Ratio;

Code Lists
A code list is a field with a set of predefined values. SAP provides a large number of code lists as data types that you
can use. The data type name ends with the word “Code” to identify it as a code list.
Some common code lists are:
element <priority_code> : PriorityCode;
element <release_status_code> : ReleaseStatusCode;
element <approval_status_code> : ApprovalStatusCode;
You should use an SAP code list where possible. If no appropriate SAP code list is available, you can define your own
code list data type with your own code list in the studio. There are two ways to create code lists:
● Static code lists. For more information, see Create a Code List Data Type [page 406]
● Configurable code lists. For more information, see Configurable Code Lists.

Most SAP code lists are context-independent. Some of the code lists, however, are context-dependent, that is, the
code values differ depending on the context (for example, country).
The following table shows the values of the WorkAgreementAdministrativeCategoryCode code list of two
different countries.

List ID Country Code: United States Country Code: Germany

1 Hourly Hourly-Paid Industrial Worker

2 Salaried Non-Exempt Salaried Employee

3 Salaried Exempt Senior Executive

4 Monthly-Paid Industrial Worker

For more information, see Example: Context-Dependent Code List

E-mail Address and Web Address

You use the following data types to declare e-mail and Web addresses:
element <e-mail_address> : EmailURI;
element <web_address> : WebURI;

element <some_email_address> : EmailURI = {content = "[email protected]"};

element <some_web_address> : WebURI = "http://www.sap.com";

SAP Cloud Applications Studio – Version May 2018 (1805)

90 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
5.7.3 Look Up the Representation Term of a Data Type

Procedure
1. In the studio, select View Other Windows Repository Explorer .
2. In the Repository Explorer, select Data Types.
3. In the Search data types window, search for the data type you want to use.
The data type details window opens.
4. Under Overview, you find the representation of the data type.

Example: Looking Up the Representation Term of a Data Type

See Also
Repository Explorer [page 50]

5.7.4 Business Object Categories

Business Transaction Document Objects and Master Data Objects

Business transaction documents and master data objects are both used to represent self-contained, independent
business concepts, that are familiar to the business world (for example, in an international standard or industry best
practice).
Examples of business transaction documents:
● Campaign
● Opportunity
● Service Request

Examples of master data objects:

● CostCentre

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 91
 ● Customer
● Employee
● SalesArrangement

Business Configuration Object

A business configuration object represents business configuration content that is not changed during normal
operations. These objects may contain active content and inactive content (new implementation or business
configuration change project).
Example of business configuration object:
● BusinessTransactionDocumentItemTypeCountry

Mass Data Run Object

A mass data run is the automatic and parallel processing of a typically huge number of selected objects in accordance
with given business rules. A mass data run object controls mass data runs on a selected set of objects.
Examples of mass data run objects would be:
● Material and Resource Planning (MRP) Run
● Dunning Run

Technical Object
A technical object supports the technical infrastructure or IT Service and Application Management (ITSAM) of the
application platform.
Example of technical objects:
● ObjectIdentifierMapping

Transformed Object
A transformed object provides consumer-friendly services across multiple business objects and their already
existing functionality. A transformed object is used if a view on multiple business objects is required in the
representation of a business object (for example, because the using application requires a business object).
Transformed objects are instantiated at run-time and do not have their own persistence – they rely on the persistence
of the underlying business objects.
Example of transformed objects:
● BusinessDocumentFlow

Dependent Object
A dependent business object is used as a reusable part in another business object. It represents a concept that
cannot stand alone from a business point of view. Instances of dependent objects can only occur in the context of
other business objects.
Examples of dependent objects:
● Attachment Folder
● PartnerAddress
● PriceSpecification
● Text Collection
● Workplace Address

SAP Cloud Applications Studio – Version May 2018 (1805)

92 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
Template Object
A template object is used to describe objects representing similar subject matter. It specifies the union of all
components (nodes, relationships, elements, service operations) of the objects, without any redundancy.
Examples of template objects would be:
● Customer Transaction Document (this is the template for SalesOrder, Quote, Return, ServiceOrder,
ServiceRequest, and so on)
● Product (this is the template for Material, Service Product, Warranty, and so on)

5.8 Example: Build a Simple Solution

5.8.1 Example: Building a Solution

Overview
In this example you are going to build a solution to manage the allocation of car parking spaces to employees in the
SAP cloud solution.
● The solution contains one business object – representing a car park – of which there can be multiple instances.
● The car park business object contains a node for "parking spaces" – of which there can be 0 to n.
● Each parking space is assigned to an Employee ID using an Object Value Selector (OVS) – this allows you to
look up the employees within the company.
● The parking space node has an association to the Employee business object – this allows you to retrieve the
employee's first and last name.

Any software coding or code lines/strings (“Code”) provided in this documentation are only examples
and are not intended for use in a productive system environment. The Code is only intended to better
explain and visualize the syntax and phrasing rules for certain SAP coding. SAP does not warrant the
correctness or completeness of the Code provided herein and SAP shall not be liable for errors or damages
cause by use of the Code, except where such damages were caused by SAP with intent or with gross
negligence.

Tasks

Create the Business Object

1. Open the studio and log on to the repository.
2. In the My Solutions tool window, right-click My Solutions and click Create Solution.
The Create Solution dialog box opens.
3. Enter a Description for your solution, select a deployment unit and Customer-Specific Solution, then click
OK.
4. In the Solution Explorer, right-click the project and select Add New Item .
5. Select the Business Object template and enter a Name (for example CarPark), then click Add.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 93
 To add data to your business object, you declare an "element", enter a name, and assign it a data type.
Elements are entered according to the following syntax:
element <your_element_name> : <data_type>;
When you type the colon (:), the code completion function presents a list of valid data types, from
which you can select.

6. Add some data to the car park. First you need an ID to identify your car park. You can then add extra
information, such as a name and the number of car spaces.
element CarParkID : ID;
element CarParkName : LANGUAGEINDEPENDENT_LONG_Text;
element CarParkDescription : LANGUAGEINDEPENDENT_LONG_Description;
element Number_of_ParkingSpaces : IntegerValue;
7. Each car park can have multiple car parking spaces. Therefore, you create a node with a multiplicity of [0,n]
to represent the car spaces within each car park. Each node requires an ID.
node ParkingSpace [0,n] {
element ParkingSpaceID : ID;
}
8. Each car space can be assigned to an employee. Therefore, you create an element of type EmployeeID to
record the employee.
element ParkingSpace_AssignedEmployeeID : ID;
9. To make the connection to the existing employees in the company, you create an association to the SAP
business object: Employee. This enables you to use the data from this business object in your screens. To
use the Employee association you first have to import the namespace of the Employee business object.
import AP.FO.BusinessPartner.Global;
association ToEmployee [0,1] to Employee;
10. You can add some additional information for the car space.
element ParkingSpace_Disabled : Indicator;
element Vehicle_RegistrationNumber : LANGUAGEINDEPENDENT_MEDIUM_Text;
element ParkingSpace_Level : NumberValue;
11. Save and activate the business object.

You can find the complete business object code here [page 106].

Create the Screens

The next step is to create the screens that will display the data from the business object, and allow the user to interact
with the business object.
1. Right-click your business object and select Create Screens.
The Create Screen dialog box opens.
2. Enter a Name for your screens, select a scenario, enter a Short ID and click OK.
The default screens provide a starting point for your solution and include built-in navigation between screens.
For this example, you will use the default Object Work List (OWL) and you will modify the Quick Activity
Floorplan (QAF) screen.
3. In the Solution Explorer, double-click the QA floorplan to open it in the user interface designer (UI designer).
On the Designer tab, you can see that the root node elements from the business object are automatically
displayed as fields on the screen.

SAP Cloud Applications Studio – Version May 2018 (1805)

94 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 On the DataModel tab, you can see the data fields to the left, and on the right you can see the structure of
your business object, including the ParkingSpace node and the association to the SAP business object
Employee.
Notice that data fields are automatically created for the root node elements. Selecting one of the data fields
shows that a binding exists with the corresponding business object element.

Create the Data List

For each car park, you want a table listing the car spaces and the assigned employee for each space.
1. Open the Designer tab, click the AddFlexLayoutRow button and select the new row.
2. On the Toolbox tab, under Panes, select AdvancedListPane and drag and drop it onto the new row.

The list pane is displayed on the Designer tab.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 95
 3. Right-click one of the columns and select Add Column .
4. Open the BO Browser/Data Model by selecting View BO Browser or clicking the BO Browser button.
5. In the BO Browser, select the CarPark BO Model.
6. Drag the ParkingSpaceID element onto the first column header of the list pane. Select No when prompted to
use backend text and save your changes.

On the DataModel tab, you can see that the data field and the binding are created automatically.

7. On the Designer, drag the ParkingSpace_AssignedEmployeeID element onto the second column header of
the list pane. Select No when prompted to use backend text and save your changes.

Add the Object Value Selector

You can use an Object Value Selector (OVS) to select the employee ID from a list of the existing employees.
1. Select the ParkingSpace_AssignedEmployeeID column and in the Property Explorer, under Appearance, select
ObjectValueSelector as the DisplayType.

SAP Cloud Applications Studio – Version May 2018 (1805)

96 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 2. Under ValueHelp, set the OVSComponent to /SAP_BYD_APPLICATION_UI/publicovs/employeeid/
EmployeeID: In the Select OVS Component... dialog box, click Browse to select the component.

3. Click OK, then OK and save your changes.

Add the Associated Elements

1. Open the BO Browser/Data Model.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 97
 2. In the BO Browser, expand the ToEmployee association. Here you can see the fields of the SAP business
object: Employee.
3. Select the element ToEmployee CurrentCommon Person Name GivenName and drop it onto the
third column header.
4. Select the element ToEmployee CurrentCommon Person Name FamilyName and drop it onto the
fourth column header.
Both the first and last name will be automatically populated based on the selection of the Employee ID,
therefore you do not want these fields to be editable.
5. Select the GivenName column and in the Property Explorer, select Properties Appearance
DisplayType StaticText . Repeat the steps for the FamilyName column and save your changes.

Edit the Column Headers

1. For each column, edit the header Label in the Property Explorer. Suggested headings are as follows:
● Parking Space ID
● Assigned Employee ID
● First Name
● Last Name
2. Select one of the columns under Text Information.

SAP Cloud Applications Studio – Version May 2018 (1805)

98 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 3. Select the Label field and click the down arrow key.
4. The DependentProperty Editor opens. In the Overridden Text field, change the text and click OK. Save your
changes.

Add a Toolbar
1. Select the list pane by clicking the area to the left of the first column.
2. In the Property Explorer select AdvancedListPaneVariant: ListPaneVariant.

3. Under Toolbar Information, set the UseToolbar value to True.

By default, you get an Add Row button and a Remove button. However, you have to add and configure an
event handler for each button.
4. Click the Add Row button.
5. In the Property Explorer, under Events, select OnClick ...New Event Handler... .
The Configure EventHandler dialog box opens.
6. Enter a name for the event handler (for example AddRowHandler).
7. Add an operation of type List:
a. Click Add Row.
b. In the Type field, select List.
8. Set the Operation to AddRow and the Target List to /Root/DataList. Click OK.
9. Repeat the above steps for the Remove button, but this time give it the name RemoveRowHandler and select
RemoveRow as the Operation.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 99
 10. Add an additional operation of type WindowAction and select Save as the Action Type. This ensures that a
save is performed after a row is deleted. Click OK.
11. Save your changes.

Change the Floorplan Title

You can create a variable title, so that the title reads "Car Park X" – where "X" is the car park ID.
1. On the Designer tab, select the Identification Region.
2. In the Property Explorer, under Misc select Floorplan Title.
3. In the DependentProperty Editor, select Overridden Text.
4. Replace the existing Constant/DataField with the text Car Park: , including the blank space at the end.
Click Advanced.
5. Click the plus button to create a new string or data field.
6. Click the three dots at the end of the new row.
7. In the Select Data Field dialog box, select the data field CarParkID.

8. Click OK.

9. Click OK and save your changes.

SAP Cloud Applications Studio – Version May 2018 (1805)

100 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
Change the Title of the List Pane
1. On the Designer tab, select the list pane.
2. In the Property Explorer, under Pane Header select Pane Header.
3. In the DependentProperty Editor, select Overridden Text and enter a name for the pane (for example Parking
Spaces).

Remove the Title of the Form Pane

1. On the Designer tab, click the text Root Node Elements to select the Section Group within the form pane.
2. In the Property Explorer, under Text Information set Show Header to False.

Change the Order of the Fields in the Form Pane

1. Select the Section Group.
2. In the Property Explorer, select Fields under Contents.
The Field Collection Editor dialog box is displayed.
3. Select a field and click the arrows to move it up or down the order.

Edit the Field Labels in the Form Pane

1. To edit the name of a field, select the field and edit the Label in the Property Explorer.
2. Save your changes.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 101
Add Details Area
1. On the Designer tab, select the Parking Spaces section and click Add FlexLayoutRow.
2. Open the BO Browser/Data Model and drag and drop the following elements from the BO Browser onto the
new row:
● ParkingSpace_Disabled
● ParkingSpace_Level
● Vehicle_RegistrationNumber
3. For each field, edit the Label in the Property Explorer (Disabled Friendly Parking, Parking Level, Vehicle
Registration Number).
4. Select the Section Group and change the Field Group Header text in the Property Explorer to Details.
5. Open the DataModel tab and drag the newly added fields into the DataList on the left. This links these fields
to the individual parking spaces.
6. Click Save and Activate and close the UI designer.

Edit the Work Center Title

The default work center title is taken from the business object name. You can change this title by editing the work
center floorplan (WCF).
1. In the Solution Explorer, double-click the WCF screen to open it in the UI designer.
2. On the Designer tab, click the folder icon to select the OberonCenterStructure.
3. In the Property Explorer, click the Title field.
4. In the DependentProperty Editor, select Overridden Text and enter a name for the work center (for example
Car Park Manager).

If other users have completed this example, there may be multiple work centers with the same title. In
this case, you may want to give the work center a unique title, such as <your name> – Car Park
Manager.

5. Click OK, then Save and Activate and close the UI designer.

SAP Cloud Applications Studio – Version May 2018 (1805)

102 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
Create the AfterModify Script File
You have set up the QAF screen and created the OVS to find the Employee ID. However, you need a script file to
assign the value selected in the OVS to the Parkingspace_AssignedEmployeeID element and to update the other
fields (first name, last name, etc.) after this selection.
1. In the Solution Explorer, right-click the business object and select Create Script Files.
2. In the Create Script Files dialog box, create an AfterModify script file for the ParkingSpace node.

The Mass Enable checkboxes are selected by default.

3. Enter the script code from here [page 107].

4. Save and activate the script file.

Assign Work Center

Assign rights to your business user so that you can access the new work center in the SAP cloud solution. For more
information, see User Setup Quick Guide [page 31].

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 103
Test the Solution
1. Log on to the SAP cloud solution with a user that has access to the Car Park Manager work center.
2. Click the Car Park Manager work center to open the Car Park OWL.

From the OWL you can create new car parks or edit the details of existing car parks.

SAP Cloud Applications Studio – Version May 2018 (1805)

104 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 3. Select a car park and click Edit to bring up the QAF.
4. Click Add Row to create a new parking space and enter a Parking Space ID.
5. Click the icon in the Employee ID field to bring up the OVS and select an employee.
The First Name and Last Name fields are automatically populated.
6. Enter additional information in the Details area.

Further Development
Now that you have developed a solution, you can begin to appreciate the power and flexibility of the studio.
There are many enhancements you could make to this solution. Here are just a few ideas:
● Auto-refresh the OWL after creating a new car park. For more information, see here [page 113].
● Validate the car park on save, so that you cannot assign more than the total number of car spaces. An error
message is displayed to the user if they attempt to save a car park that fails this validation rule. For more
information, see here [page 133].
● Add a field to calculate the number of unassigned car spaces. For more information, see here [page 114].
● Create a read-only car park fact sheet. For more information, see here [page 117].
○ Create a View button on the OWL that links to the carpark fact sheet using object-based navigation
(OBN). For more information, see here [page 123].
○ Create a link from the car park fact sheet to the employee fact sheet using object-based navigation
(OBN). For more information, see here [page 127].
● Extend the employee business object to show the Parking Space ID on the employee fact sheet. For more
information, see here [page 131].
● Add a URL mashup to display the car park location on a map. For more information, see here [page 109].
● Add a form to provide a PDF printout of parking spaces and assigned employees.
● Add date/time information to each parking space. You could then add a cost per day or per hour.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 105
5.8.2 Sample Code

5.8.2.1 Sample Code: Business Object CarPark

import AP.Common.GDT as apCommonGDT;

import AP.FO.BusinessPartner.Global;

businessobject CarPark

// *Further Development*
// declare an error message that is called if the BO fails validation
// raises Message_Car_Park_Full

// Root node must not be specified, it is created implicitly

//
// Add elements here.
//
// To declare an element as alternative key, use the [AlternativeKey] annotation.
// Please note:
// - An alternative key of type UUID exists implicitly for each node, enabling the
node
// to be used as an association target.
// - The QueryByElements query is created automatically for each node.
// - Code completion is available with CTRL + SPACE.

// *Further Development*
// define an error message to be displayed if the BO fails validation
// message Message_Car_Park_Full text "The car park is full - no spaces
available";

// Car Park ID - (the company may have multiple car parks)

// - therefore we use this ID to identify the individual car park
element CarParkID : ID;

// additional information on the car park

element CarParkName : LANGUAGEINDEPENDENT_LONG_Text;
element CarParkDescription : LANGUAGEINDEPENDENT_LONG_Description;
element Number_of_ParkingSpaces : IntegerValue;

// *Further Development*
// add an element to display how many parking spaces are available
// element Number_of_ParkingSpaces_Available : IntegerValue;
// declare an action to calculate the available car spaces
// action Update_AvailableParkingSpaces;

SAP Cloud Applications Studio – Version May 2018 (1805)

106 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 // *Further Development*
// add an element to record location information
// this field is used with a URL mashup to display the location of the car park
// element CarParkLocation : LANGUAGEINDEPENDENT_MEDIUM_Description;

// each car park will have multiple parking spaces

// we create a node with 0 to n parking spaces

node ParkingSpace [0,n] {

// each parking space is assigned a unique identifier

element ParkingSpaceID : ID;

// display the ID of the Employee assigned to the parking space

element ParkingSpace_AssignedEmployeeID : ID;

// a parking space may be designated as a "Disabled Friendly" parking space

element ParkingSpace_Disabled : Indicator;

// is there an electric charging station for this parking space ?

element ParkingSpace_ElectricChargeStation : Indicator;

// display the license plate number of the employee's car

element Vehicle_RegistrationNumber : LANGUAGEINDEPENDENT_MEDIUM_Text;

// for a multi-level car park, we have the possibility to specify a level

number
element ParkingSpace_Level : NumberValue;

// we need to create an association to the SAP BO "Employee"

// this allows us to include elements from the Employee BO in our screens
// a parking space may be associated to at most one employee
association ToEmployee [0,1] to Employee;

}
}

5.8.2.2 Sample Code: Event-AfterModify CarPark-ParkingSpace

import ABSL;
import AP.FO.BusinessPartner.Global;

// Auxiliary flag that will help us decide whether we have to

// update the ToEmployee association.
var bUpdateEmployee = false;

// Our pointer to the employees' query.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 107
var qryEmployees;

// Object that will hold the parameters for our employees' query call.
var paramEmployee;

// Collection of result values of our employees' query call.

var resultEmployees;

// Check whether our ToEmployee association is still up to date. If not, we'll

// have to update it.
if (this.ParkingSpace_AssignedEmployeeID.IsInitial()) {
// => No employee indicated for the parking space.
if (this.ToEmployee.IsSet()) {
// => Our ToEmployee association still holds the employee that had been
// associated before - so now we have to reset the association.
this.ToEmployee.Reset();
}
}
else if (!this.ToEmployee.IsSet()) {
// => We do have an employee indicated for the parking space, however,
// the association ToEmployee hasn't been initialized, yet.
// => Set our flag to true.
bUpdateEmployee = true;
}
else if (this.ToEmployee.IdentificationEmployeeID.EmployeeID.content !=
this.ParkingSpace_AssignedEmployeeID) {
// => We do have an employee indicated for the parking space, however,
// the association ToEmployee still holds the employee that had been associated to the
space before.
// => Set our flag to true.
bUpdateEmployee = true;
}

if (bUpdateEmployee) {
// => Our association to the employee needs to be refreshed.
// Reset it first, since the new employee ID might be invalid.
this.ToEmployee.Reset();
// Now look for the details of the given employee:
// ...connect to the BO Employee's query...
qryEmployees = Employee.Identification.QueryByEmployeeAttributes;
// ...populate the parameters collection for the query call...
paramEmployee = qryEmployees.CreateSelectionParams();
// ...saying that the ID of the employee we're looking for must be the ID indicated by
our user...
paramEmployee.Add(qryEmployees.EmployeeID.content, "I", "EQ",
this.ParkingSpace_AssignedEmployeeID);
// ...and execute the query!
resultEmployees = qryEmployees.Execute(paramEmployee);
// Hopefully we've found an employee to the given ID!
foreach (var oneEmployee in resultEmployees) {
// Since we know that we can have only one employee to the ID, we
// take the first result and exit the loop.

SAP Cloud Applications Studio – Version May 2018 (1805)

108 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 this.ToEmployee = oneEmployee.ToRoot;
break;

}
}

5.8.3 Further Development

5.8.3.1 Add a URL Mashup to an SAP Floorplan

Overview
In this example you are going to add a URL mashup to the quick activity (QA) floorplan. This mashup will display the
car park location on a map, based on the location information entered.

Prerequisites
● You have completed the example: Building a Solution [page 93]
● The mashup has been created in the SAP cloud solution. For more information, see Mashups Quick Guide
[page 475].

Procedure
1. Add an element on the root level of the Car Park business object to record location information.
element CarParkLocation : LANGUAGEINDEPENDENT_Text;
2. Save and activate the business object.
3. Double-click the quick activity floorplan to open it in the UI designer.
4. Click the Update Metadata button to update the BO metadata.
5. Drag the CarParkLocation from the BO Browser / Data Model onto the Designer tab.
6. Change the label for the field to Car Park Location.
7. On the Controller tab, perform the following actions:
a. Add a new outport with the name URL_Mashup_OutPort and the following settings:
● PortType Package = /SAP_BYD_TF/Mashups/globalmashupsupporttypes
● PortType Reference = Address_Info
b. Bind the Address parameter to the CarParkLocation data field.
c. In the Property Explorer, select the QA floorplan from the drop-down list at the top.
d. Click the Anchor field under Extensibility.
The Anchor Modelling dialog box appears.
e. Click the plus sign to create a stable anchor for the floorplan.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 109
 f. In the Property Explorer, select the mashup outport from the drop-down list at the top.
g. Click the Anchor field under Extensibility.
The Anchor Modelling dialog box appears.
h. Click the plus sign to create a stable anchor for the floorplan.
i. In the Property Explorer, click the Referenced Anchor field under Extensibility.
The Anchor Modelling dialog box appears.
j. Click the plus sign to create a referenced anchor for the outport.
k. Click the three dots next to the XRep Path field.
l. In the Configured Anchors dialog box, click the anchor you created for the QA floorplan.

SAP Cloud Applications Studio – Version May 2018 (1805)

110 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 8. Save and activate.
9. Click the Designer tab.
10. In the Extensibility Explorer, select the mashup outport and click the Mashups Management button.
The Mashups Management dialog box appears, listing the available mashups.
11. Select the mashup you want to use and click Apply.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 111
 12. Save and activate.

Result
The mashup is available from the Web Services menu on the QA. When you click the mashup, the URL is opened with
the value entered into the Car Park Location field as an input parameter.

SAP Cloud Applications Studio – Version May 2018 (1805)

112 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
5.8.3.2 Configure the OWL to Auto-Refresh

In this example you are going to configure the car park object work list (OWL) to refresh automatically when a new
car park instance is saved on the quick activity floorplan (QAF).

Prerequisite
You have completed the example: Building a Solution [page 93]

Procedure
1. Open the object work list (OWL) in the UI designer.
2. On the Controller tab, create a new Inport with the name AutoRefresh_Inport.
3. In the Property Explorer, perform the following actions:
● set the property Events OnFire to the default EventHandler – this event handler executes the
query for the OWL
● enter the name AutoRefresh_LocalEvent in the field Navigation Local Event .
4. Save and activate.
5. Open the quick activity floorplan (QAF) in the UI designer.
6. On the Controller tab, create a new Outport with the name AutoRefresh_Outport.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 113
 7. In the Property Explorer, perform the following actions:
● set the property Behavior Broadcast to True.
● enter the name AutoRefresh_LocalEvent in the field Navigation Local Event .
8. On the Controller tab, edit the SaveHandler to include a new operation of type FireOutport below the existing
WindowAction operation.

Operations are executed from top to bottom, so you need to save the new business object instance
before running the default query.

9. Save and activate

Result
When you save a new car park instance on the QAF, then return to the OWL, the list of car parks is updated with the
car park that you created - you do not have to click Go to run the query again.

5.8.3.3 Calculate the Number of Available Car Parking Spaces

In this example you are going to add a field that automatically calculates the remaining car parking spaces available,
based on the total number of spaces and the number of spaces assigned to employees. You will use an action to
calculate the field value and you will call this action from a BeforeSave event on the root node. The result is displayed
as a column on the object work list.

Prerequisite
You have completed the example: Building a Solution [page 93]

Procedure
1. In the studio, open the Car Park business object.
2. In the root node, add an element of type IntegerValue with the name AvailableParkingSpaces.
element AvailableParkingSpaces : IntegerValue;
3. In the root node, declare an action called Update_AvailableParkingSpaces.
action Update_AvailableParkingSpaces;
4. Save and activate the business object.
5. Right-click the Car Park business object and select Create Script Files.
6. Create the Action-Update_AvailableParkingSpaces and also the BeforeSave event for the root node.
7. In the action script file, enter the code to calculate the number of available car parking spaces:
this.AvailableParkingSpaces = this.Number_of_ParkingSpaces-
this.ParkingSpace.Count();
8. Save and activate the action.
9. In the BeforeSave event, enter the code to call the Action-Update_AvailableParkingSpaces.
this.Update_AvailableParkingSpaces();

SAP Cloud Applications Studio – Version May 2018 (1805)

114 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 This will calculate the available car spaces whenever the Car Park BO is changed at root level and saved.
It will not run the script if a car space is added or removed. To ensure that the script is run whenever a
car space is added or removed, later in this procedure, you will edit both the AddRowHandler and the
RemoveRowHandler to call the Update_AvailableParkingSpaces action.

10. Save and activate the event.

11. Open the object work list in the UI designer.
12. On the Designer tab, add a column on the right of the table.
13. Drag the element Number_of_ParkingSpaces_Available from the BO Browser/Data Model onto the column
header.

14. Select not to use backend text when prompted.

15. Edit the Label for the column.
16. Save and activate the floorplan.
17. Open the QA floorplan in the UI designer.
18. On the Controller tab, select the AddRowHandler.
19. Add a new operation of type BO Action.
20. Select the Update_AvailableParkingSpaces action and click the Bind button.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 115
 21. Select the RemoveRowHandler.
22. Add a new operation of type BO Action before the WindowAction.
23. Select the Update_AvailableParkingSpaces action and click the Bind button.

SAP Cloud Applications Studio – Version May 2018 (1805)

116 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 24. Save and activate.

Result
The available parking spaces are now displayed for each car park. The number will be updated if you edit a car park
and change the total number of car spaces, add a new space, or delete a space. You have to click Go on the OWL to
re-run the query and display the current information.

5.8.3.4 Create a Fact Sheet for the Car Park

Overview
In this example you are going to create a fact sheet for a car park instance. The fact sheet (FS) provides a read-only
version of the information entered on the quick activity (QA) floorplan. The main steps in creating a fact sheet are
as follows:

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 117
 ● create the floorplan layout
● configure the floorplan to allow for object-based navigation from other floorplans to this floorplan:
○ add the fields OBN_NAV_KEY and NodeID to the data model
○ create the inport
○ create the event handler for the inport
● include the FS in the assigned objects of the work center view (WCV)

It is intended that the fact sheet will be accessed from a View button on the object work list (OWL). For more
information about creating the button and linking to the car park fact sheet, see here [page 123].

Prerequisites
● You have completed the example: Building a Solution [page 93]

Procedure
1. Right-click the CarPark business object and select Create Screens.
2. Select the fact sheet floorplan and click OK.
3. Double-click the fact sheet to open it in the UI designer.
4. Delete the column on the right.
5. Delete the fields Exldr, Exldr1 and Exldr2.
6. Delete the Edit button.
7. Delete the View All button.
8. Select the IdentificationRegion and edit the FloorplanTitle to include the Car Park ID as a variable.
9. Select the SectionGroup and set the property ShowHeader to false.
10. Select the SectionGroup and select the property Contents > Fields to open the Field Collection Editor and re-
order the fields.
11. Select each field and set the property DisplayType to StaticText.
12. Select each field and edit the Label property.
13. Add a flex layout row below the existing row.
14. From the Toolbox, drag-and-drop an AdvancedListPane into the new row.
15. Edit the property PaneHeader to read Car Spaces.
16. Add a column to the table.
17. Drag-and-drop the following fields from the BO Browser/Data Model onto the table columns:
● ParkingSpaceID
● ParkingSpace_AssignedEmployeeID
● GivenName
● FamilyName
18. Rename the column header labels:
● Parking Space ID
● Assigned Employee ID
● First Name
● Last Name

SAP Cloud Applications Studio – Version May 2018 (1805)

118 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 19. Set the DisplayType of the Assigned Employee ID column to Link, and set the other columns to StaticText.
20. Select the AdvancedListPane: ListPaneVariant and set the property UsePreviewPane to True.
21. Edit the property PaneHeader to read Details.
22. Drag-and-drop the following fields from the BO Browser/Data Model into the Details section:
● ParkingSpace_Level
● Vehicle_RegistrationNumber
● ParkingSpace_Disabled
● ParkingSpace_ElectricChargeStation
23. Rename the field labels:
● Parking Space Level
● Vehicle Registration Number
● Disabled Friendly
● Electric Recharge Station
24. Change the order the fields as desired.
25. Optional: On the DataModel tab, you can add a data structure element to contain the CarPark root node
elements. This makes it easier to view and organize the data model elements, but does not make any functional
difference.

You now have a fact sheet that looks similar to this:

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 119
 26. On the DataModel tab, perform the following actions:
a. Right-click the Root data field and select Add Data Field.
b. Right-click the new field, select Rename and enter the name OBN_NAV_KEY.
c. Right-click the Root data field and select Add Data Field.
d. Select the new data field and select the NodeID in the business object model, then click Bind.

SAP Cloud Applications Studio – Version May 2018 (1805)

120 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 27. On the Controller tab, perform the following actions to create the inport:
a. Right-click Inports and select Add Inport.
b. Under Inport Configuration, select the check box OBN Inport.
c. Check that the Namespace and BO Model fields are populated correctly.
d. In the field Select Operation, enter the name Open_CarPark_fact sheet. This name is used to
identify the inport.
e. Click the three dots next to the PortType Package field and select the port type package for the business
object. This is located in the folder <project name>_MAIN/SRC.
f. In the PortType Reference field, select To_CarPark_Edit.
g. Click the Add Parameter button.
h. Click the three dots in the new Parameter row.
i. In the Parameter Binding dialog box, select the field OBN_NAV_KEY and click OK.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 121
 j. In the Property Explorer, under Events, in the OnFire field select New Event Handler.
k. In the Configure Event Handler dialog box, perform the following actions:
a. Enter the name Open_CarPark_fact sheet_Handler.
b. click the Add Operation button.
c. Select BOOperation for the operation Type.
d. Select Read for the BO Operation Type.
e. Click the Add Parameter button.
f. For the new parameter row, select nodeId in the Type field.
g. Click the three dots next to the Bind field.
h. In the Parameter Binding dialog box, select the field OBN_NAV_KEY and click OK.
i. Click the three dots next to the Path field.
j. In the Parameter Binding dialog box, select the field NodeID and click OK.

SAP Cloud Applications Studio – Version May 2018 (1805)

122 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 28. Click Save and Activate.
29. In the Solution Explorer, double-click the work center view (WCV) to open it in the UI designer.
30. In the Property Explorer, under RBAMData click AssignedObjects.
31. In the Add Assigned Objects dialog box, click the Add button to create a new row.
32. In the new row, click the three dots next to the ComponentId field.
33. In the Select Component dialog box, navigate to your project and select the fact sheet then click OK.
34. Click Save and Activate.

5.8.3.5 Create an OBN to the Car Park Fact Sheet

Overview
In this example you are going to create an object-based navigation (OBN) link from the Car Park Manager object
work list (OWL) to the Car Park fact sheet. You have already configured the fact sheet with an inport that allows for
OBN, now you are going to create an OBN outport to connect to this inport.

Prerequisites
● You have completed the example: Building a Solution [page 93].
● You have completed the example: Create a Fact Sheet for the Car Park [page 117].

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 123
Procedure
1. Open the Car Park OWL in the UI designer.
2. On the Controller tab, right-click OBN Navigation and select Add OBN. An outport is also created when you
create the OBN.
3. Right-click the OBN and rename it to OBN_to_CarPark_fact sheet.
4. Check that the namespace and BO model are correct for your Car Park solution.
5. Click the CarPark node in the BO model and select Open_CarPark_fact sheet in the field Select Operation. The
PortType Package and PortType Reference fields are populated automatically.

SAP Cloud Applications Studio – Version May 2018 (1805)

124 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 6. Right-click the outport that was created when you created the OBN and rename it to
Outport_to_CarPark_fact sheet.
You will notice that the PortType Package and PortType Reference fields are pre-populated.
7. Click the Add Parameter button.
8. In the parameter row, click the three dots next to ParameterBinding.
9. In the Parameter Binding dialog box, select the NodeID data field within the data list and click OK.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 125
 10. Right-click EventHandlers and select Add Event Handler.
11. Right-click the new handler and rename it to OBN_to_CarPark_fact sheet_Handler.
12. Click the Add Operation button.
13. Select the Type as FireOutport and select the Outport as Outport_to_CarPark_fact sheet.

14. Click the Designer tab and select the ListPaneToolbar.

15. In the Property Explorer select to configure the Toolbar.
16. In the Configure Toolbar dialog box, move the View button from Available to Current and click OK.
17. Select the View button and in the Property Explorer set the Events > OnClick field to OBN_to_CarPark_fact
sheet_Handler.

SAP Cloud Applications Studio – Version May 2018 (1805)

126 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 18. Click Save and Activate.

5.8.3.6 Create an OBN to the Employee Fact Sheet

Overview
In this example you are going to create an object-based navigation (OBN) link from the Employee ID field on the Car
Park fact sheet to the Employee's fact sheet.

Prerequisites
● You have completed the example: Building a Solution [page 93].
● You have completed the example: Create a Fact Sheet for the Car Park [page 117].
● You have completed the example: Create an OBN to the Car Park Fact Sheet [page 123].

Procedure
1. Open the Car Park fact sheet in the UI designer.
2. On the DataModel tab, add a new data field to the DataList.
3. Select the new data field, select the BO element SAP_ToEmployee and click the Bind button.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 127
 4. On the Controller tab, right-click OBN Navigation and select Add OBN. An outport is also created when you
create the OBN.
5. Right-click the OBN and rename it to OBN_to_Employee_Factsheet.
6. Set the namespace to http://sap.com/xi/AP/FO/BusinessPartner/Global.
7. Select Employee for the BO model.
8. Select Open in the field Select Operation. The PortType Package and PortType Reference fields are populated
automatically.

SAP Cloud Applications Studio – Version May 2018 (1805)

128 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 9. Right-click the outport that was created when you created the OBN and rename it to
Outport_to_Employee_Factsheet.
You will notice that the PortType Package and PortType Reference fields are pre-populated.
10. In the KeyList row, click the three dots next to ParameterBinding.
11. In the Parameter Binding dialog box, select the DataList and click OK.
12. In the Key row, click the three dots next to ParameterBinding.
13. In the Parameter Binding dialog box, select the SAP_ToEmployee data field within the data list and click OK.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 129
 14.

15. Right-click EventHandlers and select Add Event Handler.

16. Right-click the new handler and rename it to Open_Employee_Factsheet_Handler.
17. Click the Add Operation button.
18. Select the Type as FireOutport and select the Outport as Outport_to_Employee_Factsheet.

19. Click the Designer tab and select the Assigned Employee ID column.
20. In the Property Explorer set the Events > OnClick field to Open_Employee_Factsheet_Handler.

SAP Cloud Applications Studio – Version May 2018 (1805)

130 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 21. Click Save and Activate.

5.8.3.7 Extend the Employee Business Object

Overview
In this exercise you will extend the Employee business object and then enhance the Employee fact sheet to display
the car parking space assigned to the employee. This involves the following steps:
● create business object extension for the Employee business object
● add an extension field to the business object extension
● enhance the Employee fact sheet
● add the extension field to the fact sheet
● edit the AfterModify script to update the extension field

Prerequisites
● You have completed the example: Building a Solution [page 93]

Procedure
1. In the Solution Explorer, right-click your project and select Add New Item .
2. Select the Business Object Extension template, enter the name Employee_BO_Extension, and click Add.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 131
 3. In the Business Object Selection dialog box, select the namespace AP.FO.BusinessPartner.Global and
the business object Employee.
4. Open the business object extension and add the following code to the Common node:
node Common {

[Tooltip ("If the employee has been assigned a car parking space, the ID is
displayed here.")]
[Label ("Car Parking Space")]
element Assigned_Car_Parking_Space_ID : Text;

}
5. Save and activate the XBO.
6. In the Solution Explorer, right-click the Employee_BO_Extension and select Enhance Screen.
7. Select the floorplan employeecontactdataqafeco and click OK.
The floorplan is opened in the UI designer.
8. On the Designer tab, select the Basic Information section group.
9. In the Extensibility Explorer, click the Add Extension Field to Section Group button.
10. In the Add Extension Field dialog box, select the extension field to add to the floorplan and click Apply.
Remember to select the Is Display Only check box so that the field will appear as static text.
11. In the Solution Explorer, open the Event-AfterModify script for the Parking Space node.
12. Add the following code at the end of the script file, just before the closing bracket:
foreach (var common in employee.Common)
{common.Assigned_Car_Parking_Space_ID = this.ParkingSpaceID;}
When a car space is modified, this script will update the extension field
(Assigned_Car_Parking_Space_ID) with the ID of the Parking Space.
13. Save and activate the script file.

Result
For employee's that have an assigned car parking space, the ID of the parking space is displayed on the employee's
fact sheet.

SAP Cloud Applications Studio – Version May 2018 (1805)

132 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
 Because the value gets assigned in the AfterModify script for the Parking Space node, it will not affect existing
entries. You need to create a new entry in the car park to see the result on the Employee fact sheet.

5.8.3.8 Validate On Save

Overview
In this example you are going to create a validation script that will check if there are any car spaces available. The
script checks if the number of parking spaces assigned is greater than the total number of parking spaces. If there
are no available spaces, an error message is displayed and you will not be able to save your changes to the car park.

Prerequisites
● You have completed the example: Building a Solution [page 93]

Procedure
1. Edit the car park business object to declare the message and specify the message text.
a. Declare the message after the business object name:
businessobject CarPark_Manager raises Message_Car_Park_Full {
b. Enter the message text at the root node level:

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 133
 message Message_Car_Park_Full text "The car park is full - no spaces
available";
2. Save and activate.
3. Right-click the business object and select Create Script Files.
4. Create the Validation: On Save script file for the root node.
5. In the Validation: On Save script file, enter the following code:
if (this.ParkingSpace.Count() > this.Number_of_ParkingSpaces)
{
raise Message_Car_Park_Full.Create("E");
return false;
}
return true;
6. Save and activate.

Result
When you edit a car park and create more car spaces than the total number of car spaces, an error message is
displayed and you will not be able to save your changes.

SAP Cloud Applications Studio – Version May 2018 (1805)

134 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
Error message

5.9 Using the Localization Toolkit (SAP Business ByDesign)

Overview
The localization toolkit is a set of development tools and instructions that enable SAP partners to extend and adapt
the capabilities of the SAP Business ByDesign solution to provide a locally-compliant solution for customers in
countries where a fully-localized SAP country version is not available.
The toolkit enables customers and subsidiaries to implement business processes for a number of localization topics
in these countries, without the need for the implementation of a fully-localized country version. In this way, it is only
necessary to implement the legal and local regulations relevant particular to the business processes required by the
customer or subsidiary rather than all country requirements.
The toolkit comprises tools integrated in the SAP Business ByDesign solution, implemented using the SAP Cloud
Applications Studio, or available as extensibility features such as extension fields. Using the toolkit, you can extend
and adapt existing capabilities, for example, you can implement additional business configuration, such as
accounting principles and chart of accounts for a new country, create tax content for non-localized countries, extend
existing fields, create new reports, or implement different form templates for output documents.

SAP Cloud Applications Studio – Version May 2018 (1805)

Getting Started P U B L I C • © 2018 SAP SE. All rights reserved. 135
Prerequisites
You have downloaded the SAP Cloud Applications Studio from the Download Center in the SAP Service Marketplace
. For information about the installation steps, the latest builds, and the SAP Service Marketplace, see Installation
Corner .

Accessing the Toolkit

The following topics are covered in the localization toolkit. You can access detailed information about these topics
in the Business Center at https://www.sme.sap.com under SAP Business ByDesign Community Wiki Info
Exchange Country Information Customer-Specific Localization Localization Toolkit
● General Ledger
● Tax
● Tax Reporting
● Fixed Assets
● Inventory
● Accounts Payable/Accounts Receivable
● Legal Reporting/Fiscal Closing
● Invoicing
● Payments
● Internationalization
● Languages
● Extensibility Features

SAP Cloud Applications Studio – Version May 2018 (1805)

136 © 2018 SAP SE. All rights reserved. • P U B L I C Getting Started
6 Administration and Lifecycle Management

6.1 Overview of Administration and Lifecycle Management

Administration and Lifecycle Management encompasses the following reference material:

Get Informed About Administration and Lifecycle Management of Customer-Specific Solutions

● Administration Quick Guide [page 151] ● Developing on Your Development Tenant

The Administration toolbar provides access to a ○ Lifecycle Management on Your Development
number of administrative tasks, such as creating a Tenant [page 147]
new solution, deleting a solution, and managing user You can develop a customer-specific solution on
sessions. your development tenant and after having
● Implementation Manager Quick Guide [page 153] tested, assembled, and downloaded the solution,
You use the Implementation Manager to manage the you can upload it to the customer's tenant.
lifecycle of customer-specific solutions. ○ Switch a Customer Assignment [page 151]
● Lifecycle Management [page 138] If you are developing customer-specific
The studio supports the full end-to-end lifecycle solutions on your development tenant, you can
management of customer-specific solutions. This create solutions for more than one customer. For
includes developing, testing, and deploying your example, if you are working on a solution for
solution, as well as creating patches to deliver updates customer A, you can save your solution and then
to your customer. switch to work on the solution for customer B. For
this, you need to switch the customer
● Developing on a Customer's Tenant [page 143]
assignment. Afterwards, in the My Solutions tool
You can develop a customer-specific solution on the
window in the studio, only the solutions of
customer's test tenant. The finalized solution is then
customer B are listed and you can create new
uploaded and activated on the customer's production
solutions only for this specific customer.
tenant.
● Quality Criteria [page 139]
Customer-specific solutions for the SAP cloud
solution are installed in a multi-tenant environment.
The solution provider needs to ensure that all solutions
are of the highest quality and have the lowest possible
Total Cost of Ownership (TCO). SAP requests you to
conform to the criteria described in this document in
order to ensure the quality of your solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 137
Get Informed About Solution Templates, Patches, Maintenance Mode, and Upgrade Information

● Solution Templates [page 160] ● Maintenance Mode [page 170]

With a solution template you can organize common A customer-specific solution is in maintenance mode
development content that you want to reuse for if it has been assembled and downloaded, that is, the
customer-specific solutions. Solution templates solution status is Assembled. You can make changes
enable you to rapidly start the development of to the solution in a patch; however, you can only make
customer-specific solutions, for example, for a restricted changes to certain content types. These
specific industry change and delete restrictions ensure that you do not
● Patches [page 166] make changes to a solution that could lead to loss of
A patch is needed if you want to make changes or data or create inconsistencies or errors on a
corrections to a customer-specific solution after it has customer's production tenant.
been assembled. The customer-specific solution is ● Upgrade Information [page 16]
then in maintenance mode and you can only make Upgrade information is relevant if your customer's
restricted changes for certain content types. system is upgraded to a new release. The upgrade is
maintained by SAP to ensure high quality upgrade of
the customer's production tenant. The upgrade does
not have any impact on your customer-specific
solution. However, be aware of the downtime period
during the upgrade and follow the rules listed in this
document.

You can refer to SAP Cloud Applications Studio Deployment & Landscape Basics to better understand the
basics of the landscape and the deployment of solution using SAP Cloud Applications Studio.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

6.2 Lifecycle Management of Customer-Specific Solutions

Overview
The studio supports the full end-to-end lifecycle management of customer-specific solutions. This includes
developing, testing, and deploying your solution as well as creating patches to deliver updates to your customer
There are different scenarios in which you may want to develop a customer-specific solution:
● Developing on a Customer's Test Tenant
You can develop a customer-specific solution on the customer's test tenant. The finalized solution is then
uploaded and activated on the customer's production tenant. For more information, see Lifecycle
Management on a Test Tenant [page 143].
● Developing on Your Development Tenant

SAP Cloud Applications Studio – Version May 2018 (1805)

138 © 2018 SAP SE. All rights reserved. • P U B L I C Administration and Lifecycle Management
 You develop your customer-specific solution on your development tenant in your company or organization.
On this tenant you can develop solutions for different customers. The finalized solution is then downloaded
from your development tenant and uploaded and activated on the customer's production tenant. For more
information, see Lifecycle Management on Your Development Tenant [page 147].

The following guidelines and restrictions apply to the development of customer-specific solutions in general:
● We recommend that you develop only one solution per customer.
● The tenant where you develop your solution and the tenant where you upload your solution must be
on the same release.

Tenant-Specific Activities in the Studio

The following table shows which activities you can perform on which tenant type.

Development Customer's
Activity Tenant Test Tenant For information, see ...

Create Solution Yes Yes Create a Customer-Specific

Solution [page 165]

Create Copy of Solution Yes Yes Implementation Manager Quick

Guide [page 153]

Create Patch Created in same Created in Patches for Customer-Specific

namespace separate Solutions [page 166]
namespace

Create Solution Template Yes Yes Solution Templates Quick Guide

[page 160]

Create Copy of Template Yes Yes Solution Templates Quick Guide

[page 160]

Switch Customer Yes No Switch a Customer Assignment

[page 151]

Create and Maintain Solution With BC Sets Using Yes No Create a BC Set Using an SAP BCO
SAP BCOs [page 332]

6.3 Quality Criteria for Customer-Specific Solutions

Customer-specific solutions for the SAP cloud solution are installed in a multi-tenant environment. The solution
provider needs to ensure that all solutions are of the highest quality and have the lowest possible Total Cost of
Ownership (TCO).
SAP requests you to conform to the criteria described in this document in order to ensure the quality of your solution.
Functional Correctness
You must ensure that your solution has been tested and documentation is provided for all test cases.

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 139
Performance
You must ensure that your solution does not adversely impact the performance of the SAP cloud solution.

Response Time
Where the solution extends an existing user interface, a performance degradation of maximum 10% is acceptable
even if the response time exceeds the target value.

Simple Transactions
● On average end-to-end < 1 s
● 95% end-to-end < 1.5 s

Examples of simple transactions are: Object Work Lists, purchase request, leave request.

Complex Transactions
The end-user response time for complex transactions must be:
● On average end-to-end < 1.7 s
● 95% end-to-end < 2.5 s

Examples of complex transactions are: integrated transactions like order, but also simple analytical content and fact
sheets.

Complex Tasks
To enhance the end-user experience for complex tasks, the following must be true:
● Progress indicator available
● Background processing possible

Examples of complex tasks are: analytical content, planning, multilevel bill of material explosion.

Security
You must implement measures to ensure the security of your solution. Furthermore, your solution must not impact
the security of the SAP cloud solution.

Code Scan
Security code scans are an important measure to minimize security risks. For customer-specific solutions, no code
scans are performed by default. SAP reserves the right to perform code scans of customer-specific solutions in order
to detect possible security risks.
If your solution functionality runs on an external system, you must conduct a security code scan or assign a third
party to conduct a security code scan of the external component. SAP reserves the right to request proof of a
successful code scan.
As there is no default security code scan for customer-specific solutions, you must take action to avoid the top 10
security risks as defined by the Open Web Application Security Project:
● http://www.owasp.org/index.php/Category:OWASP_Top_Ten_Project

SAP Cloud Applications Studio – Version May 2018 (1805)

140 © 2018 SAP SE. All rights reserved. • P U B L I C Administration and Lifecycle Management
Preventative Measures
You must implement measures to prevent security attacks. You can find more information on preventing common
security attacks at the following links:
● Cross-site scripting attacks (http://www.owasp.org/index.php/Cross-site_Scripting_(XSS) )
● SQL injection attacks (http://www.owasp.org/index.php/SQL_Injection )
● Directory traversal attacks (http://www.owasp.org/index.php/Path_Traversal )

Useful guidelines and hints on secure programming can be found in the SAP NetWeaver Developer's Guide:
http://help.sap.com/saphelp_nw2004s/helpdata/en/58/4d767ed850443c891ad27208789f56/
frameset.htm

Backdoors
The solution must be free of intentionally hidden and non-documented features that circumvent security measures
(backdoors).

Vulnerabilities
The solution must prevent typical vulnerabilities such as:
● Missing input validation
● Execution of commands that include not-validated user input
● Parameter tampering
● Cross-site request forgery
● Information leaks (for example, in error messages or hidden HTML fields)

Information on Web-application security can be found here:

● http://www.owasp.org/index.php/OWASP_Top_Ten_Project
● http://cwe.mitre.org/top25/index.html

Documentation
Documentation must be provided to describe the following:
● Authorization and roles
● Communication security (including port information)
● User management and authentication
● Secure configuration of the service
● Accessing the security logs
● Configuring authentication policies (for example, behavior after a defined number of failed login attempts)
● Restricting access to specific IP addresses

You must provide customers with updates to the security documentation (for example, security bulletins) when
applicable.

Authorizations
The solution must provide the capability to separate the authorizations (roles) for different types of users (that is,
administrative and non-administrative users). Users must only have the permissions that are required for their work

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 141
(segregation of duties). The authorization concept must be documented (that is, delivered roles per business and
technical user). Search results may contain sensitive data and therefore must be filtered based on the authorization
level of the user.

Data Transfer
The transfer of data to other services or service providers must be configurable and documented.

Testing
Details must be provided of any security-related test activities performed.

Security Settings
Security settings and recommendations must be documented and available to the customer.

Supportability
You must provide for the maintenance and support of your partner solution throughout its entire product lifecycle.

Maintenance and Support – Customer

Customer Service Level Agreement (SLA)
As you are fully responsible for the solution, you have a support contract with your customer. You must describe
any Customer SLA or Customer Support Agreement that exists for your partner solution.
Maintenance
Your solution must have a defined release and maintenance strategy and process, which must be linked with the
SAP interface, product, and maintenance process for the SAP cloud solution. This is required as SAP reserves the
right to deprecate entities or functions in the SAP cloud solution with a new release, which might have an impact on
your solution and might require that you need to update your solution.

Maintenance and Support – SAP

Support Process
Support processes/interaction between your support department and SAP Support must be aligned and
documented.
Interface Deprecation
You must be able to react, properly and in time, to the possible deprecation of interfaces from SAP’s public solution
model (PSM).
Interfaces of the PSM can be deprecated by SAP. Generally, SAP provides alternative interfaces that continue to
offer the required business functionality.
SAP promises that deprecated interfaces remain fully functional within two releases (approximately one year).
During this period of time, you need to react by removing usage of the deprecated interfaces from your partner
solution.
Public Solution Model Access
You must only access SAP interfaces according to the PSM.
Switching the Solution On/Off
The SAP cloud solution must remain fully functional if a customer-specific solution is switched off. If your solution
jeopardizes the standard functionality of the SAP cloud solution, SAP reserves the right to switch off your solution.
If your solution is switched on again, it then must be able to resynchronize to the existing data in the system.

SAP Cloud Applications Studio – Version May 2018 (1805)

142 © 2018 SAP SE. All rights reserved. • P U B L I C Administration and Lifecycle Management
6.4 Developing on a Customer's Tenant

6.4.1 Lifecycle Management for Customer-Specific Solutions on a

Customer's Test Tenant

Overview
If the customer has already gone live with the SAP solution, you can develop and test your customer-specific solution
on the customer's test tenant. In this case, development is done on the test tenant and the finalized solution is
uploaded and activated on the customer's production tenant. This document describes the after go live scenario.
For information about how to request a test system, see the documentation of the SAP Solution.

The following guideline applies if you work on a test tenant:

● If the test tenant is a copy of the customer's production tenant, on which your solution is already
activated, you can only create a patch for this solution. For more information, see Create a Patch on a
Customer's Test Tenant [page 145].

The following graphic gives a schematic overview of the lifecycle management process. The process is explained in
detail below.

Prerequisites
In the SAP cloud solution, your customer has set up the following users for you:
● A business user for testing purposes in the SAP cloud solution on the test tenant.

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 143
 ● Users with the roles Studio Administrator and Developer in any tenants in which you are going to develop and
deploy the solution. If you both develop and implement the solution, you only need a user with the Studio
Administrator role. For more information, see User Setup Quick Guide [page 31] and User Roles
[page 30].

Process Flow
1. In the studio, you log on to the customer's test tenant and create a solution (Studio Administrator).
2. You develop your solution including the necessary business configuration content (Developer).

You can create BC Sets using SAP BCOs only on your development tenant.

3. You test the solution (Business User).

You can test specific solution content in the studio using the preview function.
You can also test your solution in the SAP cloud solution for the tenant on which you created the solution. As
a prerequisite, you must scope your solution. You have the following options:
● In the studio, you trigger deployment of your business configuration content (Studio Administrator).

If you have defined BAC elements for your solution, a dialog box opens when you use the Deploy
Business Configuration function. You have to select one of the following options:
● Deploy all business configuration content for your solution
● Deploy only the business configuration content for your solution that is assigned to the
business options you have selected in the business adaptation catalog

This allows you to test both partial and complete activation of your business configuration
content in the development environment.

You then log on to the SAP cloud solution with your business user and perform your tests.
● In the SAP cloud solution, you scope your solution manually (Business User).
To do this, you log on to the SAP cloud solution with your business user. In the Business
Configuration work center, you perform scoping for the business option that you created for your
solution and for the required standard functions of the SAP cloud solution.
You then perform your tests.
4. You assemble and download the solution (Studio Administrator).
After you have performed your tests successfully, in the studio, you log on to the test tenant to assemble and
download your solution. For more information, see the Implementation Manager Quick Guide [page 153].

If you are working on a preproduction tenant and you have used the Deploy Business Configuration
function in the previous step, the system now removes the business configuration content from the
SAP cloud solution.

5. You upload the solution to the production tenant (Studio Administrator).

If you are developing your solution on the customer's preproduction tenant, then you do not need to
upload the solution. Instead, after assembling the solution, go to step 7.

In the studio, you log on to the production tenant and upload the solution. .
6. You activate the solution on the production tenant (Studio Administrator).
After the solution has been successfully uploaded, you activate it on the customer's production tenant.

SAP Cloud Applications Studio – Version May 2018 (1805)

144 © 2018 SAP SE. All rights reserved. • P U B L I C Administration and Lifecycle Management
 Before activating the solution, we recommend that you inform the customer of any functions that may
be affected by the update. For example, if the administrator at the customer has adapted an analytical
report, this may be affected by any changes you have made to the same report.

7. The customer activates your solution by selecting the relevant business option in Scoping.

Follow-On Activities
After the solution has been activated on the customer's production tenant, you can only make changes or corrections
to it by creating a patch. A patch follows the same lifecycle as the original solution, with the exception that the business
option does not need to be selected again.

6.4.2 Create a Patch on a Customer's Test Tenant

Overview
If you need to make changes or corrections to a customer-specific solution after you have assembled it, you can
create a patch.
For more information, see Patches [page 166].

The following guidelines and restrictions apply:

● Any data created for the original solution in the SAP cloud solution and any scoping decisions and fine-
tuning settings are not copied to the patch solution. For testing purposes, you must therefore scope
the patch solution and create new test data.
● If your original solution contains a Web service, this Web service will have a different namespace in the
patch solution. You must therefore adapt the settings of your client testing tool to test the Web service
in your patch solution.

Prerequisites
In the studio, you have logged on to the customer's test tenant where you created the original solution and you have
opened this solution.

Only users with the Studio Administrator role can create patches.

Procedure
1. On the Implementation Manager toolbar, click the Create Patch button.
The system creates a patch solution and copies all files in your solution to a new namespace within the patch
solution. The namespace is generated automatically and cannot be changed.
The patch solution is created in the background and this process may take some time. Click Refresh in the
Implementation Manager tool window to update the solution status.

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 145
 2. In the Implementation Manager, open the patch solution by clicking the Open button next to the Patch
Solution field.

You can always access the patch solution from the original solution by opening the Implementation
Manager and, on the Current Version tab, clicking the Open button next to the Patch Solution field.
You can also navigate to the original solution from the patch solution in the same way.

3. In the patch solution, make your changes. Then activate the patch solution.
4. You can test specific solution content in the studio using the preview function. To test your patch solution in
the SAP cloud solution, you have to enable the solution on the test tenant as follows:
a. In the Implementation Manager, click the Enable button next to the Solution Enablement for Business
User in Cloud Solution field.
The “Disabled” changes to an “Enabled” and the patch solution is enabled on the test tenant instead
of the original solution. For more information, see Enable and Disable Your Solution in the SAP Cloud
Solution [page 167].

If a BC change project is open on the tenant before you enable the patch solution on the test
tenant, you will not be able to merge the change project unless you disable the patch solution.
For more information, see What You Need to Consider When a Change Project Is on the Same
Test Tenant [page 146].

b. In the SAP cloud solution, log on to the test tenant with your business user.
You will be able to see your patch solution in place of the original solution.
c. Complete your testing.
5. On the Implementation Manager toolbar, click the Assemble and Download button.
The system assembles the patch using the namespace of the original solution and downloads it to a .zip file.
This allows you to copy your corrections back to the original solution.
6. In the studio, log on to the production tenant on which the original solution is active, and click the Upload
button on the Implementation Manager toolbar. Select the .zip file containing the patch.
The system uploads the .zip file with your corrections and checks for any compatibility issues. The solution
has the status In Deployment and the solution version number is updated.
7. In the Implementation Manager, select the solution and click Activate.

Before activating the solution, we recommend that you inform the customer of any functions that may
be affected by the update.

6.4.3 What You Need to Consider When a Change Project Is on the

Same Test Tenant

If you are developing customer-specific solutions on your customer's test tenant and your customer uses this tenant
for change projects at the same time, both of you need to consider the following information. Otherwise your
customer won't be able to merge the change project to the production tenant.
This information is not relevant when your customer has requested a separate test tenant that is only used for the
change project.

SAP Cloud Applications Studio – Version May 2018 (1805)

146 © 2018 SAP SE. All rights reserved. • P U B L I C Administration and Lifecycle Management
 As a general rule, the solutions on both tenants need to have the same version when the change project is
merged to the customer’s production tenant. Another rule is that a change project cannot be merged if a
solution template is being developed on the customer’s test tenant or has been uploaded to it. In such a case,
you must disable the solution template on the test tenant before the change project is merged.

Check this table to find out what needs to be done before the change project can be merged to the production tenant.
Answer the following questions and make a decision:
● Did a solution exist on the production tenant before the change project was created?
● Do you intend to create a solution or patch solution on the test tenant after the change project has been
created?

Did a solution exist on the Will you create a solution on

PRODUCTION tenant? the TEST tenant? What do you need to do?

No, there was no solution. Yes, I'll create a solution. Before the change project can be merged to the production
tenant, you need to do one of the following:
● Complete your solution, assemble and download it,
and upload the solution to the production tenant.
● If you don't want to upload the solution to the
production tenant, disable it for the business user in
the test tenant. For more information, see Enable or
Disable Your Solution in the SAP Cloud Solution
[page 167].

Yes, a solution existed. Yes, I'll create a patch Before the change project can be merged to the production
solution. I'll also enable it for tenant, you need to do the following:
the business user to allow the ● Disable the patch solution for the business user in the
patch to be tested. test tenant.
● Make sure that the original solution is enabled.

For more information, see Enable or Disable Your Solution in

the SAP Cloud Solution [page 167].

6.5 Developing on Your Development Tenant

6.5.1 Lifecycle Management of Customer-Specific Solutions on Your

Development Tenant

Overview
You can develop a customer-specific solution on your development tenant and after having tested, assembled, and
downloaded the solution, you can upload it to the customer's tenant.
The following graphic gives a schematic overview of the lifecycle management process. The process is explained in
detail below.

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 147
Prerequisites
● In the SAP cloud solution, you have set up the following users:
○ Users with the roles Studio Administrator and Developer on the tenant on which you want to develop
and assemble the solution. For more information, see User Setup Quick Guide [page 31] and User Roles
[page 30].
○ User with the Studio Administrator role on any tenants to which you want to upload the solution, for
example, the customer's production tenant.
○ A business user for testing purposes in the SAP cloud solution on your development tenant.
● In the studio, you are logged on to your development tenant.

Process Flow
1. In the studio, you check the current customer assignment and make sure that the ID of the customer for
whom you want to create and develop the solution is displayed (Studio Administrator).
For more information, see Switch a Customer Assignment [page 151].
2. You create a solution (Studio Administrator).
3. You develop your solution including the necessary business configuration content (Developer).
4. You test the solution (Business User).
You can test specific solution content in the studio using the preview function.
You can also test your solution in the SAP cloud solution for the tenant on which you created the solution. As
a prerequisite, you must scope your solution. You have the following options:
● In the studio, you trigger deployment of your business configuration content (Studio Administrator).

SAP Cloud Applications Studio – Version May 2018 (1805)

148 © 2018 SAP SE. All rights reserved. • P U B L I C Administration and Lifecycle Management
 If you have defined BAC elements for your solution, a dialog box opens when you use the Deploy
Business Configuration function. You have to select one of the following options:
● Deploy all business configuration content for your solution
● Deploy only the business configuration content for your solution that is assigned to the
business options you have selected in the business adaptation catalog

This allows you to test both partial and complete activation of your business configuration
content in the development environment.

You then log on to the SAP cloud solution with your business user and perform your tests.
● In the SAP cloud solution, you scope your solution manually (Business User).
To do this, you log on to the SAP cloud solution with your business user. In the Business
Configuration work center, you perform scoping for the business option that you created for your
solution and for the required standard functions of the SAP cloud solution.
You then perform your tests.
5. You assemble and download the solution (Studio Administrator).
For more information, see the Implementation Manager Quick Guide [page 153].
6. After you have performed a tests successfully, you log on to the customer's production tenant in the studio
to upload the solution. You activate the solution on the production tenant (Studio Administrator).

Before activating the solution, we recommend that you inform the customer of any functions that may
be affected by the update. For example, if the administrator at the customer has adapted an analytical
report, this may be affected by any changes you have made to the same report.

7. In the SAP cloud solution, the customer activates a solution by selecting the relevant business option in
scoping.

Follow-On Activities
After a solution has been activated on the customer's tenant, you can only make changes or corrections to it by
creating a patch. A patch follows the same lifecycle as the original solution, with the exception that the business
option does not need to be selected again. For more information, see Create a Patch on Your Development Tenant
[page 149].

6.5.2 Create a Patch on Your Development Tenant

Overview
If you need to make changes or corrections to a customer-specific solution after you have assembled it, you can
create a patch.
When you create a patch of a solution on your development tenant, the patch is created in the same solution and
namespace but with a different version number. For more information, see Patches [page 166].

Prerequisites
In the studio, you have logged on to your development tenant where you created the original solution and you have
opened this solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 149
 Only users with the Studio Administrator role can create patches.

Procedure
1. On the Implementation Manager toolbar, click the Create Patch button.
The system creates a patch in the same solution and sets the solution status to In Development. The version
number of the solution is updated to the next higher number.
2. Your can now implement the required changes.
When you have finished making your changes, you can activate and then test your solution.
3. In the Solution Explorer, right-click your solution and choose Activate.
4. To test your solution, you can do one of the following:
● In the studio, trigger deployment of your business configuration content. To do this, in the Solution
Explorer, right-click the Business Configuration node in your solution and select Deploy Business
Configuration.

If you have defined BAC elements for your solution, a dialog box opens when you use the Deploy
Business Configuration function. You have to select one of the following options:
● Deploy all business configuration content for your solution
● Deploy only the business configuration content for your solution that is assigned to the
business options you have selected in the business adaptation catalog

This allows you to test both partial and complete activation of your business configuration
content in the development environment.

You then you log on to the SAP cloud solution with your business user and perform your tests.
● In the SAP cloud solution, you scope your solution manually.
To do this, you log on to the SAP cloud solution with your business user. In the Business
Configuration work center, you perform scoping for the business option you created for your solution
and for the required standard functions of the SAP cloud solution.
You then perform your tests.

When you have finished testing, you can download your solution and then upload it to the customer's tenant.
5. In the studio, in the Solution Explorer, right-click the project of your solution and select Check In All Files.
6. On the Implementation Manager toolbar, click the Assemble and Download button.
The system assembles the patch and downloads it to a .zip file.
7. Log off from your development tenant and then log on to the customer's tenant to which you have uploaded
the patch.
8. In the Implementation Manager, click the Upload button. Select the .zip file containing the patch.
The system uploads the .zip file with your corrections and checks for any compatibility issues.
9. In the Implementation Manager, click the Activate button.
The patch is activated in the cloud solution from SAP.

SAP Cloud Applications Studio – Version May 2018 (1805)

150 © 2018 SAP SE. All rights reserved. • P U B L I C Administration and Lifecycle Management
6.5.3 Switch a Customer Assignment

Overview
If you are developing customer-specific solutions on your development tenant, you can create solutions for more
than one customer. For example, if you are working on a solution for customer A, you can save your solution and
then switch to work on the solution for customer B. For this, you need to switch the customer assignment. Afterwards,
in the My Solutions tool window in the studio, only the solutions of customer B are listed and you can create new
solutions only for this specific customer.

Prerequisites
In the studio, you are logged on to your development tenant.

If your are logged on to your development tenant with a user that has the Developer role, you can only switch
a customer assignment. However, if you want to create a new customer assignment, you need to log on with
a user that has the Studio Administrator role.

Procedure
1. Choose Administration Switch Customer .
2. In the Switch Customer dialog box, check the details of the current customer assignment. Each solution that
you create, will be assigned to this customer. If you want to switch the assignment, you can do one of the
following:
● To switch to an existing customer assignment, select a customer from the list of existing customers.
● To create a new customer assignment, click Create Customer.
a. In the Create Customer dialog box, enter a customer name and the customer ID that SAP has
provided to the customer.
b. Click OK.
c. In the Switch Customer dialog box, choose this new customer from the list.
3. In the Switch Customer dialog box, click OK.
The system logs off and you need to log on again to your development tenant. In the My Solutions window,
only the solutions of the current customer are listed. If you have not yet created any solutions for this
customer, the My Solutions window is empty.

6.6 Administration

6.6.1 Administration Quick Guide

Users with the Studio Administrator role can use the Administration toolbar to access a number of administrative
tasks, such as creating and deleting customer-specific solutions or solution templates and managing user sessions.

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 151
 If the Administration toolbar is not visible in the studio, you can access it by clicking View Toolbars
Administration .

You can also use the functions for the studio administrator in the Administration menu.

Business and Technical Background

Lifecycle Management of Customer-Specific Solutions

The studio supports the full end-to-end lifecycle management of customer-specific solutions. This includes
developing, testing, and deploying your solution as well as creating patches to deliver updates to your customer
For more information, see Lifecycle Management of Customer-Specific Solutions [page 138].

Solution Templates
You can create templates containing reusable items and upload these items to customer-specific solutions.
For more information, see Solution Templates [page 162] and Solution Templates Quick Guide [page 160].

Patches
If you need to make changes or corrections to a customer-specific solution after you have assembled it, you can
create a patch.
For more information, see Patches [page 166].

Maintenance Mode
A customer-specific solution is in maintenance mode, if it has been assembled and downloaded; the solution status
then is Assembled. You can make changes to the solution in a patch; however, you can only make restricted changes
to certain content types. These change and delete restrictions ensure that you do not make changes to a solution
that could lead to loss of data or create inconsistencies or errors on a customer's production tenant.
For more information, see Maintenance Mode [page 170].

Tasks

Create a Solution
You can design and develop customer-specific solutions to enhance the SAP standard cloud solution for a specific
customer. In the studio, you can create a solution in which all items that you develop or changes that you make to
existing entities are stored.
For more information, see Create a Customer-Specific Solution [page 165].

Create a Solution Template

You can create templates containing reusable items and upload these items to customer-specific solutions.
For more information, see here [page 164].

Create a Patch
If you need to make changes or corrections to a customer-specific solution after you have assembled it, you can
create a patch. Depending on the tenant on which you are working, the process of creating a patch is different:
● Create a Patch on a Customer's Tenant [page 145]

SAP Cloud Applications Studio – Version May 2018 (1805)

152 © 2018 SAP SE. All rights reserved. • P U B L I C Administration and Lifecycle Management
 ● Create a Patch on Your Development Tenant [page 149]

Delete Locks Using the Session Administration

Locks occur when an item, such as a business object, is being edited by another user or from another session. As
an administrator, you can delete locks for other users; all other users can only delete their own sessions and
corresponding locks.

● Deletion of locks may result in the loss of changes made by the locking user, and should only be carried
out when absolutely necessary.
● Locks created by the UI designer can only be deleted by the user that created the lock; an administrator
cannot delete these locks.

1. On the Administration toolbar, click Session Administration.

The Session Administration opens.
2. Click the Refresh button to get a list of users with sessions.
3. Select the user for whom the session should be deleted.
4. Click the Delete button.
5. Make sure that the user whose session was deleted logs off the system. If the user continues working without
logging off, locks without session will be created. These locks can only be deleted by the user who created
the locks. If you are deleting your own session, you must also log off immediately afterwards to avoid creating
locks without session.

Delete a Solution
1. Log on to the repository and open the solution.
2. On the Administration toolbar, click Delete Solution and confirm that you want to delete the solution.

You cannot delete a solution on a production tenant. We recommend you switch the solution off by deselecting
it in Scoping. Then report an incident to request assistance from SAP.

Further Tasks
You use the Implementation Manager to manage the lifecycle of customer-specific solutions. The Implementation
Manager enables you, for example, to assemble and download a solution, upload and activate a solution, and create
a patch for a solution. If you are not able to activate a solution, you can carry out different troubleshooting activities
in the Implementation Manager.
For more information, see Implementation Manager Quick Guide [page 153].

6.6.2 Implementation Manager Quick Guide

You use the Implementation Manager to manage the lifecycle of customer-specific solutions. The Implementation
Manager enables you, for example, to assemble and download a solution, upload and activate a solution, and create
a patch for a solution. If you are not able to activate a solution, you can carry out different troubleshooting activities
in the Implementation Manager.

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 153
 Only users with the Administrator role can access the Implementation Manager tools. For more information
see User Roles [page 30].

If the Implementation Manager is not visible in the studio, you can access it as follows:
● To enable the Implementation Manager tool window, click View Implementation Manager .
The tool window provides a view of the solution status and implementation log at each stage in the process.
● To enable the Implementation Manager toolbar, click View Toolbars Implementation Manager .
The toolbar provides buttons that allow you to assemble, upload, and create a patch for your solution.

Business and Technical Background

Lifecycle Management
The studio supports the full end-to-end lifecycle management of customer-specific solutions. This includes
developing, testing, and deploying your solution as well as creating patches to deliver updates to your customer
For more information, see Lifecycle Management of Customer-Specific Solutions [page 138].

Patches
If you need to make changes or corrections to a customer-specific solution after you have assembled it, you can
create a patch.
For more information, see Patches [page 166].

Maintenance Mode
A customer-specific solution is in maintenance mode if it has been assembled and downloaded, that is, the solution
status is Assembled. You can make changes to the solution in a patch; however, you can only make restricted
changes to certain content types. These change and delete restrictions ensure that you do not make changes to a
solution that could lead to loss of data or create inconsistencies or errors on a customer's production tenant.
For more information, see Maintenance Mode [page 170].

Solution Templates
You can create templates containing reusable items and upload these items to customer-specific solutions.
For more information, see Solution Templates [page 162] and Solution Templates Quick Guide [page 160].

Tasks

Activate, Assemble, and Download a Solution

When you have finished developing your solution, you activate, assemble, and download it before uploading it to the
customer's tenant. You can do this in 2 ways as shown below:
1. Assemble and download as a front-end process
a. In the studio, log on to the tenant where you created the solution, and open the solution.
b. In the Solution Explorer, right-click the solution and select Activate.
c. In the Solution Explorer, right-click the project and select Check In All Files.
d. On the Implementation Manager toolbar, click the Assemble and Download button.
e. Enter a file name to save the template as a .zip file locally.

SAP Cloud Applications Studio – Version May 2018 (1805)

154 © 2018 SAP SE. All rights reserved. • P U B L I C Administration and Lifecycle Management
 The system checks the solution for consistency and then assembles and downloads all the items in the
solution to a .zip file.
After the solution has been assembled and downloaded, the status changes to Assembled. The solution is
now locked for further development and any changes can only be made by creating a patch.
2. Split activate, and assemble as a background job
a. In the studio, log on to the tenant where you created the solution, and open the solution.
b. On the Implementation Manager toolbar, click the Assemble and Download button. You will find a
dropdown option to Enable Assembly Split. This enables you to view the individually listed out Activate,
Assemble, and Download actions .

The activate and assemble functions run as background jobs, and you can continue to work on
other solutions in the system. The download activity, however, is a front-end process.

Depending on the status of the solution, only the relevant action will be available for use. The
following actions will be activated and available for use for:
● Activate: All solutions with In Development status
● Assemble: All solutions that have been successfully activated
● Download: All solutions that have been successfully assembled

c. Click on Activate to activate the solution. The system activates the solution and makes it ready for
Assembly. Once completed, the system sends you an auto-generated e-mail stating the success or
failure of the activation. You can view the details for failed actions by logging on to the studio, and selecting
the Version History tab in the Implementation Manager.
d. Click on Assembly, and the system checks the solution for consistency and then assembles it. Again,
you will receive an auto-generated e-mail with the details of the success or failure of the assembly
process. You can view the details for failed actions by logging on to the studio, and selecting the
Version History tab in the Implementation Manager.

e. After the assembly is completed, click on Download to download the zip file. Enter a file name to save
the template as a .zip file locally.

After the solution has been assembled and downloaded, the status changes to Assembled. The solution is
now locked for further development and any changes can only be made by creating a patch.

Upload and Activate a Solution

After you have assembled and downloaded your solution, you can upload it to the customer's tenant.
1. Log on to the tenant.
2. On the Implementation Manager toolbar, click the Upload button and select the.zip file created in the
assemble and download step.
An upload disclaimer appears.
3. Agree to the terms of the upload disclaimer and click Continue.
The system unpacks the .zip file into the production tenant.
During the upload process, the system runs compatibility checks on the solution to ensure the following:
● The tenant where you develop your solution and the tenant where you upload your solution must be on
the same release.
● SAP does not import a patch to its cloud solution at the same time.

During the upload process, the status of the solution is In Deployment. If no errors or warnings are found
during upload, you can activate the solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 155
 4. In the Implementation Manager, click the Activate button.
The status of the solution changes to Deployed.

Re-trigger Automated Distribution

Once a solution has been successful deployed and exists in a lower version in other tenants in the same system, then
you can use the automated distribution function to restart the distribution process in those tenants. The system
triggers the upload and activation of the solution in those tenants through the SAP_SYSTEM user, and not with the
service agent user.

You can restart the process by navigating to the SAP Cloud Applications Studio Implementation Manager
Tenant Status Automated Distribution . You can also check the Information Area for more details on the status
of the distribution of the tenants.
The distribution of solutions can be unsuccessful due to two reasons as shown below:
1. Both the upload and activation of the solution had failed: In this case, you must trigger a restart of the upload
of the solution by clicking on Automated Distribution . Both the upload and activation of the solution is
automated.
2. Only the activation of the solution has failed: In this case, you must login to the relevant tenant and manually
activate the solution.

For both the cases, you must check the version history logs for the respective tenants.

Create a Patch for a Solution

If you need to make changes or corrections to a customer-specific solution after you have assembled it, you can
create a patch. Depending on the tenant on which you are working, the process of creating a patch is different:
● Create a Patch on a Customer's Tenant [page 145]
● Create a Patch on Your Development Tenant [page 149]

Enable and Disable Your Solution in the SAP Cloud Solution

You use this function, for example, when you have created a patch solution on the customer's test tenant and want
to test the patch solution in the SAP cloud solution.
For more information, see Enable and Disable Your Solution in the SAP Cloud Solution [page 167].

Create a Copy of a Solution

You can use a copy of your solution, for example, to continue developing in order to try out different scenarios without
disrupting the original. For doing this, you can download a copy of an existing solution and then upload this copy to
the same tenant or a different tenant.

You cannot merge the content of the copy back to the original solution. After having achieved a satisfactory
development status of the copy, you need to repeat all changes in the original solution that you made in the
copy.

1. In the studio, log on to the tenant where you created the solution and open the solution.
2. In the Solution Explorer, right-click the solution and select Activate.
3. In the Solution Explorer, right-click the project and select Check In All Files.
4. In the Implementation Manager, click the Assemble and Download button and then Download a Copy .
5. Enter a description for the copy and save the .zip file locally.
The status of the original solution remains In Development.
6. Optional: If you want to upload the copy to a different tenant, log on to this tenant.

SAP Cloud Applications Studio – Version May 2018 (1805)

156 © 2018 SAP SE. All rights reserved. • P U B L I C Administration and Lifecycle Management
 7. In the Implementation Manager, click the Upload button and select the.zip file of the copy.
8. Agree to the terms of the upload disclaimer and click Continue.
The copy is uploaded and opened. The status of the solution is In Deployment.
9. In the Implementation Manager, click the Activate button.
When the system has activated the solution, you can create a patch and continue developing. For information
about patches, see here [page 166].

Import Items of a Solution Template

After you have downloaded a solution template, you can import this template to add its items to any of your solutions.
For more information, see Solution Templates Quick Guide [page 160].

Troubleshooting
If you were not able to activate the solution or patch, try the following:
1. In the Implementation Manager, click Show Log File to display updated log information on the Version
History tab.
If your solution or patch did not contain any errors, click the Activate button to activate the solution or patch
again.
2. If this does not work, click the Reactivate button in the Implementation Manager to generate all the objects in
the solution or patch again.
3. If reactivation fails, create an incident. For more information, see Report an Incident [page 565].

Further Tasks
Users with the Studio Administrator role can use the Administration toolbar to access a number of administrative
tasks, such as creating and deleting customer-specific solutions or solution templates and managing user sessions.
For more information, see Administration Quick Guide [page 151].

6.6.3 Migration Quick Guide

If you open a solution or solution template that has been created in a studio version older than 1302, the Migrate
Solution button is displayed in the Solution Explorer.

Business Background
The reason for this is that a new scripting language compiler has been introduced. It offers the following advantages:
● Improves performance, for example, reduces activation time
● Use functions developed for new compiler
● Enables use of SAP HANA

During migration, the following changes occur:

● Multiplicity syntax. For more information, see Node (Business Object) [page 191].
● Target annotation in associations. For more information, see Association (Business Object) [page 180].
● Generated runtime objects

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 157
Tasks

Do I need to migrate my solution?

No, you do not need to migrate your solution, and you can still use the solutions and solution templates you created
with the old compiler.
However, you will not benefit from the advantages of the new backend compiler. In addition, since studio version
1302, new functions have been developed for the new compiler that you cannot use with your old solutions and
solution templates. Please also note that you must migrate old solution templates, if you want to use them in a new
solution.

Solution or solution template created in this studio version What you need to do to benefit from the new compiler

SAP Business ByDesign Studio 4.0 Migrate your solution or solution template

SDK for SAP's On-Demand Solutions 1.0 Migrate your solution or solution template

SDK for SAP's On-Demand Solutions 1.5 (1211) Migration not necessary

SAP Solutions OnDemand Studio 1302, 1305 Migration not necessary

SAP Cloud Applications Studio August 2013 (1308) Migration not necessary

To check the compiler version of your solution, open the Properties window. The Compiler Version field
typically contains two numbers separated by a slash, for example, 1302 / 1211. The first number indicates
the compiler version of the .absl files. The number after the slash indicates the compiler version of
the .bo and .xbo files.

How do I migrate my solution to the new scripting language compiler?

1. Open your solution or solution template in the new studio version.
In the Solution Explorer, the Migrate Solution button appears.
2. Click the Migrate Solution button to migrate your solution or solution template.

The migration cannot be reverted and may take some time.

The Migrate Solution option is also available in the Administration menu. It is grayed if your solution
already uses the current scripting language compiler.
If the solution has errors, these are displayed in the Error List. Resolve the errors and click the
Migration Solution button again.

This is what happens during the migration:

● All files of your solution or solution template are checked out so that the solution cannot be changed
during the migration process.
● The entire solution is activated.
● The business object files are modified.
● The Output window shows you what has been changed.
● The compiler version is changed and the whole solution is activated automatically.
3. Check in all files, test your solution, and click Assemble and Download Customer-Specific Solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

158 © 2018 SAP SE. All rights reserved. • P U B L I C Administration and Lifecycle Management
 In the Solution Explorer, the Migrate Solution button disappears and, in the Administration menu, the Migrate
Solution option is grayed out.

● If the migration was not successful, you cannot start the migration process again. Please create
an incident instead and ask SAP Support for help.
● Once the solution has been migrated, the migration cannot be reverted.

4. Deploy your migrated solution to the target tenant.

The runtime objects in the target tenant will be migrated when you activate your solution there. If you migrate
data, this may take some time.

Which limitations apply?

● You can only migrate your solution if it is In Development or if it is a patch solution.
● If your old solution contains alternative key elements that use data types with unrestricted length, for example,
Identifier or LANGUAGEINDEPENDENT_Text, you cannot migrate your solution. However, you can replace
these data types with compatible data types. This is also possible in patch solutions.
This is an overview of the data types that you need to replace and of the data types that you can use instead:

You only need to replace these data types, if you have used them in AlternativeKey elements.

Data types that you need to replace Data types that you can use instead

BASIS.Global:Identifier AP.PDI.bo:EXTENDED_ID

AP.Common.GDT:Identifier AP.PDI.bo:EXTENDED_ID

BASIS.Global:Name AP.Common.GDT:EXTENDED_Name

AP.Common.GDT:Name AP.Common.GDT:EXTENDED_Name

AP.Common.GDT:LANGUAGEINDEPENDENT_Name AP.Common.GDT:LANGUAGEINDEPENDENT_EXTENDED_Name

AP.Common.GDT:Description AP.Common.GDT:LONG_Description

AP.Common.GDT:Note AP.Common.GDT:LONG_Description

AP.Common.GDT:Text AP.Common.GDT:LONG_Description

AP.Common.GDT:LANGUAGEINDEPENDENT_Text AP.Common.GDT:LANGUAGEINDEPENDENT_EXTENDED_Text

● You cannot migrate your solution in the following case:

1. if your old solution contains a business object node that has the same name as another business object
in the solution and
2. if your solution contains associations to the business object or the business object node.

However, you can resolve this ambiguity by adding the name of the Root node or the name of the business
object to the association target. Here is an example:

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 159
 This is the target business Do not use this source business but this source business object
object... object... (Wrong) instead... (Correct)

businessobject Target businessobject Source { businessobject Source {

{ element ID:ID; element ID:ID;
element ID:ID; node Target[0..n] { node Target[0..n] {
} element TargetID:ID; element TargetID:ID;
} }
association FirstTarget association FirstTarget
to Target; to Target.Root;
} OR
association FirstTarget
to Source.Target;
}

Wrong: The Target identifier following the to keyword of the FirstTarget association is not
unique.
Correct: Specify whether the association points to the
● root node of the other Target business object (association FirstTarget to
Target.Root)
or to the
● Target subnode of the same business object (association FirstTarget to
Source.Target)

What happens if I choose not to migrate my solution?

If you do not migrate your solution, you can continue to use it at it is. However, you will not benefit from the advantages
of the new backend compiler. Please note that you must migrate old solution templates, if you want to use them in
new solutions.

6.7 Solutions, Solution Templates, and Patches

6.7.1 Solution Templates Quick Guide

You can create templates containing reusable items and upload these items to customer-specific solutions.
For more information, see Solution Templates [page 162].

Tasks

Create a Solution Template

You can create templates containing reusable items and upload these items to customer-specific solutions.
For more information, see here [page 164].

SAP Cloud Applications Studio – Version May 2018 (1805)

160 © 2018 SAP SE. All rights reserved. • P U B L I C Administration and Lifecycle Management
Create a Copy of a Solution Template
You can use a copy of your template, for example, to continue developing in order to try out different scenarios
without disrupting the original. For this purpose, you download a copy of an existing template and then upload this
copy to the same tenant or a different tenant.

You cannot merge the content of the copy back to the source template. After having achieved a satisfactory
development status of the copy, you need to repeat all changes in the original that you made in the copy.

1. In the studio, log on to the tenant where you created the template and open it.
2. In the Implementation Manager, click the Assemble and Download button and then Download a Copy .
3. Enter a description for the copy and save the .zip file locally.
The status of the original remains In Development.
4. Optional: If you want to upload the copy to a different tenant, log on to this tenant.
5. In the Implementation Manager, click the Upload button and select the.zip file of the copy.
6. Agree to the terms of the upload disclaimer and click Continue.
The copy is uploaded and opened. The status of the template is In Development and you can continue
developing.

Download a Solution Template

When you have completed your template, you need to download the template before you can import its items to a
solution.
1. In the studio, log on to the tenant where you created the template, and open the template.
2. In the Solution Explorer, right-click the template and select Check In All Files.
3. On the Implementation Manager toolbar, click the Assemble and Download button.
4. Enter a file name to save the template as a .zip file locally.
The system checks the template for consistency and then downloads all the items in the template to
the .zip file.

Import Items of a Solution Template

After you have downloaded a solution template, you can import this template to add its items to any of your solutions.
1. Log on to the tenant where you want to import the items of your template to a specific solution.
2. Create a new customer-specific solution or open an existing solution. Please note that the solution must have
the status In Development.

Please note that the solution template and the solution, into which you import the items of the solution
template, must have been created for the same deployment unit. However, if you have created your
solution template in the Foundation deployment unit, the solution can have any deployment unit.

3. In the Implementation Manager, click the Import Solution Template button and select the.zip file of the
template that you have downloaded before.
The items of the template are added to the solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 161
 If the solution and the template contain items that have the same name, the system replaces the items
in the solution by that of the template.
Please note the following exceptions:
● If an item with the same name exists in another folder of the solution, the system doesn't import
the item
● If the template contains a BAC element and the solution already has a BAC element, the system
doesn't import the BAC element of the template.

Make sure that your solution works well with the replaced or added items, for example, check if the associations are
still valid. When you have finalized your solution, activate it.

Upload a Solution Template to Another Studio Version

If you want to continue developing your solution template in another studio version, for example, to make use of new
functionality, you need to upload the solution template to that studio version. As a prerequisite for this, you have
downloaded your solution template from an older studio version that is compatible with the new studio version. For
information about the compatible versions, see Upgrade Information [page 16].

Please make sure that the SAP cloud solution from which you have downloaded the solution template matches
the SAP cloud solution to which you want to upload the solution template.

To upload your solution template, proceed as follows:

1. Open the studio version to which you want to upload the solution template and log on to the tenant.
2. On the Implementation Manager toolbar, click the Upload button.
3. Select the .zip file of the downloaded solution template.
An upload disclaimer appears.
4. Agree to the terms of the upload disclaimer and click Continue.
The system unpacks the .zip file into the tenant and opens the solution template in the Solution Explorer.
You can now continue working on your solution template.

6.7.2 Solution Templates

With a solution template, you can organize development content that you want to reuse for customer-specific
solutions. Solution templates enable you to easily start the development of customer-specific solutions, for example,
for a specific industry.

What you can do with a solution template

In a solution template, you can create all items that you want to reuse in a solution, for example, business objects,
actions, and events. When you have completed your template, you must download it to be able to import it into a
solution. A template always has the status In Development and therefore you don't need to create a patch of a
template.
When you create a new solution or open an existing solution or a patch, you can import the items of your template
into this solution or patch. For more information, see Solution Templates Quick Guide [page 160].

SAP Cloud Applications Studio – Version May 2018 (1805)

162 © 2018 SAP SE. All rights reserved. • P U B L I C Administration and Lifecycle Management
 To create a solution template, you must log on with a user that has the studio administrator role.

What you can't do with a solution template

● You can't switch on the admin mode for a solution template. Therefore you can't, for example, define analytics
content or create a mashup in a solution template.
For information about the admin mode, see Working in the Integrated Development Environment
[page 37] under Administration Menu.
● You can't create BC sets using SAP BCOs in a solution template.
● If you create a business object extension in a solution template, you can't use the following functions:
○ Enhance Enterprise Search
○ Enhance Forms
○ Enhance Report
○ Enhance Screen

What you need to know when you import a solution template

Please note the following:
● The solution template and the solution, into which you import the items of the template, must be based on
the same cloud solution from SAP. For example, you can't import items from a template created for SAP
Business ByDesign into a solution for SAP Cloud for Customer.
● The solution template and the solution, into which you import the items of the solution template, must have
been created for the same deployment unit. However, if you have created your solution template in the
Foundation deployment unit, the solution can have any deployment unit.

You can import a solution template into the studio version in which it has been created and into the two subsequent
versions, for example:

If you have created your solution

template in this version ... ... you can upload it to this version ... and to this version

SAP Solutions OnDemand Studio 1302 SAP Solutions OnDemand Studio 1305 SAP Cloud Applications Studio 1308
(February 2013) (May 2013) (August 2013)

When you import a template into a solution, all items of the template are added to the solution. If an item in the
solution has the same name as in the template, the system replaces the item in the solution with that of the template.
Please note the following exceptions:
● If an item with the same name exists in another folder of the solution, the system doesn't import the item.
● If the template contains a BAC element and the solution already has a BAC element, the system doesn't import
the BAC element of the template.

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 163
6.7.3 Create a Solution Template

Overview
You can create templates containing reusable items and import these items into customer-specific solutions. This
allows you to easily start the development of customer-specific solutions by reusing common development content,
for example, for a specific industry.
For more information, see Solution Template [page 162].

Prerequisites
You are logged on to the repository of your development tenant or to the repository of your customer's test tenant
with a user that has the studio administrator role.

Procedure
1. On the Administration toolbar, click Create Solution ( ).
The Create Solution dialog box opens.
2. Select the Solution Template type.
3. Enter the customer and a description for the solution template.
4. Select the deployment unit in which you want to create your template and click OK.
For more information about deployment units, see Deployment Unit (Business Object) [page 187].
5. Enter your contact information and click OK.
Your solution template is created.

If you want to change the partner contact information, please do the following: In the My Solutions
window, right-click the solution and select Solution Properties. The Solution Properties dialog opens,
where you can change the contact information. Click OK to save your changes.

Result
You have created a solution template.
How your solution template is displayed
● In the My Solutions window, the new solution template is displayed as follows: [solution template
description] [solution template name].
● In the Solution Explorer, the solution template is opened and displayed as follows: [solution template
description] (In Development).

What you can do with your solution template

You can create all items that you want to reuse in a solution, for example, business objects, actions, and events.
When you have finalized your template, you can download it. You can then create a new solution or you can open an
existing solution or patch and import the items of your template to this solution or patch. For more information, see
Solution Templates Quick Guide [page 160].

SAP Cloud Applications Studio – Version May 2018 (1805)

164 © 2018 SAP SE. All rights reserved. • P U B L I C Administration and Lifecycle Management
 When you import a template into a solution, all items of the template are added to the solution. If an item in
the solution has the same name as in the template, the system replaces the item in the solution with that of
the template.

6.7.4 Create a Solution

You can design and develop customer-specific solutions to enhance SAP's standard cloud solution for a specific
customer. In the studio, you can create a solution in which all items that you develop or changes that you make to
existing entities are stored.
Depending on the tenant that you are working on, the following applies:
● Customer's Tenant
You create your solution for this specific customer on the customer's test tenant.
● Development Tenant
On your development tenant you can develop solutions for different customers. Each time you create a
solution, ensure that this solution is assigned to the correct customer ID. For more information, see Switch
a Customer Assignment [page 151].

To create customer-specific solutions, you must be logged on to the studio with a user that has the Studio
Administrator role.

Procedure
1. Optional: If you are developing on your development tenant, in the Administration menu, choose Switch
Customer.
Check that the ID of the customer for which you want to develop the solution is displayed. If not, select a
different customer or create a new customer assignment.

If you are logged on to your development tenant and you are creating a new solution, the system
automatically creates the solution for the customer that is currently displayed in the Switch
Customer dialog box. Be aware, that only a solution with the correct customer ID can be uploaded to
the corresponding tenant of your customer.

2. On the Administration toolbar, click Create Solution ( ).

The Create Solution dialog box opens.

You can also use this function to create a solution template. For more information, see Create a
Solution Template [page 164].

3. Select the Customer-Specific Solution type.

4. Enter the customer and a description for the solution.
5. Select the deployment unit in which you want to create your solution and click OK.
For more information about deployment units, see Deployment Unit (Business Object) [page 187].
6. Enter your contact information and click OK.
Your solution is created.

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 165
 If you want to change the partner contact information, please do the following: In the My Solutions
window, right-click the solution and select Solution Properties. The Solution Properties dialog opens,
where you can change the contact information. Click OK to save your changes.

Result
You have created a solution.
How your solution is displayed
● In the My Solutions window, the new solution is displayed as follows: [solution description] [solution name].
● In the Solution Explorer, the solution is opened and displayed as follows: [solution description] (In
Development).

What you can do now

You can now create a business object or use the other functions of the developer desktop. For more information,
see Business Objects Quick Guide [page 346] and Overview of the Developer Desktop [page 312].

See Also
Mobile Solutions [page 670]

6.7.5 Patches

Overview
A patch is needed if you want to make changes or corrections to a customer-specific solution after it has been
assembled. The customer-specific solution is then in maintenance mode and you can only make restricted changes
for certain content types. For more information, see Maintenance Mode [page 170].

Only users with the Studio Administrator role can create patches.

Patch Types
Depending on the type of customer's tenant where you are developing the creation and handling of a patch works
differently:
● Creating a Patch on a Customer's Test Tenant
When you create a patch of a solution on a customer's test tenant, the system creates a copy of your solution
in a new namespace allowing you to make and test your changes without disrupting the original solution. This
patch type is called a patch solution. When you want to test your patch solution in the test tenant, you first
need to use the Implementation Manager in the studio to enable the patch solution instead of the original
solution in the test tenant.
When you assemble the patch solution, the patch is copied back to the namespace of the original solution.
The patch solution is used for all future updates to the original solution. Any changes you need to make in the
future can be made by creating a new patch again. To do this, open the existing patch solution in the

SAP Cloud Applications Studio – Version May 2018 (1805)

166 © 2018 SAP SE. All rights reserved. • P U B L I C Administration and Lifecycle Management
 Implementation Manager toolbar and click Create Patch. All future patches are created in the same patch
solution but each patch has a different version number.
For more information about which steps to perform to create a patch solution, see Create a Patch on a
Customer's Test Tenant [page 145].
● Creating a Patch on Your Development Tenant
When you create a patch on your development tenant, the system creates this patch in the same solution
and namespace but with a different version number. For more information about which steps to perform, see
Create a Patch on Your Development Tenant [page 149] .

Distribution of Patches in the Production System

After you have activated a patch, the solution including the patch is available for productive use by the customer.
If the solution is already running on other tenants in the same system as the production tenant, the patch is uploaded
and activated on these tenants automatically. This happens in the background after the patch is successfully
activated in the production tenant and may take some time. If the solution is running on other tenants in different
systems, you need to upload the patch to these tenants manually.
To find out for which tenants the patch is intended, in the Implementation Manager, select the Tenant Status tab.

6.7.6 Enable or Disable Your Solution in the SAP Cloud Solution

When you create a new solution on your tenant, this solution is automatically enabled for your business user in the
SAP cloud solution. This means that your solution is visible in the SAP cloud solution when you log on with your
business user on this tenant.
Enable or Disable Your Solution on Your Development Tenant
When you are developing several solutions in parallel on your development tenant, you may want to disable a solution
for your business user in the SAP cloud solution, for example, if this solution affects the solution that you want to
test. To do this, open the solution you want to disable and in the Implementation Manager, click Disable.
Enable or Disable Your Solution on the Customer's Test Tenant
When you create a patch for your solution, the original solution is still enabled for your business user. To test your
patch solution, you need to enable it instead of the original solution. This means that the system automatically
removes the scoping of the original solution and disables the original solution. After logging on to the SAP cloud
solution, you will have to scope your patch solution before you can test it.

Procedure for Solutions on the Customer's Tenant

1. In the Implementation Manager, on the Current Solution tab, check whether the original solution or the patch
solution is open:

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 167
 Solution details on the Current Solution tab of the Implementation Manager

The title of this area of the screen shows which solution is currently open, the original solution or the patch
solution (if a patch solution exists). In this example, the original solution is open.
2. In the Solution Enablement for Business Users in Cloud Solution field, click Enable or Disable.
You use the Enable function to make either the original solution or the patch solution visible in the SAP cloud
solution. In the example, if you open the patch solution first and then use the Enable function, you make the
patch solution visible and the original solution is automatically removed and disabled.
You use the Disable function for special scenarios, for example, if your customer has opened a change project
on the test tenant before you created the patch solution. If you want to know more, see What You Need to
Consider When a Change Project Is on the Same Test Tenant [page 146].

If a solution template is being developed on the customer’s test tenant or has been uploaded to this
tenant, it is also automatically enabled. If there is a change project on the same tenant, you to need to
disable the solution template before the change project can be merged to the production tenant.

Check this table to see what happens when you enable or disable a solution:

What else do you need to

What do you want to do? What happens in the SAP cloud solution? know?

Enable the patch solution in the SAP The system removes the scoping of the After logging on to the SAP
cloud solution on the test tenant. original solution in the SAP cloud solution and cloud solution with your
disables the original solution automatically. business user, you need to
scope your patch solution
manually.

Enable the original solution in the SAP The system removes the scoping of the patch After logging on to the SAP
cloud solution on the test tenant. solution in the SAP cloud solution and disables cloud solution with your
the patch solution automatically. business user, you need to
scope your original solution
manually.

Disable the patch solution in the SAP The system removes the scoping of the patch
cloud solution on the test tenant. solution in the SAP cloud solution.

Disable the original solution in the SAP The system removes the scoping of the
cloud solution on the test tenant. original solution in the SAP cloud solution.

If you need to disable both the original solution and the patch solution, first disable the solution that
is open. Then open the other solution and disable it. It doesn't matter which solution is open first.

SAP Cloud Applications Studio – Version May 2018 (1805)

168 © 2018 SAP SE. All rights reserved. • P U B L I C Administration and Lifecycle Management
6.8 Bug Fix in Production and Pre-production Tenants

Overview
Test tenants are upgraded two weeks before the production tenants are upgraded, and test tenants are on a higher
release for two weeks. During this period, if a bug is detected in the production tenant from a solution, there are no
mechanisms to create and deploy a patch from the test to the production tenant, as it is not allowed to deploy a
patch from a higher to a lower release. With this feature you can change the .absl files directly in the production or
pre-production tenants to overcome the reported issues.

Prerequisites
● The work center view Production Fix Authorization is already assigned to the Studio developer.
● The solution is scoped with the Deployed status.

Please take into account the following points before you make any changes:
● Changes are allowed only to .absl files. No other content is supported.
● You cannot create or delete already created .absl files.
● You cannot change .absl files belonging to data disclosure items.
● This is supported only for customer-specific solutions. Multi-customer solutions and key-user
solutions are not supported.
● During the duration when you are making the bug fix (Status of the solution is Deployed — In
Correction), the solution is locked. Hence you cannot upload or deploy a patch solution. You also cannot
perform any tenant operation, such as tenant move or copy.
● There is no automatic double maintenance of the code changes to the upgraded test tenant. You must
manually make the corrections in the test tenant which has been upgraded to the higher release.
● The following are additional checks applicable for Pre-production tenants:
○ If the production tenant with this solution is available on the same system as the pre-production
tenant, then bug fixing is not allowed
○ If the test tenant with this solution is available on the same system as the pre-production tenant,
then it’s allowed with a warning – the code change has to be manually maintained in the other test
tenant

Process Flow
1. In the Solution Explorer, click to open a correction patch. The solution is available for editing and the status
of the solution is changed to Deployed - In Correction. Read the Disclaimer pop-up and agree to proceed with
the code changes.
2. Implement the required .absl changes, by using Check Out, Check In, Activate and Revert actions in the .absl
file:
a. Check out the specific .absl file for which the code change needs to be carried out.
b. Perform the .absl code changes as required using the Studio absl editor.

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 169
 c. Save and activate the modified .absl file. On successful activation, the code changes are active for the
Business users.
d. Check in the activated .absl file.
3. Once you finish making the changes, click to close the correction patch. The status of the solution is
changed to Deployed.
4. Test your solution. Right-click on the .absl file and click on Revert. This .absl file goes back to the previous
checked in and activated version.
5. Manually make the same corrections to the solution in the development tenant.

6.9 Maintenance Mode

Overview
A customer-specific solution is in maintenance mode, if it has been assembled and downloaded; the solution status
then is Assembled. You can make changes to the solution in a patch; however, you can only make restricted changes
to certain content types. These change and delete restrictions ensure that you do not make changes to a solution
that could lead to loss of data or create inconsistencies or errors on a customer's production tenant.

Deletion
When your solution is in maintenance mode, you can delete the following items:

Item Where you can find further information

Business Configuration Object (BCO) Business Configuration Quick Guide [page 314]

Business Configuration Set (BC Set)

Business Configuration View (BC View)

OData Service Extension Create an ODATA Service Extension [page 399]

Code List Data Type Create a Code List Data Type [page 406]

Embedded Component Model an Embedded Component [page 618]

Screens Generate Screens for a Business Object [page 370]

Report Create a Report [page 460]

Script File (ABSL) Actions, Events, and Validations [page 349]

Web Service Web Services Quick Guide [page 529]

Mass Data Run Object Mass Data Run Quick Guide [page 463]

UI Switch Flexible UI [page 655]

Tax Decision Tree Create a Tax Decision Tree [page 341]

References to customer-specific fields Create References to Customer-Specific Fields [page 391]

Reference to a joined data source created by an administrator Create a Joined Data Source [page 459]
in the cloud solution

SAP Cloud Applications Studio – Version May 2018 (1805)

170 © 2018 SAP SE. All rights reserved. • P U B L I C Administration and Lifecycle Management
 Item Where you can find further information

Reference to a combined data source created by an Create a Combined Data Source [page 457]
administrator in the cloud solution

Reference to a key figure created by an administrator in the Create a Key Figure [page 462]
cloud solution

See Also
Maintenance of Business Configuration Content [page 322]
Maintenance of Analytics Content [page 453]
Maintenance of Business Objects [page 358]
Maintenance of Business Object Extensions [page 380]
Patches [page 166]

SAP Cloud Applications Studio – Version May 2018 (1805)

Administration and Lifecycle Management P U B L I C • © 2018 SAP SE. All rights reserved. 171
7 Scripting Languages

7.1 Overview of Scripting Languages

Scripting Languages encompasses the following reference material:

Get Informed About Scripting Languages for the Studio

● Scripting Language Reference [page 173] ● Syntax for the Implementation of Business Logic
The scripting language is used to define business [page 210]
objects and business object extensions as well as to You use these methods and keywords to implement
implement the business logic for cloud partner the business logic of your solution. For this task, you
solutions. This lightweight language is easy to learn can also use predefined built-in functions and reuse
and to use with its focused set of features. services:
The keywords, methods and functions of the scripting ○ Built-In Functions [page 276]
language are described in separate sections according ○ Basic Reuse Libraries [page 238]
to the task you want to perform:
○ Reuse Libraries for Business Areas [page 268]
○ Syntax for Business Object Definitions
[page 174] ● Basic Data Types [page 284]
You use these keywords and functions to define The scripting language supports basic data types such
the structure and interface of business objects. as string, numeric and Boolean values. In addition, the
existing metadata of the SAP underlying cloud
○ Syntax for Business Object Extension Definitions
platform for core data types (CDTs) and global data
[page 197]
types (GDTs) is made available.
You use these keywords and functions to define
the structure and interface of business object
extensions.

Get Informed About Scripting Languages for the UI Designer

● Front-End Script for the User Interface Designer [page 289]

The front-end script is the programming language used in the UI designer to define a set of rules and the logic of the
behavior of UI controls. For example, you can write a front-end script to enable an edit button only when a field is
selected on the user interface.

Any software coding or code lines/strings (“Code”) provided in this documentation are only examples
and are not intended for use in a productive system environment. The Code is only intended to better
explain and visualize the syntax and phrasing rules for certain SAP coding. SAP does not warrant the
correctness or completeness of the Code provided herein and SAP shall not be liable for errors or damages
cause by use of the Code, except where such damages were caused by SAP with intent or with gross
negligence.

You can also refer to SAP Cloud Application Studio Performance Best Practices for more information on
some best practices to keep in mind while creating ABSL scripts.

SAP Cloud Applications Studio – Version May 2018 (1805)

172 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

7.2 Scripting Language for the Studio

7.2.1 Scripting Language Reference

Overview
The scripting language is used to define business objects and business object extensions as well as to implement
the business logic for cloud partner solutions. This lightweight language is easy to learn and to use with its focused
set of features.
The sandbox environment for the scripting prevents a partner who has created erroneous implementations from
damaging data of other users by accident. This kind of sandbox environment is ensured by the script execution
runtime. Security-relevant features, such as direct access to database tables, are strictly controlled or not made
available in the scripting language. Instead, all data access is made available through the business object
infrastructure.
The keywords, methods and functions of the scripting language are described in separate sections according to the
task you want to perform:
● Syntax for Business Object Definitions [page 174]
You use these keywords and functions to define the structure and interface of business objects.
● Syntax for Business Object Extension Definitions [page 197]
You use these keywords and functions to define the structure and interface of business object extensions.
● Syntax for Implementation of Business Logic [page 210]
You use these methods and keywords to implement the business logic of your solution.
For this task, you can also use predefined built-in functions and reuse services. For more information, see the
following documentation:
○ Built-In Functions [page 276]
○ Basic Reuse Libraries [page 238]
○ Reuse Libraries for Business Areas [page 268]

To fully understand the keyword descriptions, it is essential to have a basic understanding of the business object
model and its features, such as associations, actions, and queries.

Model names of SAP entities are in British English according to ISO 11179.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 173
Code Completion
Based on the code you type, the code completion feature presents you with a list of options. For example, if you type
a period (.), which separates the members in a path expression, the code completion is automatically activated and
a drop-down list with the potential options is displayed. You can also use key combinations to display the valid code
completion options, for example, CTRL + SPACEBAR . For more information, see the relevant syntax
documentation under Code Completion.

Syntax
The syntax conventions for scripting language are as follows:

Character Description

[] Indicates that you can use none, one, or more of the enclosed options. Do not include the brackets in your option.

| A vertical line between two parts of a statement indicates that only one of these two parts can be used within the
statement.

? Indicates that the symbol (or the group of symbols in parenthesis) to the left of the operator is optional (it can
appear just once or not at all). You can use it as a postfix to “[ ]”.

+ Indicates that something can be repeated at least once or any number of times. You can use it as a postfix to “[ ]”.

* Indicates that something can appear any number of times (and possibly be skipped altogether). You can use it
as a postfix to “[ ]”.

XXX Indicates a placeholder. Replace placeholders with actual values in your code snippet.

7.2.2 Business Object Definitions

7.2.2.1 Syntax for Business Object Definitions

Use the keywords and functions listed below to describe the structure and interface of a business object in the studio.
For more information about the general syntax conventions and rules, see Scripting Language [page 173].

Code Completion
You can use CTRL + SPACEBAR at any cursor location to display the valid code completion options for the
current context . If there is only one option, the code is completed at once. The code completion is also activated, if
you enter a period (.) in a path expression or a colon (:), for example, in an element statement.

Naming Rules in Business Object Definitions

Comply with the following naming rules:
● The name of an entity must start with a letter and can contain letters, digits, and underscore characters. Do
not start a name with “SAP_”.

SAP Cloud Applications Studio – Version May 2018 (1805)

174 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 ● Related entities within a business object, for example, elements, associations, and actions, cannot have the
same name as the business object. This does not apply for messages.
● Do not use the following technical terms as an entity name:
○ action
○ association
○ businessobject
○ element
○ import
○ namespace
○ node
○ query
○ to
○ type
○ using
○ valuation

Comments
You can enter comments using the following syntax:
● comment line
// <comment text>
A comment line starts with two slashes (//) and spans to the end of the current line.

● comment block
/* <comment text>
<comment text>
<comment text>
*/
A comment block starts with a forward slash followed by an asterisk and ends with an asterisk followed by a
forward slash.

List of Functions and Keywords

In the following, the functions and keywords are listed in alphabetical order:

● Action (Business Object) [page 177]

● Annotation (Business Object) [page 177]
● Association (Business Object) [page 180]
● Business Object (Business Object) [page 182]
● Default Values (Business Object) [page 184]
● Dependent Object (Business Object) [page 185]
● Deployment Unit (Business Object) [page 187]
● Element (Business Object) [page 188]
● Import (Business Object) [page 189]
● Message (Business Object) [page 190]
● Node (Business Object) [page 191]

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 175
 ● Raises (Business Object) [page 192]
● Valuation (Business Object) [page 194]

List of Annotations
In the following, the annotations are listed in alphabetical order:

● Access Control Context (Business Object) [page 176]

● Alternative Key (Business Object) [page 177]
● Change History (Business Object) [page 183]
● Cross Deployment Unit (Business Object) [page 184]
● Dependent Object (Business Object) [page 185]
● Deployment Unit (Business Object) [page 187]
● Extension (Business Object) [page 188]
● Language Independent (Business Object) [page 190]
● Label (Business Object) [page 189]
● Multiple Texts (Business Object) [page 191]
● Relevant For Access Control (Business Object) [page 192]
● Separately Lockable (Business Object) [page 193]
● Tooltip (Business Object) [page 193]
● Transient (Business Object) [page 194]
● With Administrative Data (Business Object) [page 196]

7.2.2.2 Access Control Context (Business Object)

Overview

Syntax [AccessControlContext (<access context>)] element <element name> : <data type> ;

[AccessControlContext (<access context>)] association <association name> to <target business
object>;

Description It is necessary that the access to specific instances is controlled by certain parameters. If you wish to define
which elements or associations can be used to control access to certain instances, you use the
AccessControlContext annotation.
The access context can only be either Employee or EmployeeOrTerritory.
For element, the data type must always be UUID.
For association, the data type of foreign key must be UUID.

Example [AccessControlContext (Employee)] element UID : UUID;

[AccessControlContext (Employee)] association ToEmployee to
AP.FO.BusinessPartner.Global:Employee using UUID ;

See Also Define Access Control [page 365]

SAP Cloud Applications Studio – Version May 2018 (1805)

176 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
7.2.2.3 Action (Business Object)

Syntax action <name> [<Raises>]? ;

Description Use the action keyword to define an action for a node. Actions carry out the business logic and are
implemented in .absl files.

Example Definition of an action:

action Cancel;
Action definition with raises statement :
action CountHappyDays raises BonusRule.ReferenceInvalid, DateMissing;

See also Raises (Business Object) [page 192]

7.2.2.4 Alternative Key (Business Object)

Syntax [AlternativeKey] element <element name> : <data type>;

Description If you want to identify a node uniquely with an identifier that can be read by human beings, you use the
AlternativeKey annotation. You can use this identifier in an association to refer to a business object
node. In addition, this identifier is stored as an additional key field in the database and thus accelerates
enterprise searches and queries.
It is not possible to have more than one alternative key of the same type in a business object node.

Custom business objects contain an implicit alternative key of type UUID for each node, enabling
the node to be used as an association target.

Example [AlternativeKey] element EmployeeID : ID;

See Also
Association (Business Object) [page 180]

7.2.2.5 Annotation (Business Object)

Syntax [<annotat
ion>[(<pa
rameter>)
]?]

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 177
Description Annotations
are used to
add a
category or
property to
an object
specified by
the
subsequent
keyword. The
names of the
annotations
are
predefined
and can be
displayed by
the code
completion.
Technically,
you can
combine as
many
annotations
as you want.
But not all
combinations
are possible
and not all of
them make
sense. For
more
information,
see the list of
possible
combinations
below.

SAP Cloud Applications Studio – Version May 2018 (1805)

178 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Examples [Alternat
iveKey]
element
EmpoyeeID
: ID;
Example with
annotation
and
parameter
[Deployme
ntUnit(Cu
stomerRel
ationship
Managemen
t)]
businesso
bject
BonusRule
{ ... };
Example with
two
annotations
[Dependen
tObject(T
extCollec
tion)]
[Multiple
Texts]
node
TextColle
ction;

Annotation Overview

Annotation Argument Keyword Can Be Combined With

AccessControlContext (Business Object) employee, element, —

[page 176] employee or association
territory

AlternativeKey (Business Object) [page 177] — element Label, Tooltip

ChangeHistory (Business Object) [page 183] — businessobject, —

node, element,
association

CrossDeploymentUnit (Business Object) — association —

[page 184]

DependentObject (Business Object) [page 185] name node MultipleTexts

DeploymentUnit (Business Object) [page 187] name businessobject —

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 179
Description (Business Object) [page 184] — node —

Label (Business Object) [page 189] content element AlternativeKey, Tooltip, Transient

LanguageIndependent (Business Object) — node DependentObject(TextCollection)

[page 190]

MultipleTexts (Business Object) [page 191] — node DependentObject(TextCollection)

RelevantForAccessControl (Business Object) — association —

[page 192]

SeparatelyLockable (Business Object) — node —

[page 193]

Tooltip (Business Object) [page 193] content element AlternativeKey, Label, Transient

Transient (Business Object) [page 194] — element —

WithAdministrativeData (Business Object) — node, —

[page 196] businessobject

7.2.2.6 Association (Business Object)

Syntax [ <annotation> ]? association <name> [ <multiplicity> ]? to <composition

path to target node> [using <alternative key>]?;

SAP Cloud Applications Studio – Version May 2018 (1805)

180 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Description An association is a relationship between two business object nodes. The definition of an association
includes a name, the multiplicity, a target node and, optionally, a target element. The target node can be
either part of the same business object or part of a different business object. You can also refer to a target
node or element in a different namespace. For more information, see Import (Business Object)
[page 189].
Associations are based on a foreign key relationship. The using clause specifies the key element of the
target business object node for the relationship. As a prerequisite, the key element must be an alternative
key and foreign key usage must be allowed for it. The using clause is optional. For business objects defined
in the same project, the target node’s hidden SAP_UUID element is used. For other business objects, the
UUID of the target node is used.
The multiplicity of an association can be either [0,1] or [1,1] . If no multiplicity is specified, [1,1] is used by
default. Only compositions can have a multiplicity with an upper boundary of “n”. However, you can easily
simulate the [1,n] multiplicity by combining a [1,n] node composition with a [1,1] intra or cross-business-
object association. For more information about compositions, see Node (Business Object) [page 191].
As a rule, the target node of an association must be located in the same deployment unit as the current
business object or in the Foundation deployment unit.
The path to the target node is expressed as follows: <namespace>:<business object>.<node>. The path
from the root node of the business object to the target node must not be part of the expression. You can
omit <namespace>, if you have imported the required namespace by using an Import statement or if the
business object is part of your solution. If you leave out <node>, the target node of the association is the
root node of the business object. The following example shows the possible path expressions of an
association in a complex business object:
import Common.DataTypes as CommonDTs;
businessobject BusinessObject1 {
element Name : LANGUAGEINDEPENDENT_MEDIUM_Name;
node Level1 {
element Name : LANGUAGEINDEPENDENT_MEDIUM_Name;
node Level2 {
element Name : LANGUAGEINDEPENDENT_MEDIUM_Name;
node Level3 {
element Name : LANGUAGEINDEPENDENT_MEDIUM_Name;
}
}
}
association A_ToLevel3 to BusinessObject1.Level3;
association B_ToLevel3 to Level3;
}

If the target node is the root node, do not use the target node path in the association definition. If
the target business object is the current business object, do not use the target business object in
the association definition. However, this does not apply if the source and the target node is the root
node of the current business object.

You can mark associations as relevant for access control by adding the annotation
RelevantForAccessControl.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 181
Examples ● Association target within the current business object
Item is the name of the composition from the current node to the Item node.
association MainItem to Item;
Item is the name of the composition from the current node to the Item node. SubItem is the name
of the composition from the Item node to the SubItem node.
association ToSubItem to Item.SubItem;
● Association to different business object
association ToServReq to
AP.CRM.Global:ServiceRequest.ServiceRequestOverview using ID;
association ToBP to AP.FO.BusinessPartner.Global:BusinessPartner
using UUID;
● Using keys and root node as a target node
The default key of target root node is used.
association Rule[0,1] to BonusRule;
The key of target root node is specified.
association Material to Product using ProductID;
● Target with fully qualified business object name
association Customer [0,1] to AP.FO.BusinessPartner.Global:Customer
using ID;
● Target with fully qualified business object name using an alias
import AP.FO.BusinessPartner.Global as bp;
association Customer[0,1] to bp:Customer using ID;
● Association marked as relevant for access control
import AP.FO.BusinessPartner.Global as bp;
[RelevantForAccessControl] association ToBP to bp:BusinessPartner;

See also Alternative Key (Business Object) [page 177]

Valuation (Business Object) [page 194]

7.2.2.7 Business Object (Business Object)

Syntax businessobject <name> [ <Raises> ]? { [<Message>? <Node>] };

Description Use the businessobject keyword to specify the name and the nodes of a business object. A business object
consists of a root node, which can contain child nodes. Even if not specified, the multiplicity of the root
node is [1,1].

The .bo file that contains the business object definition must have the same name as the business
object itself. Each file contains the definition of a single business object.

Example Business object, message and root node element. The root node raises a specified message:
businessobject BonusRule raises ReferenceInvalid {
message ReferenceInvalid text "Reference is invalid";
element ItemID : ID;
}

See also Node (Business Object) [page 191]

SAP Cloud Applications Studio – Version May 2018 (1805)

182 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
7.2.2.8 Change History (Business Object)

Overview

Syntax [ChangeHistory] element <element name> : <data type>;

Description If you need to record the changes to a given value of your business object you use the
ChangeHistory annotation. It will control the creation as well as the change of a value.
It can be applied to the keywords:
● businessobject
It works in the same way as for any other node, but here it is applied to the root node of the
business object only, not the whole business object.
● node
The changes of all elements (including the alternative keys used in associations) of this node
are recorded.
● element
The changes of this element are recorded.
If you provided the annotation already to the node of this element you will get an information
message that this annotation is superfluous.
It is not allowed to use this annotation together with the annotation Transient.
● association
The changes of this association are recorded.
This is only supported for associations using an alternative key. For associations based on
valuation please mark the elements used in the valuation with this annotation.

● The ChangeHistory annotation does not work for Dependent Objects.

● Annotating the keyword businessobject works only for the root node, not the
complete business object.

Example businessobject WorkingPlan raises DateMissing {

message DateMissing text "Date is missing";
[ChangeHistory] element ItemID : ID;
element Name : LANGUAGEINDEPENDENT_MEDIUM_Name;
[ChangeHistory] node Item [0,n] raises BonusRule.InvalidReference {
element ItemID : ID;
element ItemName : LANGUAGEINDEPENDENT_MEDIUM_Name;
}
association ToServReq to AP.CRM.Global:ServiceRequest.ServiceRequestOverview using
ID;
[ChangeHistory] association ToBP to AP.FO.BusinessPartner.Global:BusinessPartner
using UUID;
}

See Also
Enable Change History [page 375]

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 183
7.2.2.9 Cross Deployment Unit (Business Object)

Syntax [CrossDeploymentUnit] association <name> to <path to target node>

[using <composition path to target node>]?

Description You can use the CrossDeploymentUnit annotation to define an association from a node of a business
object in one deployment unit to a node of a business object in another deployment unit.
Optionally, you can specify the alternative key of the target node with the using keyword.

You cannot use a cross-deployment-unit association to access a business object in another

deployment unit. You can only use a cross-deployment-unit association in an analytical data source
to collect data from a business object residing in a different deployment unit.

Examples [CrossDeploymentUnit] association ToBusinessPartner to BusinessPartner;

[CrossDeploymentUnit] association ToSalesOrder to SalesOrder using ID;

See also Association (Business Object) [page 180]

7.2.2.10 Description (Business Object)

Overview

Syntax [Description] node <name> { …

Description You can define the node as carrying language dependent descriptions. It will be represent as such in the
Business Object model and can be used in the UI in a way that the description is automatically derived in the
logon language.
Ensure that at least one element or a supplementary component of an element of the node is of the data
type LanguageCode

Example [Description] node ProductName [0,n] { element Name : LONG_Description; }

7.2.2.11 Default Values (Business Object)

Syntax Basic data types:

element <element name> : <data type name> = <default value>;
Structured data types:
element <element name> : <data type name> = {<component1> = <default
value>, ..., <componentX> = <default value>};
You cannot use aggregated data types.

SAP Cloud Applications Studio – Version May 2018 (1805)

184 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Description Default values are initial values that are used to fill fields automatically when a new instance is created.
The studio supports only static default values such as Boolean values, status information, numeric values,
and free text.
There is no syntax check for default values included in quotation marks.

Translation of default values is not supported.

Examples Basic data types:

element Text1 : {content = "14", languageCode = "EN"};
element Text2 : LANGUAGEINDEPENDENT_MEDIUM_Description = "Test Text";
element Date : Date = "2012–11–01";
element Time : Time = "23:59:59";
element Integer : IntegerValue = 12345;
element Code : ActionCode = "01";
Structured data type:
element Amount : Amount = {content = 13.45, currencyCode = "EUR"};

See also Data Types [page 87]

7.2.2.12 Dependent Object (Business Object)

Syntax [DependentObject(<dependent object name>)] [MultipleTexts]? node <name>;

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 185
Description A dependent object is a reusable part of a business object that - from a business point of view - cannot
stand alone, but can only be used in the context of the business object. You can include the
TextCollection and AttachmentFolder dependent objects in a business object definition.

For the TextCollection dependent object you can use the following:
● MultipleTexts annotation to support different text types
● LanguageIndependent annotation to support language independent text

In order to define the dependent object inclusion node, you have to specify a name. You can either use the
dependent object name itself, for example, TextCollection, or add a specific meaning to the
dependent object name, for example, ProcurementSpecificationTextCollection. If you
include a dependent object in a business object definition several times, you should provide different names
for each of the dependent object inclusion nodes. You can, for example, use the following syntax:
<subordinate node name> + <dependent object name>, such as
ItemAttachmentFolder.

You can add the same dependent object only once to a business object node.

If you choose to add the reuse UI, you need to provide a Type Code to determine the kind of
TextCollection or AttachmentFolder you intend to use. The list of codes which are
supported are as shown below:
● TextCollection
○ 10001 Additional External Comment
○ 10002 Body Text
○ 10005 Rejection Reasons
○ 10006 Detailed Description
○ 10011 Internal Comment
○ 10025 Reason
○ 10026 Purchasing Note
○ 10027 Sales Note
○ 10029 Approval Note
○ 10047 Error Symptom
○ 10071 Work Description
● AttachmentFolder
○ 10001 Standard Attachment
○ 10006 Certificate
○ 10013 Image
○ 10047 Multimedia
○ 10049 Maps
○ 10051 Webpage

Example [DependentObject(TextCollection)] node ItemTextCollection;

Example with two annotations
[DependentObject(TextCollection)] [MultipleTexts] node TextCollection;

SAP Cloud Applications Studio – Version May 2018 (1805)

186 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
7.2.2.13 Deployment Unit (Business Object)

Syntax Assignment to a different deployment unit:

[DeploymentUnit(<deployment unit name>)] businessobject <name>
[ <Raises> ]? { [<message>? <node>] };
Cross-deployment-unit association:
[CrossDeploymentUnit] association <name> to <composition path to target
node> [using <alternative key>]?;

Description A deployment unit is a piece of software that can be operated on a separate physical system, isolated from
other pieces of software. The SAP cloud solution is organized in deployment units that group semantically
related business objects, for example, Customer Relationship Management. There is also a special
Foundation deployment unit that mainly contains master data objects, for example, Material, Employee,
and Customer.
Each business object resides in a deployment unit. You can explore SAP business objects that are released
with the public solution model (PSM) and the deployment units in the Repository Explorer tool window. For
more information, see Repository Explorer [page 50].
When a solution is created, the solution has to be assigned to a deployment unit. The business objects that
are created subsequently in the solution are assigned to this default deployment unit. If you want to assign
a business object to a different deployment unit, use the annotation DeploymentUnit at the beginning
of the business object definition.

You cannot create your own deployment units.

You can directly access business objects that reside in the Foundation deployment unit from any
deployment unit. However, business objects in the Foundation deployment unit cannot access any
business object residing in another deployment unit, not even by using asynchronous communication. You
can only use a query to read the data of this business object.
For all other deployment units the following applies: You cannot directly change the data of a business
object residing in another deployment unit. However, you can read the data of such a business object by
using a query, the Retrieve method or an association. To change the data of a business object residing
in another deployment unit, use asynchronous, message-based communication. For more information,
see Configure Internal Communication [page 523].

You cannot use a cross-deployment-unit association to access a business object in another

deployment unit. You can only use a cross-deployment-unit association in an analytical data source
to collect data from a business object residing in a different deployment unit.

Example Assigning a business object to a different deployment unit:

[DeploymentUnit(CustomerRelationshipManagement)] businessobject
BonusRule {
element ID : ID;
}

See also Association (Business Object) [page 180]

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 187
7.2.2.14 Element (Business Object)

Syntax [ <annotations> ]? element <name> : <data type name>;

Description Use the element keyword to define an element of a business object node. The element name must be unique
within the node. The element type can be a simple data type, for example, ID, or it can be a structured data
type such as Amount. You can import data types from different namespaces. However, you cannot define
new data types. For more information on importing entities, see Import (Business Object) [page 189].

When defining an identifier element, we recommend you use the ID data type instead of the
Identifier data type. The ID data type always has 60 characters, is not structured and does
not contain the Content element. The data type supports, for example, upper case conversion
and alpha conversion. Alpha conversion fills purely numeric user input like “4711” with leading zeros
from the left side to allow better sorting in character fields. For example, if alpha conversion is not
used, an alphabetic sorting would lead to results such as: “1”, “10”, “100”, “1000”, “2”, “20”, “200”,
and so on.

You can define additional properties of an element by using annotations. For example, the annotation
AlternativeKey defines the key element of a business object node. Key elements uniquely identify a
node and can be used to identify the target of an association. An alternative key, SAP_UUID of type
UUID, is generated implicitly for each node. Therefore, you do not need to define an alternative key for
each node.
Enclose annotations in square brackets.

Examples Element with simple type:

element Count : IntegerValue;
Element with complex type:
element Target : Amount;
Key element:
[AlternativeKey] element EmployeeID : ID;
Element with fully qualified type name:
element Recipient : AP.Common.GDT:Date;

See also Association (Business Object) [page 180]

7.2.2.15 Extension (Business Object)

Overview

Syntax [Extension] businessobject <name> {<Node>*}>;

Description You use the Extension annotation to extend a business object.

The name of the business object to be extended must be fully qualified, that is, it must include the
namespace as well as the name, for instance, AP.CRM.Global:Lead. You can also specify all the
extendable nodes.

SAP Cloud Applications Studio – Version May 2018 (1805)

188 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Example [Extension] businessobject AP.CRM.Global:SalesOrder {
node Item {
}
};

See also Syntax for Business Object Extension Definitions [page 197]

7.2.2.16 Import (Business Object)

Syntax import <namespace name>;

Description Use the import keyword to import business objects and data types from namespaces that are available in
the repository. The namespace name is typically a Uniform Resource Identifier (URI) in dot notation (see
example below).
You can use imported business objects and data types in the definition of associations, elements, and
messages. You can reference the imported objects directly by their names instead of using fully qualified
names. If you use a namespace only for one or two sub-entities, you can omit the import statement and
use the qualified name <namespace name>:<name> instead. If there are no conflicts for any entity in
the business object within all imported namespaces, you can omit the relevant namespace, as the system
can identify it automatically.

If you use more than one namespace in your business object definition, we recommend that you
define an alias for each imported namespace and qualify business objects or data types from these
namespaces by using the aliases.

You do not need to import business objects and data types from the namespace of the current project but
you can access them directly by their names.
You can use code completion for importing the namespace as well as for accessing imported objects, that
is, when you select the target business object of an association or the data type of a node element or
message parameter.

Examples Import of a namespace:

import AP.FO.BusinessPartner.Global;
Importing a namespace and defining an alias:
import AP.Common.GDT as apc;
import ESF as esfnsp;
Using the defined aliases:
element duration : apc:Duration;
message ReferenceInvalid text "Reference & is invalid": apc:NumberValue;
association Customer to esfnsp:BusinessPartner;

7.2.2.17 Label (Business Object)

Syntax [Label ("<label name>")] element <name> : <data type>;

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 189
Description You can define a label for a business object field. If you then add the field to a screen, the label is displayed
on the screen instead of the field name.
You can translate the label text by exporting it to an XLFF file. For more information, see the Translation
Quick Guide [page 584].

Example [Label ("My label for field 1")] element ROOT_Field1 :

LANGUAGEINDEPENDENT_EXTENDED_Text;

See Also
Add a Label and Tooltip to a Business Object [page 361]

7.2.2.18 Message (Business Object)

Syntax message <message ID> text "<message text>" [: <data type 1>[, <data type
2>[, <data type 3>[, <data type 4>]?]?]?]? ;

Description Use the message keyword to define a message between two business objects. The definition of a message
includes the message ID, the message text, and, optionally, data types of up to four message parameters.
The parameter names are defined by the system.
The limit for a message ID is 30 characters and for a message text is 73 characters. The message ID must
be unique within the business object; use uppercase for letters. You can reference data types from different
namespaces. For more information, see Element (Business Object) [page 188] and Import (Business
Object) [page 189].

Example Message without parameters:

message DateMissing text "Due date of invoice is missing";
Message with two parameters:
message ReferenceInvalid text "Reference to sales order &1 invalid for
&2" : IntegerValue, ESF:AdressType;

See also Raises (Business Object) [page 192]

7.2.2.19 Language Independent (Business Object)

Overview

Syntax [DependentObject(<dependent object name>)] [LanguageIndependent]? node

<name>;

Description You can use the LanguageIndependent annotation together with the TextCollection dependent object
to support language independent text.
If the TextCollection dependent object is assigned to the current node, the LanguageIndependent
annotation defines that no language code must be provided together with the text.
If the user logs on with a different language than the one used during the creation of the text, the same text will
be retrieved.

Example [DependentObject(TextCollection)] [LanguageIndependent] node TextCollection;

SAP Cloud Applications Studio – Version May 2018 (1805)

190 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
See Also
Dependent Object (Business Object) [page 185]

7.2.2.20 Multiple Texts (Business Object)

Syntax [DependentObject(<dependent object name>)] [MultipleTexts]? node <name>;

Description You can use the MultipleTexts annotation together with the TextCollection dependent object to
support different text types.
If the TextCollection dependent object is assigned to the current node, the MultipleTexts
annotation defines if more than one text is allowed.

Example [DependentObject(TextCollection)] [MultipleTexts] node TextCollection;

See Also
Dependent Object (Business Object) [page 185]

7.2.2.21 Node (Business Object)

Syntax node <name> [ <multiplicity> ]? [ <Raises> ]? {[ <Element>, <Action>,

<Association>, <Node> ]* };

Description Use the node keyword to define a business object node and its features, that is, elements, actions, node
associations, child nodes, and raised messages. The name of the node must be unique within the business
object.
For the business object, the root node of the node hierarchy is automatically created. The multiplicity of
the root node is [1,1]. Each direct or indirect child node implicitly contains a ToRoot association.
A node must contain at least one explicitly defined element (not including SAP_UUID, which is implicitly
generated for each node). Elements, actions, associations, and child nodes must have unique names within
the node.
The definition of a child node implicitly introduces a composition, that is, a relationship between a parent
node and a child node. The multiplicity of the child node defines the upper and lower bound of that
composition, that is, how many instances of the child node can be part of the parent node. The multiplicity
of a node can be [0,1], [1,1], [0,n], or [1,n]. If no multiplicity is defined, the multiplicity [0,1] is used by default.
You can use the composition to access features of the child node from the parent node (for example, in
action implementations). For each composition, the reverse ToParent association is created implicitly.
SelectAll and ByElements queries are created automatically for each node. It is not possible to define
new queries in the business object.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 191
Example Business object and raises statement for the root node, message definition and root node element as well
as subnode with a raises statement followed by a subnode element:
businessobject WorkingPlan raises DateMissing {
message DateMissing text "Date is missing";
element ItemID : ID;
node Item [0,n] raises BonusRule.InvalidReference {
element ItemID : ID;
}
}

See also Association (Business Object) [page 180]

7.2.2.22 Raises (Business Object)

Syntax raises <message ID> [, <message ID>[,...]?]? ;

Description At least one message ID must follow the raises statement. Following the message ID, you can enter as many
messages as needed. If the message is not part of the same business object, you must also specify the
message group. The name of the message group is identical to the corresponding name of the business
object.

Example ● Raises statement that raises a message from the same business object:
businessobject BonusRuleOne raises DateMissing {
message DateMissing text "Date is missing";
element ItemID : ID;
}
● Raises statement that raises messages from the same business object and messages with different
message groups
businessobject BonusRuleTwo raises BonusRuleOne.DateMissing {
message ReferenceInvalid text "Reference is invalid";
element ItemID : ID;
node Item raises BonusRuleOne.DateMissing, ReferenceInvalid {
element ItemID : ID;
}
action Count raises ReferenceInvalid;
}

See also Message (Business Object) [page 190]

Node (Business Object) [page 191]

7.2.2.23 Relevant for Access Control (Business Object)

Syntax [RelevantForAccessControl[(<parameter>)]?]

SAP Cloud Applications Studio – Version May 2018 (1805)

192 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Description To do this, you mark associations [page 180] as relevant for access control by adding the annotation
RelevantForAccessControl. The following conditions must be met:
● For each business object, you can only use one association that is relevant for access control.
● The source node of the association must be the root node.
● The target node of the association must be root node of the target business object.
● The target business object must have an association that is relevant for access control. The target
of this association must be the dependent object Access Control List.
● The target business object must support at least one access context. You can find this information
in the Repository Explorer by viewing the documentation of the relevant business object and by
searching for the Supported Access Context section. If this section is not listed in the
documentation, access context is not supported for this business object.

Example [RelevantForAccessControl] association toBusinessPartner to

BusinessPartner;

See also Define Access Control [page 365]

7.2.2.24 Separately Lockable (Business Object)

Overview

Syntax [SeparatelyLockable] node <name> { <elements> };

Description You can use this annotation to make sub-nodes separately lockable. This allows you to edit a node while another
user edits another node of the same business object.

Example [SeparatelyLockable] node Item { element id : ID };

7.2.2.25 Tooltip (Business Object)

Syntax [Tooltip ("<tooltip name>")] element <name> : <data type>;

Description You can define a tooltip for a business object field. If you then add the field to a screen, the label is displayed
on the screen instead of the field name.
You can translate the tooltip text by exporting it to an XLFF file. For more information, see the Translation
Quick Guide [page 584].

Example [Tooltip ("My tooltip for field 1")] element ROOT_Field1 :

LANGUAGEINDEPENDENT_EXTENDED_Text;

See Also
Add a Label and Tooltip to a Business Object [page 361]

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 193
7.2.2.26 Transient (Business Object)

Syntax [Transient] element <name> : <data type>;

Description You can use the Transient annotation to create transient fields. The data in such a field is not persistent, this
means, it is not saved in the database. A transient field is filled after an AfterLoading event has been executed.
The Transient annotation can be combined with the following annotations:
● Label [page 189]
● Tooltip [page 193]

Example [Transient] element myTransientField : LANGUAGEINDEPENDENT_LONG_Name;

[Transient][Label("MyTransientField")] element myTransientField :
LANGUAGEINDEPENDENT_LONG_Name;

7.2.2.27 Valuation (Business Object)

Syntax association <name> [<multiplicity>] to <target node> valuation (condition

[&& condition]*);
<condition> ::= <element of target node> <operator> <element defined in
source node> | <code value>
<operator> ::= == | < | > | >= | <=

SAP Cloud Applications Studio – Version May 2018 (1805)

194 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Description The valuation keyword enables you to create not only 0,1 and 1,1 associations but also 0,n and 1,n
associations. Thus, you can model hierarchical business object structures, for example, a product catalog.
You can add the valuation keyword to an association in order to evaluate the elements of a target node.
A valuation association must have the multiplicity [0,1], [1,1], [0,n], or [1,n].
Usually, associations represent relations between nodes of the same business object or between nodes of
different business objects. However, when you use the valuation keyword, the association must refer
to a node within the same business object. Depending on the node type, the valuation is executed as follows:
● If the association refers to a subnode of a business object, the valuation is executed on the subnode
instances that belong to the same business object instance as the source node instance
(association within a business object instance).
● If the association refers to the root node of a business object, the valuation is executed on all
instances of this business object (association across all instances of a business object).

The valuation keyword is followed by one or several conditions, which are evaluated when the
associations are resolved. You define a condition as follows:
1. You specify the target element.
This element must exist in the target node of the association.
2. You specify one of the following comparison operators:
● == (is equal to)
● < (is less than)
● > (is greater than)
● >= (is greater than or equal to)
● <= (is less than or equal to)
● ! (not equal)

If you want to compare two node elements, you can only use the == operator.

3. You define either an element defined in the source node or a code value.

You can use the AND operator (&&) to connect several conditions. Please note that in this case the OR
operator (|) and the NOT operator (!) are not supported.
In a condition, you can specify elements with non-structured data types only. However, you can use the
element path, for example, Amount.content, to use elements of structured data types.

The valuation keyword cannot be used together with the using keyword and the
RelevantForAccessControl annotation.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 195
Examples Valuation within a business object instance:
businessobject BusinessObject1 {
[AlternativeKey] element ID:ID;
node ChildHierNode[0,n] {
element ID:ID;
element ParentID:ID;
association toChild [0,n] to ChildHierNode valuation (ParentID ==
ID);
}
}
In the real world, BusinessObject1 may represent a catalog, containing sub-items that are ordered in
a hierarchy (all items belong to the same catalog)
Valuation across all instances of a business object:
businessobject BusinessObject1 {
[AlternativeKey] element ID:ID;
element ParentID:ID;
association toChild [0,n] to BusinessObject1 valuation (ParentID ==
ID);
}
In the real world, BusinessObject1 may represent persons or objects (for example, buildings) that
build a hierarchy.
Valuation with a code value:
businessobject BusinessObject1 {
[AlternativeKey] element ID:ID;
node CountryNode [0,n]{
element ID:ID;
element CountryCode:CountryCode;
}
association toGermany [0,1]to CountryNode valuation (CountryCode ==
"DE");
}

See also Association (Business Object) [page 180]

Relevant for Access Control (Business Object) [page 192]

7.2.2.28 With Administrative Data (Business Object)

Overview

Syntax [WithAdministrativeData] businessobject <business object name> {

[WithAdministrativeData] node <node name> {

Description If you want to record the creation date and time, along with the identity of the creator and/or the user who made
the last changes, you use the WithAdministrativeData annotation. This annotation only supports the
Business Object definition and the Node definition.

Example [WithAdministrativeData] businessobject Businessbject1 {

[WithAdministrativeData] node Item [0,n] {

SAP Cloud Applications Studio – Version May 2018 (1805)

196 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
7.2.3 Business Object Extension Definitions

7.2.3.1 Syntax for Business Object Extension Definitions

Use the keywords and functions listed below to describe the structure and interface of a business object extension
in the studio.
For more information about the general syntax conventions and rules, see Scripting Language [page 173].

Naming Rules in Business Object Extensions

Comply with the following naming rules:
● The name of an entity must start with a letter and can contain letters, digits, and underscore characters only.
Do not start a name with “SAP”.
● Entities within a business object cannot have the same name as the business object.
● Entities cannot use names that already exist in the business object being extended.
● Do not use the following technical terms as an entity name:
○ association
○ businessobject
○ element
○ import
○ namespace
○ node
○ query
○ to
○ type
○ using

Extension Template
When you create a business object extension, you are presented with a template that includes the extendable nodes.
Taking the Sales Order business object as an example, the extension template begins with the annotation
[Extension] and contains the extendable node Item. The Root node is also extendable, although not explicitly
shown.
import AP.Common.GDT;
import AP.CRM.Global;

[Extension] businessobject AP.CRM.Global:Lead {

// You must activate this business object before you can access the extension fields
// in script files and screens

node Item {
}

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 197
}

Code Completion
Based on the code you type, code completion presents you with a list of valid options. For example, when you type
a colon (:) after an element name, you will see a list of valid data types. If there is only one valid option, the code is
completed at once.
You can also use CTRL + SPACEBAR to force the code completion function to display the valid options at the
current cursor location.

Comments
You can enter comments using the following syntax:
● comment line
// <comment text>
A comment line starts with two slashes (//) and spans to the end of the current line.

● comment block
/* <comment text>
<comment text>
<comment text>
*/
A comment block starts with a forward slash followed by an asterisk and ends with an asterisk followed by a
forward slash.

List of Keywords
● Action (Business Object Extension) [page 199]
● Business Object (Business Object Extension) [page 199]
● Element (Business Object Extension) [page 201]
● Import (Business Object Extension) [page 202]
● Message (Business Object Extension) [page 203]
● Node (Business Object Extension) [page 204]
● Raises (Business Object Extension) [page 207]

List of Annotations
● Decimal (Business Object Extension) [page 200]
● Label (Business Object Extension) [page 203]
● Reference (Business Object Extension) [page 208]
● Relation (Business Object Extension) [page 208]
● Scenario (Business Object Extension) [page 209]
● Tooltip (Business Object Extension) [page 210]

SAP Cloud Applications Studio – Version May 2018 (1805)

198 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
7.2.3.2 Action (Business Object Extension)

Syntax action <name> [<Raises>]? ;

Description Use the action keyword to define an action for a node. Actions carry out the business logic and are
implemented in .absl files.
You can only use this keyword in business object extensions created on the ESF2 framework.

Example Definition of an action:

action Cancel;
Action definition with raises statement :
action CountHappyDays raises BonusRule.ReferenceInvalid, DateMissing;

See also Raises (Business Object) [page 192]

7.2.3.3 Business Object (Business Object Extension)

Syntax [Extension] businessobject <name> { <Node>* };

Description The businessobject keyword specifies the business object being extended.

Example [Extension] businessobject AP.CRM.Global:Lead {

node Item {
}
}

7.2.3.4 Annotation (Business Object Extension)

Syntax [<annotation>[(<parameter>)]?]

Description Annotations are used to add a category or property to an object specified by the subsequent keyword. The names
of the annotations are predefined and can be displayed by the code completion.
Technically, you can combine as many annotations as you want. But not all combinations are possible and not
all of them make sense. For more information, see the list of possible combinations below.

Example [annotation]? element name : datatype;

Annotation Overview

Annotation Argument Keyword Can Be Combined With Allowed in

Standard/
Extension
Node

AlternativeKey (Extension Node) [page 177] — element Label, Tooltip Extension

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 199
ChangeHistory (Extension Node) [page 183] — node, element, — Extension
Association

Decimal (Business Object Extension) digits, element Label, Scenario, Tooltip, Standard
[page 200] fraction Transient

Description (Extension Node) [page 184] — node SeparatelyLockable Extension

Label (Business Object Extension) content element Decimal, Relation, Both

[page 203] Scenario, Tooltip,
Transient

Label (Extension Node) [page 189] content element AlternativeKey, Tooltip, Both
Transient

Reference (Business Object Extension) — element Scenario Standard

[page 208]

Relation (Business Object Extension) list of names element Label, Scenario, Tooltip Standard
[page 208]

Scenario (Business Object Extension) list of names element Decimal, Label, Standard
[page 209] Reference, Relation,
Tooltip

SeparatelyLockable (Extension Node) — node Description Extension

[page 193]

Tooltip (Business Object Extension) content element Decimal, Label, Both

[page 210] Relation, Scenario,
Transient

Tooltip (Extension Node) [page 193] content element AlternativeKey, Label, Both
Transient

WithAdministrativeData (Extension Node) — node, — Extension

[page 196] businessobject

7.2.3.5 Decimal (Business Object Extension)

Syntax [Decimal (x,y)] element <name> : DecimalValue;

Description You can declare a decimal value with a specific number of digits before and after the decimal point.
The decimal annotation [Decimal (x,y)] requires two parameters:
● x = the total number of digits allowed, up to a maximum of 29
● y = the number of digits allowed after the decimal point, up to a maximum of 14

The first parameter value must be greater than the second parameter value.

● The default number of digits before and after the decimal point are 7 and 2 respectively.
● When you use negative numbers, the minus sign is counted as a digit. For example,
[Decimal (2,0)] allows 55 and -5 but not -55.

SAP Cloud Applications Studio – Version May 2018 (1805)

200 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Example Valid Syntax
[Decimal (2,1)] element Test_Decimal_01 : DecimalValue;
– possible numbers: 5, 55, -5, 5.5, 0.5
[Decimal (6,2)] element Test_Decimal_02 : DecimalValue;
– possible numbers: 5555.55, -555.55, 555555, 0.55
Invalid Syntax
[Decimal (4,4)] element Test_Decimal_03 : DecimalValue;
[Decimal (6,8)] element Test_Decimal_04 : DecimalValue;

7.2.3.6 Default Values (Business Object Extension)

Syntax Basic data types:

element <element name> : <data type name> = <default value>;
Structured data types:
element <element name> : <data type name> = {<component1> = <default
value>, <componentX> = <default value>};
You cannot use aggregated data types.

Description Default values are initial values that are used to fill fields automatically when a new instance is created.
The studio supports only static default values such as Boolean values, status information, numeric values,
and free text.
There is no syntax check for default values included in quotation marks.

Translation of default values is not supported.

Examples Basic data types:

element Text1 : {content = "14", languageCode = "EN"};
element Text2 : LANGUAGEINDEPENDENT_MEDIUM_Description = "Test Text";
element Date : Date = "2012–11–01";
element Time : Time = "23:59:59";
element Integer : IntegerValue = 12345;
element Code : ActionCode = "01";
[Decimal(12.5)] element MyOKDecimal2 : DecimalValue = 1234.12345
Structured data type:
element myOKAmount1 : Amount = {content = 13.45, currencyCode = "EUR"};

See also Data Types [page 87]

7.2.3.7 Element (Business Object Extension)

Syntax [ <Annotation> ]? element <name> : <data type>;

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 201
Description Use the element keyword to define an extension element for a business object node.
The element name must be unique within the solution and cannot exceed 60 characters.
The element type can be a simple data type, for example,
LANGUAGEINDEPENDENT_EXTENDED_Text, or it can be a structured data type such as Amount. You
can import data types from different namespaces. However, you cannot define new data types. For more
information on importing entities, see Import (Business Object Extension) [page 202].

Data Types The following data types are available by default:

● Amount
● Date
● DecimalValue

The default number of digits before and after the decimal point are 7 and 2 respectively.

● CodeList – SAP code lists

● ID
● Identifier – SAP identifiers
● Indicator
● Quantity
● Time
● Text

If you use this data type in a business object extension, the length of the corresponding field
is not restricted to a specific number of characters. Only in business object definitions, the
field length is restricted to 255 characters.

● WebURI
● EmailURI

By importing additional namespaces, you can access additional SAP CodeLists and Identifiers.
You can also use CodeLists that you have defined within your solution.

Example element Target : Amount;

7.2.3.8 Import (Business Object Extension)

Syntax import <namespace name>;

Description Use the import keyword to import data types from namespaces that are available in the repository. The
namespace name is typically a Uniform Resource Identifier (URI) in dot notation (see example below).
You can use imported data types in the definition of elements. You can reference the imported data types
directly by their names instead of using fully qualified names. If you use a namespace only for one or two
sub-entities, you can omit the import statement and use the qualified name <namespace
name>:<name> instead. If there are no conflicts for any entity in the business object within all imported
namespaces, you can omit the relevant namespace, as the system can identify it automatically.
You can also define an alias for an imported namespace and qualify data types from this namespace by
using the alias.

SAP Cloud Applications Studio – Version May 2018 (1805)

202 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Example Import of a namespace:
import AP.Common.GDT;
Definition of an alias:
import AP.Common.GDT as APC;
Using the defined alias:
element Target : APC:Amount;

7.2.3.9 Label (Business Object Extension)

Syntax [Label ("<label name>")] element <name> : <data type>;

Description You can define a label for an extension field. If you then add the extension field to a screen, the label is
displayed on the screen instead of the extension field name.

If the element is structured, such as Amount, the label annotation is defined for the .content
element. Please note that you cannot define a label for a structured element that does not contain
a .content element or that contains more than one .content element.

Example [Label ("Screen Label")] element Opportunity_BO_extension_field :

Indicator;

7.2.3.10 Message (Business Object Extension)

Syntax message <message ID> text “<message text>” [: <data type 1>[, <data type
2>[, <data type 3>[, <data type 4>]?]?]?]?;

Description Use the message keyword to define a message for a business object extension. The definition of a message
includes the message ID, the message text which can include up to four parameters, and the data types of
any parameters used.
The limit for a message ID is 30 characters and for a message text is 73 characters. The message ID must
be unique within the business object extension.
Messages can only be raised in the business object extension where they are defined. In addition, messages
must be assigned to the individual nodes where they are to be called.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 203
Example import AP.Common.GDT;
import AP.CRM.Global;
[Extension] businessobject AP.CRM.Global:Opportunity raises
Information_Message, Error_Message, Warning_Message, Success_Message {
// You must activate this business object before you can access the
extension fields
// in script files and screens.
message Information_Message text "This is an Information message";
message Error_Message text "This is an Error message with one parameter
&1" : LANGUAGEINDEPENDENT_SHORT_Name;
message Warning_Message text "This is a Warning message with two
parameters &1 and &2" : LANGUAGEINDEPENDENT_SHORT_Name, IntegerValue;
message Success_Message text "This is a Success message with a variable
parameter &1" : Amount;
element Test_Extension_Field : Amount;
node Item raises Information_Message {
}
}

7.2.3.11 Node (Business Object Extension)

Syntax node <name> [ <multiplicity> ]? {[ <Element>, <Node> ]* };

Description The node keyword specifies the extendable nodes within a business object.
You can create and add your own custom nodes within a business object extension. However, you must
note that not all standard business objects support these node extensions. For more information on the
list of standard business objects, see below..

Example [Extension] businessobject AP.CRM.Global:SalesOrder {

node Item {
}
}

The following business objects support node extensions:

● In SAP Business ByDesign,

Business Object
Name Namespace

AccountingCodingBl http://sap.com/xi/AP/IS/CodingBlock/Global
ockDistribution

AddressSnapshot http://sap.com/xi/AP/FO/Address/Global

BankDirectoryEntry http://sap.com/xi/AP/FO/BankDirectoryEntry/Global
File

BusinessPartnerHier http://sap.com/xi/AP/FO/BusinessPartner/Global
archy

SAP Cloud Applications Studio – Version May 2018 (1805)

204 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Business Object
Name Namespace

CodingBlockCustom http://sap.com/xi/AP/IS/CodingBlock/Global
Object1

CompanyFinancials http://sap.com/xi/AP/FO/CompanyFinancialsProcessControl/Global
ProcessControl

EmployeeTimeCalen http://sap.com/xi/AP/TimeAndLabourManagement/Global
dar

FinancialAccounting http://sap.com/xi/AP/FinancialAccounting/Global
ViewOfPurchasingD
ocument

FinancialPlanData http://sap.com/xi/AP/FinancialAccounting/Global

FinancialsViewOfCo http://sap.com/xi/AP/FinancialAccounting/Global
ntract

ForeignTradeProduc http://sap.com/xi/FTA/ForeignTradeProductClassification/Global
tClassification

IdentityBusinessRol http://sap.com/xi/AP/PC/IdentityManagement/Global
e

ObjectIdentifierMap http://sap.com/xi/CommunicationServicesManagement/Global
ping

Payment http://sap.com/xi/AP/Payment/Global

PaymentBatch http://sap.com/xi/AP/Payment/Global

ProjectStockOrder http://sap.com/xi/AP/ProjectManagement/Global

● In SAP Cloud for Customer,

Business Object Name Namespace

AccountingCodingBlockDistribution http://sap.com/xi/AP/IS/CodingBlock/Global

Activity http://sap.com/xi/AP/PC/ActivityManagement/Global

ActivityWorklist http://sap.com/xi/AP/FO/Activity/Global

AddressSnapshot http://sap.com/xi/AP/FO/Address/Global

AttachmentFolder http://sap.com/xi/AP/FO/Address/Global

BusinessActivityIndustryExtension http://sap.com/xi/AP/PC/ActivityManagement/Global

BusinessAttribute http://sap.com/xi/AP/FO/BusinessAttribute/Global

BusinessAttributeAssignment http://sap.com/xi/AP/FO/BusinessAttribute/Global

BusinessAttributeSet http://sap.com/xi/AP/FO/BusinessAttribute/Global

BusinessPartnerRelationship http://sap.com/xi/AP/FO/BusinessPartnerRelationship/Global

BusinessPartnerSolutionExtensions http://sap.com/xi/AP/FO/BusinessPartner/Global

BusinessPartnerVisitingInformation http://sap.com/xi/AP/FO/BusinessPartner/Global

Campaign http://sap.com/xi/AP/CRM/Global

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 205
 Business Object Name Namespace

CampaignResponseOption http://sap.com/xi/AP/CRM/Global

CashDiscountTerms http://sap.com/xi/AP/FO/CashDiscountTerms/Global

CodTimeEntry http://sap.com/xi/AP/CRM/Global

CodTimeReport http://sap.com/xi/AP/CRM/Global

ComplaintManagementSalesOrder http://sap.com/xi/AP/CRM/Global

Contract http://sap.com/xi/AP/CRM/Global

CustomerQuote http://sap.com/xi/AP/CRM/Global

DesignRegistration http://sap.com/xi/AP/CRM/Global

ExternalAggregatedCustomerSalesOrderView http://sap.com/xi/AP/FO/CustomerDocumentReplication/Global

ExternalCustomerKPIView http://sap.com/xi/AP/FO/CustomerDocumentReplication/Global

ExternalIdentity http://sap.com/xi/AP/FO/BusinessPartner/Global

ExternalPriceDocument http://sap.com/xi/AP/FO/PriceAndTax/Global

IdentityBusinessRole http://sap.com/xi/AP/PC/IdentityManagement/Global

InstallationPoint http://sap.com/xi/AP/FO/IBase/Global

InstalledBase http://sap.com/xi/AP/FO/IBase/Global

InsurancePolicy http://sap.com/xi/AP/CRM/Global

InsuranceQuickQuote http://sap.com/xi/AP/CRM/Global

InsuranceQuote http://sap.com/xi/AP/CRM/Global

InsuranceRenumerationAnalytics http://sap.com/xi/AP/CRM/Global

Lead http://sap.com/xi/AP/CRM/Global

LeadIndustryExtn http://sap.com/xi/AP/CRM/Global

MaintenancePlan http://sap.com/xi/AP/CRM/Global

MarketingPermission http://sap.com/xi/AP/CRM/Global

ObjectIdentifierMapping http://sap.com/xi/CommunicationServicesManagement/Global

OperatingHours http://sap.com/xi/AP/FO/OperatingHours/Global

Opportunity http://sap.com/xi/AP/CRM/Global

OpportunityIndustryExtension http://sap.com/xi/AP/CRM/Global

OrganisationAddress http://sap.com/xi/AP/FO/Address/Global

PartnerAddress http://sap.com/xi/AP/FO/Address/Global

PdmMaterialIndustryExtn http://sap.com/xi/AP/FO/ProductDataMaintenance/Global

ProductBusinessPartnerRelation http://sap.com/xi/AP/FO/
ProductBusinessPartnerRelationManagement/Global

ProfessionalServicesMasterProject http://sap.com/xi/AP/CRM/Global

ProjectAlert http://sap.com/xi/AP/CRM/Global

Promotion http://sap.com/xi/AP/CRM/Global

SAP Cloud Applications Studio – Version May 2018 (1805)

206 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Business Object Name Namespace

Questionnaire http://sap.com/xi/AP/FO/Activity/Global

Route http://sap.com/xi/AP/PC/ActivityManagement/Global

SalesTerritory http://sap.com/xi/AP/PC/SalesTerritoryMgmt/Global

SalesTerritoryIndustryExt http://sap.com/xi/AP/PC/SalesTerritoryMgmt/Global

ServiceIssueCategoryCatalogue http://sap.com/xi/AP/FO/ServiceIssue/Global

ServiceRequest http://sap.com/xi/AP/CRM/Global

SupplierInvoiceRequest http://sap.com/xi/AP/PC/SupplierInvoiceProcessing/Global

TargetGroup http://sap.com/xi/AP/CRM/Global

TextCollection http://sap.com/xi/DocumentServices/Global

UtilitiesBusinessAgreement http://sap.com/xi/AP/CRM/Global

UtilitiesConnectionObject http://sap.com/xi/AP/CRM/Global

UtilitiesPointOfDelivery http://sap.com/xi/AP/CRM/Global

VisitTourPlan http://sap.com/xi/AP/PC/ActivityManagement/Global

WorkplaceAddress http://sap.com/xi/AP/FO/Address/Global

7.2.3.12 Raises (Business Object Extension)

Syntax raises <message ID> [, <message ID>[,...]?]?;

Description Use the raises keyword to declare messages for a business object extension. At least one message ID must
follow the raises statement.
Messages can only be raised in the business object extension where they are defined. In addition, messages
must be assigned to the individual nodes where they are to be called.

Example import AP.Common.GDT;

import AP.CRM.Global;
[Extension] businessobject AP.CRM.Global:Opportunity raises
Information_Message, Error_Message, Warning_Message, Success_Message {
// You must activate this business object before you can access the
extension fields
// in script files and screens.
message Information_Message text "This is an Information message";
message Error_Message text "This is an Error message with one parameter
&1" : LANGUAGEINDEPENDENT_SHORT_Name;
message Warning_Message text "This is a Warning message with two
parameters &1 and &2" : LANGUAGEINDEPENDENT_SHORT_Name, IntegerValue;
message Success_Message text "This is a Success message with a variable
parameter &1" : Amount;
element Test_Extension_Field : Amount;
node Item raises Information_Message {
}
}

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 207
7.2.3.13 Reference (Business Object Extension)

Overview

Syntax [Reference] element <extension_field_name>;

Description The Reference annotation enables you to use an element declared in one business object extension in
another business object extension. You can also use an element in the item node that is declared in the
root node of the same business object extension.
The Reference annotation cannot be combined with the following annotations:
● Decimal
● Relation
● Label
● Tooltip
● Transient

You do not need to include a data type when referencing an element, as the data type is specified
in the original element definition.

Examples 1. Reference from one business object extension to another business object extension
Definition of the first business object extension:
element Test_Extension_Field : Text;
Definition of the second business object extension:
[Reference] element Test_Extension_Field;
2. Reference from an item node to the root node of the business object extension
Definition of the root node:
element Test_Extension_Field : Text;
Definition of the item node:
[Reference] element Test_Extension_Field;

In contrast to the Relation [page 208] annotation, which refers to any business object element, the
Reference annotation refers to a specific element within the same business object.

7.2.3.14 Relation (Business Object Extension)

Syntax [Relation(Namespace:BusinessObject.BO_Node.Element)] element <data

type>;
with <data type with representation term Identifier>

SAP Cloud Applications Studio – Version May 2018 (1805)

208 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Description The Relation annotation enables you to create a reference to a business object by using the identifier
of an element, for example, ID, PartyID, or UUID as the target of the reference. Thus, you can create an
element that is like the element you are referring to and retrieve the data of this element, for example, for
an object value selector or a query. Tooltips and labels are not retrieved from the element you are referring
to. You need to specify the namespace in the annotation, if the namespace has not yet been specified in
the definition of the business object extension.
You can combine the Relation annotation with the Scenario, Label, and Tooltip annotations and
with default values but not with the Reference, Decimal, and Transient annotations.

Examples [Relation(AP.CRM.Global:Opportunity.Item.ItemProduct.ProductKey.ProductI
D)] element MyProductID : ProductID;
[Relation(AP.FO.BusinessPartner.Global:Employee.Identification.EmployeeI
D)] element MyEmployeeID : EmployeeID;

7.2.3.15 Scenario (Business Object Extension)

Syntax [Scenario (<scenario_name>)] element <extension_field_name>:<data_type>;

Description A process extension scenario links the data from one business context to other related business contexts.
You create an extension scenario from a list of predefined extension scenarios. For example, you can create
an extension scenario that links the following business contexts:
● Lead - General Information > Opportunity - General Information
● Opportunity - General Information > Sales - General Information

Each extension scenario contains one or more data flows. Each data flow consists of a source and target
business context. This reflects the direction in which data is passed from one business context to the next
as part of a business process.
● Opportunity - General Information > Sales - General Information
○ Opportunity - General Information > Sales Quote - General Information
○ Opportunity - General Information > Sales Order - General Information

Extension scenarios are specific to the node for which they were created. If an extension scenario
was created for the root node, then it can only be called at the root node within the .xbo. Similarly,
an extension scenario created for the item node can only be called from the item node within
the .xbo.

If you now extend any of the business objects involved in the scenario, you can use the annotation
[Scenario] to declare that the element is available to all the business contexts specified in the scenario.
For example, if you add an element to the Lead business object, you can use an extension scenario to make
this element available if you extend the Opportunity, Sales Quote, or Sales Order. When an Opportunity is
created from the Lead, the data for your extension field is passed to the Opportunity. Similarly, when a
Sales Order is created from the Opportunity, the data is passed to the Sales Order.

Example [Scenario (Sales_Lead_Tracking)] element Sales_Lead_Source : Text;

See Also For a list of all predefined extension scenarios, see Extension Scenarios [page 396].

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 209
7.2.3.16 Tooltip (Business Object Extension)

Syntax [Tooltip ("<tooltip name>")] element <name> : <data type>;

Description You can define a tooltip for an extension field. If you then add the extension field to a screen, the tooltip is
displayed when you place the cursor on the extension field.

If the element is structured, such as Amount, the tooltip annotation is defined for the .content
element. Please note that you cannot define a tooltip for a structured element that does not contain
a .content element or that contains more than one .content element.

Example [Tooltip ("Screen Tooltip")] element Opportunity_BO_extension_field :

Indicator;

7.2.4 Business Logic

7.2.4.1 Syntax for Implementation of Business Logic

The methods and keywords listed below enable you to implement the business logic for your solution in script files,
such as actions, validations and events. You can implement, for example, BeforeSave events and OnSave
validations, and the actions that you have defined for your business objects. For more information about the general
syntax conventions and rules, see Scripting Language [page 173].
You can also use built-in functions and reuse libraries that extend the scope of the methods described below. For
more information, see the following documentation:
● Built-In Functions [page 277]
● Basic Reuse Libraries [page 238]
● Reuse Libraries for Business Areas [page 268]

Type Handling
The scripting language supports type inference, thereby avoiding the need of explicitly identifying relevant types.
This is especially useful for script files, where elements of existing business objects are accessed either by your own
business objects or by SAP business objects. For structured element types, the code completion enables you to see
the data type’s structure while accessing the elements of the involved business objects.
For more information about the basic data types that the scripting language supports and their behavior, see
Behavior of Data Types [page 284].

Code Completion
Apart from using a period (.) for the code completion of path elements, you can use the key combination CTRL +
J to display all options for the current context. You can use this feature at any cursor location, for example, when

SAP Cloud Applications Studio – Version May 2018 (1805)

210 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
the cursor is located at the end of a partially typed identifier or keyword or when the cursor is located within or directly
before an already existing and valid identifier.

Method Tooltip
The method tooltip displays the documentation of a method and its parameter definitions. The method tooltip
appears when you type an opening parenthesis, which is the method parameter indicator character.
To display the method tooltip, you can also use the key combination CTRL + SHIFT + SPACEBAR whenever
the cursor is located within a method name or a parameter of a method call. If multiple methods with the same name
but different parameters are available, you can choose the appropriate method signature from the list using the up
and down arrow keys. If you use the left and right arrow keys, you can display the definitions of the individual
parameters.
The method tooltip is displayed automatically when you type the parameters of a method. The method parameter
description moves to the next parameter whenever you type a comma (,) before the closing parenthesis.

Comments
The syntax supports single-line and multiple-line (block) comments. A single-line comment starts with two slash
marks (//) and spans to the end of the current line. The block comment, which can span multiple lines, starts with
a slash mark and an asterisk (/*) and ends with an asterisk and a slash mark (*/).
Single-line comment:
// <comment>
Multi-line comment:
/* <comment> */

Code Formatter
The code formatter helps to maintain a clean and readable source code in script files. It offers the following formatting
options:
● Properly indenting lines
● Inserting new lines, for example, before or after a control block
● Inserting spaces, for example, in expressions

When you have opened a script file in the code editor, you can execute the code formatter by selecting
Edit Advanced Menu Format Document . Alternatively, you can press CTRL + K or CTRL + D .
The code formatter formats the whole script file; you cannot use it to format only parts of the code.

Syntax
Simple and complex statements are supported. Complex statements usually contain a code body which is opened
and closed by braces { }. The body, in turn, can contain any type of statement, that is, the statements can be nested.
Simple statements, in contrast, can only be assignments and path expressions, in addition to variable declarations
and the import statement.

List of Methods and Keywords

The methods and keywords are divided into the following sections:

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 211
 ● Contexts
Contains information about the this keyword.
○ This [page 237]
● Simple Statements
Contains information about statements such as the import keyword and the declaration of variables.
○ Import [page 225]
○ Declarations [page 221]
○ Assignment [page 215]
● Complex Statements
Contains information about control and loop statements.
○ If Control Statement [page 224]
○ Switch Control Statement [page 236]
○ Foreach Loop Statement [page 222]
○ While Loop Statement [page 237]
○ Continue Statement and Break Statement [page 219]
● Expressions
Contains information about all types of expressions, for example, literals, path expressions, and arithmetic
expressions.
○ Literals [page 225]
○ Function Literals [page 223]
○ Logical Expressions [page 226]
○ Conditional Expressions [page 218]
○ Arithmetic Expressions [page 214]
○ Path Expressions [page 228]
○ Name Qualification [page 227]
○ Action Execution [page 213]
● Association Handling
Contains information about accessing, setting, and checking associations.
○ Association Access [page 215]
○ Set Associations [page 235]
○ Check Associations (IsSet) [page 216]
○ Reset Associations [page 233]
● Business Object Lifecyle
Describes how the lifecycle of a business object instance can be controlled by the coding, that is, when
creating, reading, updating and deleting a business object. For more information, see Business Object
Lifecycle [page 216].
○ Create Instance [page 219]
○ Create with Reference Action [page 220]
○ Query Execution [page 229]
○ Retrieve Instance [page 233]
○ Delete Instance [page 222]
○ Check Node Existence(IsSet) [page 216]
● Collection Handling
Contains information about how to define and modify collections. For more information, see Collection
Handling [page 218].

SAP Cloud Applications Studio – Version May 2018 (1805)

212 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 ○ Collection Definition [page 217]
○ Add to Collection [page 214]
○ Clear Collection [page 217]
○ Sort Collection (OrderBy) [page 236]
○ Filter Collection (Where) [page 222]
○ Remove from Collection [page 232]
○ Remove Duplicate Rows from Collection (DistinctBy) [page 232]
○ Get First or Get Last Row of Collection [page 224]
○ Count Rows of Collection [page 219]
● Message Handling
Contains information about how to create and raise messages in the implementation phase.

You cannot receive and handle messages that have been raised by a different script file containing
implementation code or the business object infrastructure, for example, during the creation of a
business object node instance.

○ Raise Message [page 232]

● Service Integration Methods
Contains information about indicators and return values used for condition evaluation in service integrations
scenarios. For more information, see Service Integration Methods [page 235].
○ Script File Parameter [page 234]
○ Return Values [page 234]
○ Process Context [page 228]

7.2.4.2 Action Execution (Business Logic)

Syntax Static execution:

<business object name>[.<node name>].<action name>([<param>]*);
Instance-based execution:
<node instance var>.<action name>([<param>]*);

Description An action execution is a special form of a path expression. The code completion offers actions that are
based on business object nodes in the same way as common method calls. You can enter parameters in
parentheses (..). In reuse library method calls, you can also use optional parameters but not in actions that
are based on business object nodes. Even if there are no parameters, you must always use parentheses.
In contrast to reuse service methods, action methods based on business object nodes do not support return
values.
If the multiplicity of the action definition in the business object model is [0,0], you can execute the action
statically by using static path expressions that identify a business object node. If the multiplicity is [1,1] or
[1,n], you can execute the action instance-based. In this case, the instance identifier has to be a collection.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 213
Example ● Instance-based execution ([1:1]):
import AP.CRM.Global;
foreach (var so in SalesOrder.Header.Execute()) {
so.Item.CheckATP();
break;
}
● Static execution ([0,0]):
BOName.NodeName.ActionName();

7.2.4.3 Add to Collection (Business Logic)

Syntax <collection>.Add(<node instance or collection>);

Description Use the Add method to add a single row or an existing collection to the end of a collection.

This method cannot be applied to read-only collections. This is only relevant for code related to form
data type extensions and in case of mass-enabled script files, in which the this keyword represents
an immutable collection of nodes.

Example var collection : collectionof Opportunity;

var dataOpportunity : elementsof Opportunity;
var nodeRef;
dataOpportunity.Name = "New opportunity 4711"
nodeRef = this.Create(dataOpportunity);
collection.Add(nodeRef);

7.2.4.4 Arithmetic Expressions (Business Logic)

Syntax literal | <varName> | <path expression>

[ + | — | * | / | % ] <arithmetic expression>;

Description The arithmetic expressions support the common mathematical operators for addition, subtraction,
multiplication, division, and modulo calculations. Operands can be atomic expressions, such as literals,
variable identifiers, path expressions, or other arithmetic expressions.
You can overwrite the precedence order of the operators by using parentheses.
The operands have to evaluate to the exactly same type. The compiler does not implicitly convert
incompatible types. The plus sign (+) operator is overloaded to allow string concatenation.

Example var result = (-0.234e-5 + this.Total) * currentValue;

var resultString = "Hello " + "world!";

SAP Cloud Applications Studio – Version May 2018 (1805)

214 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
7.2.4.5 Assignment (Business Logic)

Syntax <x> = <y>;

Description An assignment assigns the value of the expression on the right to the expression on the left. The expression
on the left must be a variable or an element of a business object instance whereas the expression on the
right can be any kind of expression. For the expressions on the right you can use static path expressions,
for example, if you want to keep a copy of a reference to static query metadata. The default assignment
uses copy semantics.

You cannot use chained assignments, that is, a = b = c.

You can also assign node instances on the right to associations on the left. The node instances on the right
can either be a newly created node instance or a node instance that has been retrieved through a query.
However, this kind of assignment is only possible for modeled associations with [1,1] multiplicity. Node
instances to [1,n] associations, which are implemented and not modeled, are assigned implicitly when new
node instances are created through create-enabled associations.

Example name = this.Name;

7.2.4.6 Association Access (Business Logic)

Syntax <root entry>.<association name>[.<path expression>];

Description The association access is a special form of the path expression. Associations can be defined to be optional
and the multiplicity can be [0,1], [1,1] or [1,n]. By following an association, you are able to read data that
has been modified but not yet been stored in the database.
There are the following categories of associations: Compositions, intra-business-object associations,
cross-business-object associations and cross-deployment-unit associations. Compositions are
automatically generated associations implemented to allow navigation of the business object node
structure (that is, ToParent, ToRoot, navigation to subnodes). Due to the generated association
implementation, compositions support the [1,n] multiplicity.
Intra-business-object associations link nodes within one business object. Cross-business-object
associations link nodes of separate business objects. Intra and cross-business-object associations can
only have the [1,1] multiplicity.

To exchange data between business objects that are located in different deployment units,
configure an internal communication by using the Service Integration Wizard. For more information,
see Configure Internal Communication [page 523].

When accessing a [1,n] composition, a collection of nodes is returned. Therefore, you cannot access a
member of structured data types of the foreign business object nodes. Instead, you must use the
foreach loop statement to access the individual instances in the returned node collection (see the second
example below).
If the operand on the left of an assignment is an association access path expression followed by an element,
data can also be written to the foreign business object node instance.
If the node type matches the target definition of the association (see the third example below), you can
associate a foreign business object node instance that was just created.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 215
Example ● Intra or cross-business-object association write access ([1,1] multiplicity):
this.AssocToOtherBONode.Value = 42;
● Composition association access ([1,n] multiplicity).
foreach (var item in this.Items) {
totalValue = totalValue + item.ItemValue;
}
● Associate node instance to current node ([1,1] multiplicity):
this.AssocToBONode = <node instance>;
The node instance, for example, is retrieved by a query.

7.2.4.7 Business Object Lifecycle (Business Logic)

Reading a business object node instances can be performed by either following an association or executing a query.
Updates are simply handled by assignment statements; the path expression on the left points to an element of a
business object node instance. The changes are automatically committed to the context business object once the
script file completes the execution without errors.
The following methods are available for the business object lifecycle:
● Create Instance [page 219]
● Create with Reference Action [page 220]
● Query Execution [page 229]
● Retrieve Instance [page 233]
● Delete Instance [page 222]
● Check Node Existence(IsSet) [page 216]

7.2.4.8 Check Associations (Business Logic)

Syntax <path expression>.<association name>.IsSet();

Description You can use the IsSet () method for [1,1] or [0,1] associations to check whether the association was
set before. Otherwise any access to an association that was not set causes a runtime error.

Example var targetNode = this.ToTarget;

if (this.ToTarget.IsSet()) {
this.Name = "Assoc set to: " + targetNode.Name;
} else {
this.Name = "Assoc not set.";
}

7.2.4.9 Check Node Existence (Business Object)

Syntax <node instance>.IsSet();

SAP Cloud Applications Studio – Version May 2018 (1805)

216 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Description This method is analogous to the IsSet method for checking associations. However, the IsSet method
for checking node existence checks the node references themselves. You can use this method to check if
a new node instance was successfully created.

Example var newBO = BOName.Create();

if (!newBO.IsSet()) {
raise CreationFailed.Create("E");
} else { … }

7.2.4.10 Clear Method (Business Logic)

Syntax <collection> | <variable>.Clear();

Description You can use the Clear method for the following scenarios:
● If you have created a collection, you can use this method to remove all rows from the collection.

This method cannot be applied to read-only collections. This is relevant for code related to
form data type extensions and in case of mass-enabled script files, in which the this keyword
represents an immutable collection of nodes.

● You have declared a variable by using the elementsof modifier and you pass initial values to
subelements of the business object node. In this case, you can use the Clear method to remove the
initial values from the subelements.

Example Remove all rows from a collection:

var coll : collectionof Opportunity.Item;
coll.Clear();
Remove initial values from subelements:
var struct : elementsof MyBO;
struct.ID = "3865";
struct.SubID = "27";
struct.Clear();

7.2.4.11 Collection Definition (Business Logic)

Syntax var <variable name> : collectionof <static path expression> | <data type>;

Description If you define a collection explicitly, the collection's row type is inferred from the static path expression, for
example, a business object node, or the row type is based on an unstructured data type.

Example var collection : collectionof ExampleBO.Status;

var collection : collectionof elementsof Opportunity.Item
var collection : collectionof LANGUAGEINDEPENDENT_Text;
//To use the "LANGUAGEINDEPENDENT_Text" GDT , you need to import the
AP.common.GDT namespace first

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 217
7.2.4.12 Collection Handling (Business Logic)

A collection is a standard table that is defined on the basis of business object nodes or node elements, for example,
a collection of opportunities. Collections are generated when instances of business object nodes are returned by the
system. You can obtain a collection of business object nodes in several ways, for example:
● You follow [1,n] composition associations. For more information, see Association Access [page 215].
● You execute a Create with reference action with a collection parameter. For more information, see Create
with Reference Action [page 220].
● You execute a business object node query. For more information, see Query Execution [page 229].

Besides collections generated by the system, you can also define a collection explicitly.
The collection handling methods generally apply their logic to a copy of the collection and return a modified copy of
the original collection. Therefore these methods declare a collection as return value. However, the Add method and
the Clear method behave in a different way. They modify the collection to which they are applied. These methods do
not have any return value.

If you use a method to add or clear a collection or a row in a collection, this only has an impact on the collection
itself. To delete or create new business object nodes, use the Delete or Create operation for business objects.
For more information, see Business Object Lifecycle [page 216].

The following methods are available for collections:

● Collection Definition [page 217]
● Add to Collection [page 214]
● Clear Collection [page 217]
● Sort Collection (OrderBy) [page 236]
● Filter Collection (Where) [page 222]
● Remove from Collection [page 232]
● Remove Duplicate Rows from Collection (DistinctBy) [page 232]
● Get First or Get Last Row of Collection [page 224]
● Get Empty Row of Collection (GetEmptyLine) [page 224]
● Count Rows of Collection [page 219]

7.2.4.13 Conditional Expressions (Business Logic)

Syntax <arithmetic expressions> == | != | < | > | <= | >= <arithmetical

expression>

Description Conditional expressions evaluate Boolean values. The supported operators are shown in the syntax above.
Use arithmetic expressions as operands, which can also be atomic expressions, such as literals, variable
identifiers, and path expressions.

Example if (fulfillment >= 0.8 && fulfillment < 1.0) { … }

SAP Cloud Applications Studio – Version May 2018 (1805)

218 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
7.2.4.14 Continue Statement and Break Statement (Business Logic)

Syntax <loop statement> {

[ <statement>* | continue; | break; |
<complex statement> { [ continue; | break; ] ? } ]*
}

Description The continue statement and the break statement can be used within the code block of loop statements,
such as foreach and while statements.
The break statement immediately exits the enclosing loop statement. The continue statement quits the
current loop iteration and continues with the next iteration at the top of the code block of the enclosing
loop statement. In nested loop statements, however, the break statement only exits the inner loop.
Usually you need to embed the continue statement or the break statement into an enclosing if condition in
order to avoid endless loops or a forced single loop execution.

Example foreach (node in query.Execute()) {

count = count + 1;
if (count < 3) continue;
if (count > 5) break;
node.SomeAction();
}

7.2.4.15 Count Rows (Business Logic)

Syntax <intVar> = <collection>.Count();

Description If you use the Count method, the system returns the number of rows in a collection.

Example var coll : collectionof SalesOrder.Status;

var counter;
counter = coll.Count();

7.2.4.16 Create Instance (Business Logic)

Syntax Static creation of business object (root node):

<business object name>.Create ([<node data>]);
Node creation through association that is create-enabled:
<this | NodeInstanceVar>.<association name>.Create ([<node data>]);

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 219
Description You can use the Create method for the following:
Declarations ● Use the method to create complete business objects (that is, the root nodes) in a static manner.
● You can also use the method to create subnodes of existing business objects, for example, through
composition access because this access implicitly maintains the association relationship between
the parent and root node. The Create method binds to static member path expressions that identify
a business object node. It also binds to associations that are create-enabled, for example,
compositions or intra-business-object associations. In compositions, the parent node instance is
automatically derived from the preceding path expression and is used for the composition
maintenance.
The instance-based Create method for subnode creation is not available for variables that are
derived from association access because in this case the parent node cannot be reliably
determined.
● Optionally, you can also provide node data to the Create method as a parameter. When provided,
this data is automatically copied to the newly created node instance. The parameter type is the
complete element structure of the node. You can infer the node element type as part of the variable
declaration by identifying a certain node through a static path expression. For more information,
see Declarations [page 221].

You can also assign the data to the node instance after the node has been created. However, if you create
instances of SAP business objects, for some of the business objects you must provide default values in the
parameters at the time the business objects are created.

Example var newBO = TestBO.Create();

var itemData : elementsof TestBO.Items;
var newItem;
itemData.ItemName = "Test";
itemData.ItemValue = 42;
newItem = this.Items.Create(itemData);

7.2.4.17 Create With Reference Action (Business Logic)

Syntax <business object name>[.<node name>].<CWR action name>(SomeNode|

NodeCollection)([<param>]*);

Description The Create with reference (CWR) action is a special type of action that can only be executed statically and
that directly returns one or more instances of the node to which the action belongs. All CWR actions are
overridden to offer two signatures, one with a single node parameter and one with a collection of nodes.
CWR actions return a single node or a collection of nodes depending on the collection property of the
method call parameter.

CWR actions can only be used by SAP business objects.

SAP Cloud Applications Studio – Version May 2018 (1805)

220 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Example import AP.CRM.Global;
var salesOrders = SalesOrder.QueryByElements.Execute();
var allSOsCopied = SalesOrder.Copy(salesOrders);
var singleCopiedSO;
foreach (var so in salesOrders) {
singleCopiedSO = SalesOrder.Copy(so);
break;
}

7.2.4.18 Declarations (Business Logic)

Syntax var <variable name> [: collectionof? elementsof? <static path expression>

| <data type>]?[= literal | <path expression>]?;

Description The implementation language is a statically-typed language that allows you to use declared variables only.
You always need to declare the variable before you can use it in a statement. If you declare a variable within
a code block (so-called variable scoping), that is, within the braces ({...}), the scope of this variable is limited
to this code block.

Variable shadowing is not supported, that is, variables cannot reuse names that are already declared
in an enclosing scope.

The variable type is automatically inferred upon first assignment of the variable. You can assign an initial
value either by specifying a literal or by specifying a path expression, that is, elements of other already
existing variables or elements of the this context. Assignments use copy semantics, that is, a temporary
copy is created when individual elements are accessed using the this context. Node variables have
reference semantics.
Alternatively, you can explicitly specify the variable type in the variable declaration. For this, you can use
basic data types as well as global data types (GDTs).
You can also derive the underlying type of a business object node by using the elementsof modifier followed
by a static path expression that identifies a business object node. This is useful if you define initial node
data that can be passed as a parameter to the Create operation of a business object node. Do not use the
elementsof modifier if you want to derive the type of an element from a static path expression.

Example var counter = 0;

var amount : Amount;
//To use the "Amount" GDT , you need to import the AP.Common.GDT namespace
first
var strVar = "test";
var strVar : LANGUAGEINDEPENDENT_Text;
//To use the "LANGUAGEINDEPENDENT_Text" GDT , you need to import the
AP.common.GDT namespace first
var boolVar = true;
var name = this.Name;
var nodeData : elementsof ExampleBO.Item;
var nodeData : ExampleBO.Item.Element;
var coll : collectionof ExampleBO.Item;
var coll : collectionof elementsof ExampleBO.Item;

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 221
7.2.4.19 Delete Instance (Business Logic)

Syntax <this | NodeInstanceVar>.Delete();

Description The Delete operation, which uses the inverse semantics of the Create operation, can only be called in the
instance-based variant and must be applied to business object nodes. The reason is that the instance to
be deleted must be identified by the preceding member path expression. The Delete operation can also be
applied to collections of business object nodes.

Example foreach (var BO in TestBO.QueryByElements.Execute()) {

if (BO.Name == "delete") {
BO.Delete();
}
}
Deletion of a collection of nodes:
TestBO.QueryByElements.Execute().Delete()

7.2.4.20 Filter Collection (Business Logic)

Syntax <collection A> = <collection B>.Where(<logical expression>);

Description You can use the Where method to filter a collection in order to return only the rows that meet the criteria.
This method returns a new collection, for example, collection A, which contains a subset of the source
collection, for example, collection B.

Example In the following example, the collection collB is the result of a query that was executed previously:
var mySearchValues : elementsof myBO.Item;
var collA;
mySearchValues.ItemID.content = "Bill";
collA = collB.Where(n => n.ItemID != mySearchValues.ItemID ||!
(n.ItemID.content < 1000 && n.ItemID.content == "Fred"));
var collStrings : collectionof LANGUAGEINDEPENDENT_Text;
//To use the "LANGUAGEINDEPENDENT_Text" GDT , you need to import the
AP.common.GDT namespace first
var collStringsResult;
collStringsResult = collStrings.Where( n => n == "Fred" );
collStringsResult = collStrings.Where( n => n.StartsWith( "Fred" ) );

7.2.4.21 Foreach Loop Statement (Business Logic)

Syntax foreach (var? <identifier> in <path expression>) {

<statement list>
}

SAP Cloud Applications Studio – Version May 2018 (1805)

222 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Description The foreach loop statement allows you to iterate over collections of any type.
Variables that are used in a foreach statement are called loop variables. They have different semantics
depending on the way they are declared:
● Declaration of loop variable before the foreach statement:
If a loop variable is declared before the foreach statement, the variable type must match the row
type of the collection. In this case, the loop variable is defined in the scope outside of the foreach
statement and can therefore also be accessed after the foreach statement. If the loop variable refers
to a collection of data types, the variable has value semantics, that is, it is a copy of the original data
of the collection element in the current iteration. Therefore the original data in the collection cannot
be changed.
If a loop variable refers to a collection of business object nodes, the variable has reference
semantics, that is, you can always change the data of the collection elements.
● Explicit declaration of loop variable as part of the foreach statement
If you declare a loop variable within the foreach statement using the var keyword, the scope of the
variable is limited to this code block, that is, to the code within the braces of the statement.
Therefore the data of the last loop iteration cannot be accessed via the variable outside of the
foreach code block.
A loop variable that is declared explicitly within the foreach statement always has reference
semantics, even if the variable refers to a collection of data types. This means that the original data
of the collection elements can be changed. This is particularly useful for form data type extensions
in the following case: a data type with a sub-element that is a collection is passed in as the
FormData parameter and you want to change existing data in the collection elements. The loop
variable itself, however, is immutable.

The statements within the foreach body can make use of the loop variable to access the instance of the
current iteration. For information about how to obtain collections of business object nodes, see Collection
Handling [page 218] .

Example var node;

foreach (node in query.Execute()) {
count = count + 1;
if (count < 3) continue;
if (count > 5) break;
node.SomeAction();
}
Example for form data type extension:
foreach (var elemData in FormData.CollectionSubElement) {
elemData.Element = "New Value";
}

7.2.4.22 Function Literals (Business Logic)

Syntax Applicable in collection handling when you use the OrderBy and DistinctBy methods:
<function parameter name> => <function parameter name>.<method or
property of inferred type>
Applicable in collection handling when you use the , Where and Remove methods:
<function parameter name> => <function parameter name>.<method or
property of inferred type> <arithmetic expression>

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 223
Description You can only use function literals in the following collection handling methods: Where [page 222], OrderBy
[page 236], DistinctBy [page 232], and Remove [page 232].
A function literal is an expression that defines an unnamed function. Function literals use the lambda
operator (=>), which reads as "goes to". The left side of the lambda operator specifies the input parameter,
the type of which is inferred from the last item of the path expression. The right side of the lambda operator
holds the statement. In OrderBy methods and DistinctBy methods, the statement is a path expression and
in Where methods and Remove methods the statement is a comparison. In all these cases, the path
expression must specify a structured element.

Do not use a function parameter name that you have already used for a declared variable. For more
information, see Declarations [page 221].

Example var myCollection : collectionof TargetBO;

myCollection = this.ToNAssoc.Where(n => n.elementX == "Yes");
You can achieve the same result by using a foreach loop statement:
var myCollection : collectionof TargetBO;
foreach (var i in this.ToNAssoc) {
if (i.elementX == "Yes") { myCollection.Add(i); }
}

7.2.4.23 Get First or Last Row (Business Logic)

Syntax <collection row> = <collection>.GetFirst();

<collection row> = <collection>.GetLast();

Description Use the GetFirst or GetLast method to return the first or last row of a collection.

Example var coll : collectionof Opportunity.Item;

var first;
var last;
first = collection.GetFirst();
last = collection.GetLast();

7.2.4.24 If Control Statement (Business Logic)

Syntax if (<logical expression>) {<statement list>}

[ else if (<logical expression >) {<statement list>} ]*
[ else {<statement list>} ]?

Description The if statement is a control statement. Depending on the result of the logical expression, the system
executes or skips the statement block. Optionally, else if and else subclauses can be used.

SAP Cloud Applications Studio – Version May 2018 (1805)

224 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Example Bonus calculation:
if (fulfillment >= 0.8 && fulfillment < 1.0) {
bonus = this.Actual.content * 0.1;
}
else if (fulfillment >= 1.0) {
bonus = this.Actual.content * 0.15;
else { bonus = 0; }
}

7.2.4.25 Import (Business Logic)

Syntax import <namespace component>[.<namespace component>]*;

Description The import keyword imports business objects or reuse libraries from namespaces that are available in the
studio in the Repository View. Imports have to be defined at the very top of a script file. You can only import
complete namespaces but no individual entities. If there are naming conflicts between different entity types
in the same namespace, for example, if a reuse library has the same name as a business object, you must
fully qualify the name upon usage.
The namespace syntax in the scripting language is different to the namespace representation in the
Repository View. In the scripting language, the constant http://sap.com/xi prefix of the URL-based
namespaces is omitted and the slash mark (/) is replaced by a period (.).
Imported business objects can be statically accessed by typing the business object name as the root
identifier of a path expression. The local namespace of the solution is imported implicitly, that is, local
business objects can be accessed without an import statement.

If you use more than one namespace, we recommend that you define an alias for each imported
namespace and qualify business objects or data types from these namespaces by using the aliases.
For examples, see Name Qualification [page 227].

Code completion is available for the namespace import, as well as for the static access of imported business
objects and reuse libraries. The code completion for the namespace import always offers the required
amount of subsequent path elements in order to complete the namespace so that the corresponding
entities can be accessed, for example, business objects or reuse libraries.

Example import ABSL;

import AP.CRM.Global as CRM;

7.2.4.26 Literals (Business Logic)

Syntax "<literal string>" | true | false |

[+|-|? DecDigit* .? DecDigit+ [ e|E [+|-]? decDigit ]?;

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 225
Description The following literals can be used:
● Literal strings that are included in quotation marks ("..”)
● Numeric literals, that is, positive and negative integers and floating points
● The Boolean values true and false

You can use a literal, for example, as an expression on the right of an assignment or as a parameter of a
method call in a path expression.
In a literal string, you can use a backslash (\) to escape characters, such as carriage returns or quotation
marks (“). You can use the following escape sequences:
● \n (new line)
● \r (carriage return)
● \t (tab)
● \v (vertical tab)
● \f (form feed)
● \\ (backslash)
● \” (quotation marks)

Example var counter = 0;

var strVar = "test";
var escapedStringVar = "FirstLine\nSecondLine";
this.ActionName(true);

7.2.4.27 Logical Expressions (Business Logic)

Syntax [!]? <conditional expression> [ && | || [!]? <conditional expression> ]*

Description The logical operators AND (&&) and OR (||) always evaluate the overall expression to a Boolean value. The
operands themselves are conditional expressions, which in turn are comprised of arithmetic expressions,
finally breaking down to atomic expressions, such as literals, variable identifiers, and path expressions.
You can also use the NOT operator (!) combined with brackets to override the precedence default value of
subexpressions.

Short circuit evaluations are not supported. That is, if in a logical AND or OR expression the value
of the first operand is sufficient to determine the result of the operation, the second operand is still
evaluated.

Example if (fulfillment >= 0.8 && fulfillment < 1.0) { … }

check = !(this.Element > 42);

SAP Cloud Applications Studio – Version May 2018 (1805)

226 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
7.2.4.28 Name Qualification (Business Logic)

Syntax <object type 1>::<alias for namespace>:<path element>.<object type

2>:<path element>;
Valid entries for <object type 1>: BusinessObject, Library (= reuse library or Web service), Message
Valid entries for <object type 2>: Node, Query, Action, Association, Element, Function (=
built-in function), LibraryFunction (= reuse service or Web service operation)

Description Usually, you can address the imported objects directly by their names instead of using fully qualified names.
However, if more than one object type (for example, a business object node, query, association, or action)
is declared with the same name, you need to fully qualify the objects in order to make them unambiguous.
This is necessary, for example, in the following cases:
● Two namespaces are imported that contain business objects with the same name.
● You have created a business object with the same name as an SAP business object. To reference
the SAP business object, you need to enter the fully qualified name of this business object including
its namespace alias. Without mentioning the namespace, the system will choose your business
object instead of the SAP business object.
● You want to access a business object that has the same name as a reuse service or a message.
● A node name in one business object is the same as a query name in the same business object on
the same level.

If the system discovers such a naming conflict, you can either use code completion to insert the correct
path expression or enter it directly by using two colons (::).

Example Fully qualifying names because two namespaces contain business objects with the same name:
import AP.CRM.Global as CRM;
var sapSalesOrder : CRM:SalesOrder;
var mySalesOrder: SalesOrder;
Fully qualifying names because there are nodes, elements or associations within the same name:
import ABSL;
import AP.FinancialAccounting.Global as fin;
var costObject : fin:FinancialAccountingViewOfCostObject;
var descriptionNodeElements : elementsof
fin:FinancialAccountingViewOfCostObject.Node::Description;
var description :
fin:FinancialAccountingViewOfCostObject.Element::Description;
costObject = fin:FinancialAccountingViewOfCostObject.Create();
descriptionNodeElements.Description.content = "A Description";
descriptionNodeElements.Description.languageCode =
LanguageCode.ParseFromString("EN");
costObject.Association::Description.Create(descriptionNodeElements);
description = costObject.Element::Description;

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 227
7.2.4.29 Path Expressions (Business Logic)

Syntax <root item>[.<data type element> | business object node feature | method
name [ ( <param>* ) ] ]*
Path expression containing a library function parameter (for example, of a reuse library service) for use in
a variable declaration:
<library>.<library function>.<param>.<...>

Description Path expressions can be used for the following:

● Node elements
● Associations
● Method calls
● Type of variables

Path expressions always start with a root item. The root item can be a variable identifier, the this context,
a static access to an imported business object or a reuse library, as well as a message declared in the
business object definition.
If the root item is a variable of a structured data type, the path expression addresses subelements of this
data type. If the this context and imported business objects are used, all supported business object node
features can be addressed through the path expressions. The business object node features are element
and subelement access, associations, queries, actions, including Create with reference [page 220]
actions, and the Create Instance [page 219] operation and the Delete Instance [page 222] operation. If
the root item is a reuse library or a Web service (library), you must add the reuse service or Web service
operation (library function) and at least the parameter. If the parameter is of a structured type, the
path expression can also include the elements and subelements of this type.
Associations are instance-based and they can therefore only be followed by the this context and by
variables that are typed as business object nodes. In contrast, queries are static entities that have to be
retrieved and executed based on imported business objects. As an action can have the multiplicity [0,0],
[1,1], or [1,n], a query can either be accessed statically or instance-based, which depends on the multiplicity.
For the execution of an action, you can provide parameters to the action method call in the same way as
you can provide parameters for the execution of any reuse library service.
Methods and complete reuse libraries can be bound to certain data types and are then automatically offered
in the code completion. In addition to actions that are defined as part of the business object model and that
belong to a certain business object node, there are also various methods that are available for all
unstructured data types, for example, theToString method.

Example var product = this.ProductName;

var y : CurrencyConversion.Add.TargetCurrencyCode;

7.2.4.30 Process Context (Business Logic)

Syntax <path expression to node>.GetProcessContext().<process context field>;

SAP Cloud Applications Studio – Version May 2018 (1805)

228 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Description Within an .absl file related to service integration, you can use the GetProcessContext method for
every accessible node instance. The process context itself offers change notifications for all changed
reference business object instances and all already evaluated conditions of the reference business object
root node instances.
For the root node of the reference business object, the process context provides the Boolean field
IsActiveInProcess.
The following change notification fields are available for all accessible nodes (including nodes that are
accessed through associations):
● IsCreated
● IsUpdated
● IsDeleted

The following evaluated conditions are available for the root node of the reference business object:
● IsStarted
● IsChanged
● IsCancelled

These conditions return the default condition evaluation result for the root node of the reference business
object.

Example var isActive = this.SubNode.GetProcessContext().IsActiveInProcess;

7.2.4.31 Query Execution (Business Logic)

Syntax <query>.Execute ([<SelectionParameters>]);

<query>.Execute (<SelectionParameters>, [SortingParameters],
[<MaximumRows>], [StartRow]);
<query>.ExecuteDataOnly ([<SelectionParameters>]);
<query>.ExecuteDataOnly (<SelectionParameters>, [SortingParameters],
[<MaximumRows>], [StartRow]);
<query>.ExecuteFromDB ([<SelectionParameters>]);
<query>.ExecuteFromDB (<SelectionParameters>, [SortingParameters],
[<MaximumRows>], [StartRow]);
<query>.Count ([<SelectionParameters>]);
<query>.CreateSelectionParams ();
<selection parameter collection>.Add(<QueryParameterPath>, <Sign>,
<Option>, <LowValue>, [<HighValue>]);
<selection parameter collection>.Add(<QueryAssociationPath>,
<NodeInstance>);
<query>.CreateSortingParams ();
<selection parameter collection>.Add(<QueryElementPath>);
<selection parameter collection>.AddDescending(<QueryElementPath>);

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 229
Description You can execute queries to search and retrieve data from business object nodes that is stored in the
database. A query is identified by a static path starting with the name of the business object followed by
the name(s) of the node(s) and the name of the query. For more information, see Queries [page 351].
Execute Function
The Execute function of a query returns a collection of instances of the node to which the query is bound.
Queries can be executed directly with no further parameters specified. Usually, you provide selection
parameters to narrow down the result set as much as possible to the desired node instances by defining
appropriate filtering criteria. The instances returned by the Execute function overwrites any unsaved
changes performed by script files before calling Execute.

A query does not take data into account that has been created or changed but has not yet been
saved to the database.

Selection Parameters
Each query defines a set of selection parameters. There may be selection parameters that are not part of
a node’s element structure. Selection parameters are passed as a collection to the query. You can create
an empty selection parameter collection by using the CreateSelectionParams function defined for
the corresponding query. You can also add selection parameters to the collection by using the Add function.
Add requires the following parameters:
● QueryParameterPath identifies a query parameter, for which you define the selection
parameter. QueryParameterPath is a path expression that starts with the query variable
describing the same query that was used to create the selection parameters. It is either followed
by a parameter name or, in case the parameter is structured, by an element path. The complete
path must always point to an unstructured parameter.
● Sign defines whether the selection shall be included in the result set ("I") or excluded from the
result ("E").
● Option is an operator used to compare the values defined in the selection parameters with the
actual values in the business object nodes. Possible values are:

Possible values for the Option parameter and what they mean

EQ = Equal NE = Not equal

GE = Greater or equal LE = Less or equal

GT = Greater LT = Less

CP = Contains pattern NP = Does not contain pattern

BT = Between NB = Not between

● LowValue and HighValue define the actual filter values. HighValue is optional and you can
use it for options that allow for ranges, that is, "BT" or "NB". You can either define these values by
specifying literals or by supplying variables or elements of node instances (for example, by using
this.<ElementName>). The type of the provided values must match the type of the specified
query parameter structure element. Please note that he system does not perform an implicit type
conversion.
The values of the options "CP" and "NP" are patterns that can include the wildcard characters "*"
or "+". You can escape a wildcard character by using the "#" character.

There are cases where you need to query for all instances of a business object node that have an association
to a certain instance of another business node. This you can do by adding a selection parameter for the
source foreign key element of the association. The source foreign key elements of custom business objects
are generated implicitly by the system and cannot be accessed by the script code. However, if you need to
access the source foreign key elements, you can use the association name to define a selection parameter.
For this purpose, the Add function has an additional signature with only two parameters:
● The QueryAssociationPath parameter identifies an association (that is, its foreign key
element) for selection. QueryAssociationPath is a path expression that starts with the query
SAP Cloud Applications Studio – Version May 2018 (1805)
230 © 2018 SAP SE. All rights reserved.
variable describing
• PUthe
B Lsame
I C query as the one that was used to create the selection parameters.
Scripting Languages

The path expression is followed by an association name. Please note that the system supports only
foreign key associations defined at the same node where the query is defined.
Example Definition of business object QueryExample:
import AP.Common.GDT as apCommonGDT;
businessobject QueryExample
{
[AlternativeKey]
element Number : IntegerValue;
element NextNumber : IntegerValue;
element Period : DatePeriod;
element Class : ClassificationCode; // custom code list data type with
values ALPHA and BETA
association ToOtherBusinessObject to Target;
action Test;
}
Definition of business object Target:
import AP.Common.GDT as apCommonGDT;
businessobject Target
{
[AlternativeKey]
element ID : ID;
}
Script code to demonstrate various options to execute queries:
import ABSL;
// get the default query of QueryExample
var query = QueryExample.QueryByElements;
// 1a) Select all instances
// type of resultData is: elementsof BusinessObject::QueryExample
// which allows for direct modifications, access to associations or
actions, for example: result.GetFirst().Test();
var result = query.Execute();
// 1b) Select data of all instances
// type of resultData is: elementsof BusinessObject::QueryExample
// which just includes business object node data and therefore is faster
than 1a)
var resultData = query.ExecuteDataOnly();
// 1c) Count all instances
var rowCoumt = query.Count();
/*
Let's assume that the following instances of the QueryExample business
object exist on the data base. The result variable as well as the
resultData variable have already been filled with data of all instances
at this point in time:

row Count is 4
*/
// 2) Select a range of Period.StartDate
var startDate1 = Date.Create(2013, 02, 01);
var– Version
SAP Cloud Applications Studio startDate2 = Date.Create(2013, 05, 01);
May 2018 (1805)
Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved.
var selectionParams = query.CreateSelectionParams(); 231
selectionParams.Add(query.Period.StartDate, "I", "BT", startDate1,
startDate2);
7.2.4.32 Raise Message (Business Logic)

Syntax raise <message name>.Create(<severity> [, <message text variable>]*);

Description You can use the raise keyword to raise messages that have been declared in the business object definition.
When you use the Create method, an instance of a message is created that is automatically bound to the
message type.
The Create method has one mandatory parameter: the severity. You have to supply the severity as a string:
● "E" for errors
● "W" for warnings
● "S" for success messages

As additional optional parameters you can supply the values for placeholder variables as declared in the
message text. The type of these values is ANY.
You do not need to import messages if they are declared in the business object definition. They are then
automatically available in the code completion of the current context.

Example raise MissingTest.Create("E", this.ObjectID);

7.2.4.33 Remove Duplicate Rows (Business Logic)

Syntax <collection A> = <collection B>.DistinctBy(<function

literal>).ThenBy(<function literal>);

Description You can use the DistinctBy method to delete duplicate rows in a collection according to the specified criteria.

Example var collMyCampaigns : collectionof Campaign;

var result;
result =
collMyCampaigns.DistinctBy( n=>n.Status.LifeCycleStatusCode ).ThenBy( m=
>m.PlannedStartDate );
var collStrings : collectionof LANGUAGEINDEPENDENT_Text;
//To use the "LANGUAGEINDEPENDENT_Text" GDT , you need to import the
AP.common.GDT namespace first
var collStringsUnique;
collStringsUnique = collStrings.DistinctBy( n=>n );

7.2.4.34 Remove from Collection (Business Logic)

Syntax <collection A> = <collection B>.Remove(<logical expression>);

Description You can use the Remove method to remove those rows from the collection that meet the criteria. This
method returns a new collection, for example, collection A, which contains a subset of the source collection,
for example, collection B.

SAP Cloud Applications Studio – Version May 2018 (1805)

232 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Example In the following example, the collection collB is the result of a query that was executed previously :
var mySearchValues : elementsof myBO.Item;
var collA;
mySearchValues.ItemID.content = "Smith";
collA = collB.Remove(n => n.ItemID != mySearchValues.ItemID &&
n.ItemID.content != "Miller");

7.2.4.35 Reset Associations (Business Object)

Syntax <path expression>.<association name>.Reset();

Description This method allows you to reset an association. If, for example, a target node instance has been deleted by
following the association, you must reset the association because the references that point to the deleted
business object are not cleared automatically. Therefore, such invalid references must be explicitly deleted
and every access to an association must be secured by a previous IsSet check call. For information about
the IsSet check for associations, see Check Associations [page 216].
The Reset method can only be applied to foreign key associations and is not available for variables that
are derived from association access.

Example var targetNode = this.ToTarget;

if (targetNode.IsSet()) {
targetNode.Delete();
this.ToTarget.Reset();
}

7.2.4.36 Retrieve Instance (Business Logic)

Syntax <node instance> = <business object>.Retrieve(<alternative key>);

<collection of node instances> = <business object>.Retrieve(<collection
of alternative keys>);

Description You can use the Retrieve method to read the data of a single node instance or a collection of node instances
of a business object. The Retrieve method enables you to read data that has been modified but not yet been
stored in the database.
As parameters for the method, you can pass a single alternative key or a collection of alternative keys,
which have been declared as variables. The variables, which contain the alternative key values, need to be
of the same type as the alternative keys specified in the business object. If the method is used for a collection
of node instances, it returns a new collection.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 233
Example Definition of alternative key in business object:
businessobject BonusPlan {
[AlternativeKey] element SO_ID : BusinessTransactionDocumentID;
}
Script file:
var elementID : xyz.SO_ID;
var collectionID : collectionof xyz.SO_ID;
var retrieveColl;
var retrieveSingle;
elementID.content = "5000000002";
retrieveSingle = SalesOrder.Retrieve(elementID);
collectionID.Add(elementID);
elementID.content = "5000000003";
collectionID.Add(elementID);
retrieveColl = SalesOrder.Retrieve(collectionID);

7.2.4.37 Return Values (Business Logic)

Syntax return <literal> | <path expression>;

Description The use of the return keyword is mandatory in .absl files that were created by using the Service
Integration wizard. The return value has to be of Boolean type.
For each of the four condition evaluations (Relevance, Start, Change, Cancel) that are possible in a service
integration scenario, the Boolean return value must be used to signal the calling process agent about the
evaluation result. To calculate the condition for the current root node instance, you can access the process
context information of this node and its node values.

Example return true;

return this.Count > 7;

7.2.4.38 Script File Parameter (Business Logic)

Description The InReconciliation Boolean indicator specifies conditions that depend on the mode of execution, that is,
the standard message mode or the reconciliation message mode. The reconciliation mode is an error
recovery mechanism that allows it to send a new message, the reconciliation message. This reconciliation
message contains the complete information and cancels all previous erroneous messages.

Example if (InReconciliation) {
...
}
return false;

SAP Cloud Applications Studio – Version May 2018 (1805)

234 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
7.2.4.39 Service Integration Methods (Business Logic)

Service integration allows you to synchronize data between several involved business objects that are located in
different deployment units in an asynchronous way. The business objects exchange the data through XML messages.
You can use the methods listed below to determine for which nodes of the sending business object the data is
transmitted.
Script files can be used for the condition evaluation, which specifies whether the data of a node is part of the cross-
business-object synchronization. Therefore, the .absl files in service integration scenarios support parameters
that are passed in at runtime. Additionally, a Boolean return value is expected that signals to the calling process
agent whether the business object instance is to be considered in the message construction. Furthermore, the
process context is attached to every business object node instance that allows you to check certain status
information related to service integration.
In script files that are executed within a service integration scenario, the context information is read-only. This means
that the system prevents accessible business object nodes and calls of actions from being changed. The information
about the script file signature (that is, the parameters and return values and their corresponding types) is
documented in a comment block at the very beginning of each .absl file. In service integration scenarios,
various.absl file subtypes are involved. This is also documented in the comment.
The following methods are available for service integration:
● Script File Parameter [page 234]
● Return Values [page 234]
● Process Context [page 228]

7.2.4.40 Set Associations (Business Logic)

Syntax <path expression>.<association name> = <path expression>;

Description You can navigate along associations that have been set by the user interface but you can also set associated
node instances explicitly. For this, you can use a simple standard assignment expression that on the left
provides a path expression, whose last element is an association. The path expression on the right must
evaluate to the node type that is expected to be the target node of the modeled association. For such
assignments, you can only use modeled associations with [1,1] or [0,1] multiplicity. The expression on the
right can be, for example, an item of a query execution result or a Create operation.

Example ● Assign node instance retrieved by query execution:

foreach (var item in query.execute(selParams)) {
this.AssocToTarget = item;
break;
}
● Assign newly created node instance:
var data : elementsof TargetBO;
data.Name = "Created";
this.ToTarget = TargetBO.Create(data);

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 235
7.2.4.41 Sort Collection (Business Logic)

Syntax <collection A> = <collection B>.OrderBy(<function

literal>).ThenByDescending(<function literal>).ThenBy ...;
<collection A> = <collection B>.OrderByDescending(<function
literal>).ThenBy(<function literal>).ThenBy ...;

Description You can use the OrderBy or OrderByDescending method to sort a collection in ascending or descending
order according to the specified sorting criteria. By default, collection columns of numeric and byte type
are sorted by their value and columns of string type are sorted as text. You can define the sorting criteria
as action parameters by using a function literal, which refers to the columns of the collection. To define
multiple sorting criteria, add ThenBy or ThenByDescending statements to the expression.

If the row type of a collection is structured, you need to specify the sorting criteria. The sorting
parameters must be an atomic data type, that is, you are not allowed to define a structured attribute
of the collection row type as a sorting parameter. If the row type is unstructured, you can only sort
by row and cannot specify a sorting criteria.
Sorting does not have a permanent effect on business object nodes. Each time a node is read from
the system, all previous sorting results are lost.

Example var collItems : collectionof Opportunity.Item;

var collItemsSorted : collectionof Opportunity.Item;
collItemsSorted =
collItems.OrderBy(n=>n.NetAmount.currencyCode).ThenBy(n=>m.NetAmount.con
tent);
var collStrings : collectionof String;
var collStringSorted;
collStringSorted = collStrings.OrderByDescending( n => n );

7.2.4.42 Switch Control Statement (Business Logic)

Syntax switch ( <expression> ) {

case <expression>) [, <expression>* ] { <statement list> }
[ default { <statement list>} ] ?
}

Description The switch control statement provides a more convenient option to express if.. else if.. code
blocks that evaluate exactly the same field against different values again and again. The switch type is
limited to non-structured data types. The case clause allows for arbitrary expressions, for example, the
use of variables.
The default clause is optional.

Example switch (this.Amount.content) {

case 1, 2 {this.Text = "alt1"; }
case varName.element {this.Text = "alt2"; }
default { this.Text = "initial"; }
}

SAP Cloud Applications Studio – Version May 2018 (1805)

236 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
7.2.4.43 This (Business Logic)

Syntax this.<feature name>;

Description The this keyword defines the context in which the script file is executed. You must use the keyword as the
first member of a path expression that accesses the context. The keyword has the type of the business
object node that the script file is assigned to and, at runtime, points to the current instance of such a
business object node. The keyword can define the root of a path expression, just as imported business
objects do for static access. The this keyword itself is immutable and cannot be modified, whereas the
elements of the node represented by this can be modified.

If you use the this keyword in the coding of a mass-enabled script file, this represents a collection
of business object nodes.

The code completion for the business object node specified by this displays instance-based features such
as node elements, associations and instance-based actions including mass-enabled features. Queries and
static actions are not instance-based and therefore you can address them only through static business
object access.
You can use the GetObjectNodeReference() method along with the this keyword to return the
following information about the business object nodes in a solution:
● Node ID of the relevant business object node
● ObjectTypeCode of the business object
● ObjectNodeTypeCode of the node

Example var name = this.Name;

var ObjNodeRef = this.Item.GetObjectNodeReference();

7.2.4.44 While Loop Statement (Business Logic)

Syntax while (<logical expression>) {

<statement list>
}

Description The while loop statement allows you to execute the statement list in the code body as long as the logical
expression evaluates to true.

Example while (this.StrElement.Length() < 10) {

this.StrElement = this.StrElement + "Test";
if (this.StrElemen.Length() > 7) break;
}

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 237
7.2.5 SAP Reuse Libraries

7.2.5.1 Basic SAP Reuse Libraries

7.2.5.1.1 Basic SAP Reuse Libraries Reference

The basic SAP reuse libraries of the scripting language extend the scope and functions that you use to implement
your business logic in the studio. These “language-near” libraries provide basic functions that are used quite often,
for example, to retrieve context data, such as the current date or time for the current identity.
SAP reuse libraries allow for parameters that are either data types (CDTs or GDTs) or business object node instances.
The return values have to be data types.

To use basic SAP reuse libraries, you need to import the namespace ABSL with the import keyword. For more
information on the import keyword, see Syntax for Implementation of Business Logic [page 210].

The functions of the SAP reuse libraries can always be accessed in a static manner. In addition, most of the libraries
are bound to a certain data type. In this case, the instance of the data type on which the method is executed will be
automatically passed to the method at runtime as the first parameter.

import ABSL;
var globalDateTime = GlobalDateTime.ParseFromString("2008–03–30");
var date = globalDateTime.ConvertToDate():

List of Basic SAP Reuse Libraries

● Context [page 240]
Provides context information, for example, the current time in the time zone of the user or the identity UUID
of the user that is currently logged on.
● Duration [page 250]
Compares durations and performs simple calculations with durations.
● Numeric [page 259]
Provides basic functions for integers and decimals.
● Numeric Character [page 260]
Converts a string into a numeric character.
● Currency Conversion [page 242]
Provides functions for currency-based amounts. For example, you can convert an amount from one currency
into another.
● Quantity Conversion [page 260]
Compares quantities and performs simple calculations with quantities.
● UUID [page 264]
Provides basic functions for UUIDs.
● Language Code [page 257]

SAP Cloud Applications Studio – Version May 2018 (1805)

238 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Converts a string into a language code.
● Date [page 246]
Compares dates, performs simple calculations with dates, and provides further useful date functions.
● Time [page 262]
Compares times and provides further useful time functions.
● Date and Time [page 249]
Converts a string into a date and time value.
● Global Date and Time [page 252]
Compares global date and time values, performs simple calculations with global date and time values, and
provides further useful global date and time functions.
● Local Date and Time [page 257]
Converts local date and time values.
● Local Normalised Date and Time [page 258]
Converts local normalized date and time values.
● Web Service Utilities [page 266]
Calls REST mashup Web services.
● Binary [page 239]
Converts a string to a binary value.
● Number Range [page 258]
Draws numbers from a number range for different object types.
● Change History [page 245]
Retrieves data from a supplied Business Object and its nodes that was changed during the given period based
on the Platform Change Document service.
● Sensitive Personal Data [page 264]
Writes direct access logs when sensitive personal data is read and sent through one of the channels.

7.2.5.1.2 Binary (Reuse Library)

This SAP reuse library contains a function that you can use to convert a string to a binary value.

Binary.ParseFromString

Description Converts a string to a binary value using UTF-8 encoding.

This function supports static calls only.

Example this.Binary.content = Binary.ParseFromString("This is a test string.");

Result: Binary value546869732069732061207465737420737472696E672E

Binary.ParseFromBase64String

Description Converts a Base64 string to a binary value using UTF-8 encoding.

This function supports static calls only.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 239
Example this.Binary.Content = Binary.ParseFromBase64String("This is a Base64
string");
Result: Binary value4E18AC8AC6816AC7BAE2CB6B8A78

Binary.ToBase64String

Description Converts a binary value to a Base64 string using UTF-8 encoding.

This function supports static calls only.

Example var bin = Binary.ParseFromString("This is a string");

Result: Binary value54686973206973206120737472696E67
var base = Binary.ToBase64String(bin);
Result: Base64 string VGhpcyBpcyBhIHN0cmluZw==

7.2.5.1.3 Context (Reuse Library)

This SAP reuse library contains functions that provide context information, for example, the current time in the time
zone of the user or the identity UUID of the user that is currently logged on.

The Context reuse library supports static calls only.

Context.GetCurrentGlobalDateTime

Description Returns the current date and time in Coordinated Universal Time (UTC).

Example this.result = Context.GetCurrentGlobalDateTime();

Result: Current date and time in UTC

Context.GetCurrentIdentityUUID

Description Returns the Identity UUID of the user currently logged on.

Example this.result = Context.GetCurrentIdentityUUID();

Result: Identity UUID of the user currently logged on.

Context.GetCurrentSystemDate

Description Returns the current date in the time zone of the system.

Example this.result = Context.GetCurrentSystemDate();

Result: Current date in the time zone of the system

Context.GetCurrentSystemDateTime

Description Returns the current date and time in the time zone of the system.

Example this.result = Context.GetCurrentSystemDateTime();

Result: Current date and time in the time zone of the system.

SAP Cloud Applications Studio – Version May 2018 (1805)

240 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
Context.GetCurrentSystemTime

Description Returns the current time in the time zone of the system.

Example this.result = Context.GetCurrentSystemTime();

Result: Current time in the time zone of the system.

Context.GetCurrentUserDate

Description Returns the current date in the time zone of the user.

Example this.result = Context.GetCurrentUserDate();

Result: Current date in the time zone of the user

Context.GetCurrentUserDateTime

Description Returns the current date and time in the time zone of the user.

Example this.result = Context.GetCurrentUserDateTime();

Result: Current date and time in the time zone of the user

Context.GetCurrentUserTime

Description Returns the current time in the time zone of the user.

Example this.result = Context.GetCurrentUserTime();

Result: Current time in the time zone of the user

Context.GetCurrentUserLanguage

Description Returns the language specified for the user.

Example this.result = Context.GetCurrentLanguage();

Result: Language specified for the user.

Context.GetCurrentUISwitches

Description Returns the user interface switches (UI switches) of the current solution assigned to the current user.

Example this.result = Context.GetCurrentUserUISwitches();

Result: Table listing the UI switches. The line type of the table is PDI_ABSL_STRING

Context.GetCurrentSystemTimeStamp

Description Returns the time stamp for the current Coordinated Universal Time (UTC) reference time of the system
as a numeric value.

Example this.result = Context.GetCurrentSystemTimeStamp();

Result: Time stamp (numeric value) for the current UTC reference time of the system, for example,
20130314101211.5922640.

Context.GetSystemURL

Description Returns the URL of the system. If the optional parameter SingleSignOn is set to True, the SSO enabled URL
is returned.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 241
Example this.normal_url = Context.GetSystemURL();
this.sso_url = Context.GetSystemURL(true);
Result: Normal URL of the system, for example, https://my012345.sapbydesign.com.
OR
Single Sign On Enabled URL of the system, for example, https://my012345–
sso.sapbydesign.com.

Context.IsProductionTenant

Description Returns True or False depending on the tenant as follows:

● True for Production tenant
● False for others

Example this.result = Context.IsProductionTenant();

Result: True or False depending on the tenant.

Context.GetAssignedBusinessRoles

Description Returns all the assigned business roles for a logged in user.

Example var assignedRolesCollection: Collectionof IdentityBusinessRoleID;

var assignedRoles:IdentityBusinessRoles;
assignedRoles = Context.GetAssignedBusinessRoles();
assignedRolesCollection = assignedRoles.BusinessRoles;
Result: Assigned business roles, for example: Sales Manager, Administrator.

Context.IsPatchSolution

Description Returns True or False depending on the solution as follows:

● True for Patch solution
● False for others

Example this.result = Context.IsPatchSolution();

Result: True or False depending on the solution.

7.2.5.1.4 Currency Conversion (Reuse Library)

This SAP reuse library contains functions that you can use for currency-based amounts. For example, you can
convert an amount from one currency into another.

CurrencyConversion.GreaterEquals

Description Indicates whether or not an amount is greater than or equal to another amount.
You can compare amounts with different currency codes. The result depends on the exchange rate
maintained in the system.

SAP Cloud Applications Studio – Version May 2018 (1805)

242 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Example this.amount1.content = 10;
this.amount1.currencyCode = "EUR";
this.amount2.content = 23;
this.amount2.currencyCode = "EUR";
this.result = this.amount1.GreaterEquals(this.amount2);
Result: False

CurrencyConversion.GreaterThan

Description Indicates whether or not an amount is greater than another amount.

You can compare amounts with different currency codes. The result depends on the exchange rate
maintained in the system.

Example this.amount1.content = 10;

this.amount1.currencyCode = "EUR";
this.amount2.content = 23;
this.amount2.currencyCode = "EUR";
this.result = this.amount1.GreaterThan(this.amount2);
Result: False

CurrencyConversion.LessEquals

Description Indicates whether or not an amount is less than or is equal to another amount.
You can compare amounts with different currency codes. The result depends on the exchange rate
maintained in the system.

Example this.amount1.content = 10;

this.amount1.currencyCode = "EUR";
this.amount2.content = 23;
this.amount2.currencyCode = "EUR";
this.result = this.amount1.LessEquals(this.amount2);
Result: True

CurrencyConversion.LessThan

Description Indicates whether or not an amount is less than another amount.

You can compare amounts with different currency codes. The result depends on the exchange rate
maintained in the system.

Example this.amount1.content = 10;

this.amount1.currencyCode = "EUR";
this.amount2.content = 23;
this.amount2.currencyCode = "EUR";
this.result = this.amount1.LessThan(this.amount2);
Result: True

CurrencyConversion.Equals

Description Indicates whether or not an amount is equal to another amount.

You can compare amounts with different currency codes. The result depends on the exchange rate
maintained in the system.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 243
Example this.amount1.content = 10;
this.amount1.currencyCode = "EUR";
this.amount2.content = 23;
this.amount2.currencyCode = "EUR";
this.result = this.amount1.Equals(this.amount2);
Result: False

CurrencyConversion.Add

Description Adds an amount to another amount.

You can add amounts with different currency codes and define a target currency code. The result depends
on the exchange rate maintained in the system.

Example this.amount1.content = 10;

this.amount1.currencyCode = "EUR";
this.amount2.content = 23;
this.amount2.currencyCode = "EUR";
this.result = this.amount1.Add(this.amount2);
Result: Amount value 33 EUR

CurrencyConversion.Subtract

Description Subtracts an amount from another amount.

You can add amounts with different currency codes and define a target currency code. The result depends
on the exchange rate maintained in the system.
Negative results are allowed.

Example this.amount1.content = 10;

this.amount1.currencyCode = "EUR";
this.amount2.content = 23;
this.amount2.currencyCode = "EUR";
this.result = this.amount1.Subtract(this.amount2);
Result: Amount value -13 EUR

CurrencyConversion.Round

Description Rounds an amount to two decimals.

Example this.amount.content = 10.3754;

this.amount.currencyCode = "EUR";
this.result = this.amount.Round();
Result: Amount value 10.38 EUR

CurrencyConversion.ConvertCurrency

Description Converts an amount into a different currency based on the exchange rate maintained in the system.

Example this.amount.content = 10.3754;

this.amount.currencyCode = "EUR";
this.result = this.amount.ConvertCurrency("USD");
Result: Depends on the exchange rate

SAP Cloud Applications Studio – Version May 2018 (1805)

244 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
CurrencyConversion.SpellAmount

Description Spells out an amount. The integer part and the decimal part of a decimal number are spelled out separately
and returned in the respective fields. If you do not provide the language, the logon language is used as a
default.

Example var spell;

this.Amount1.content = 10.14;
this.Amount1.currencyCode = "EUR";
this.Language = "EN";
spell = this.Amount1.SpellAmount (this.Language);
this.Integer = spell.IntegerValue;
this.Decimals = spell.DecimalPart;
Result: Integer value: “TEN”, decimal part: “FOURTEEN”

7.2.5.1.5 Change History (Reuse Library)

This SAP reuse library contains a function that you can use to retrieve data from a supplied Business Object and its
nodes that was changed during the given period based on the Platform Change Document service.

● Only the data of those elements and nodes of Custom Business Objects can be retrieved which are
annotated with Change History (Business Object) [page 183].
● The data of SAP Business Objects will also be retrieved if those business objects have the Platform
Change Document service enabled by SAP.
● This annotation can also be applied to extension nodes and their elements. However, it cannot be
applied to Extension Elements.
● This annotation does not work for Dependent Objects.

Change History. Read

Description Returns the data from the Platform Change Documents that matches the selection criteria as described
in the note above.
● BusinessObjectName defines the name of the Business Object. If this is a SAP Business Object it
must contain the respective. namespace, e.g,. AP.CRM.Global:Lead.
● NodeID provides the NodeID of the Root node for the requested instance.
● The other four parameters are optional:
○ NodeName: Restricts the result to given node
○ ToChangeDateTime: If no value is given the current date and time is taken
○ FromChangeDateTime: If no value is given 30 days earlier than the ToChangeDateTime is used
○ ChangerUUID: Only the changes made to the respective. user are returned

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 245
Example for SAP // get all changes of SAP Business Object Lead based upon Lead Root node
Business Object ID
// for node Root and date from elements of current node
// made by own user
var myLeadRootNodeId : UUID;
myLeadRootNodeId = …
var currentUser = Context.GetCurrentIdentityUUID();
var myChanges = ChangeHistory.Read( "AP.CRM.Global:Lead",
myLeadRootNodeId,
"Root",
this.FromDateTime,
this.ToDateTime,
currentUser );

Example for // get all changes of Custom Business Object MyOwnBusinessObject based
Custom upon own BO Root node ID
Business Object // for node Root and the last month
// made by anybody
var currentUser = Context.GetCurrentIdentityUUID();
var myChanges = ChangeHistory.Read("MyOwnBusinessObject",
this.GetObjectNodeReference().UUID
"Root");

7.2.5.1.6 Date (Reuse Library)

This SAP reuse library contains functions that you can use to compare dates and to perform simple calculations with
dates. Furthermore, it contains other useful date features, for example, services that you can use to determine the
start or end date of a month related to a specified date.

Date.Create

Description Creates a date.

This function supports static calls only.

Example this.result = Date.Create(30,3,2008);

Result: Date value 20080330

Date.GreaterEquals

Description Indicates whether or not a date is later than or equal to another date.

Example this.date1 = Date.ParseFromString("20100215");

this.date2 = Date.ParseFromString("20100402");
this.result = this.date1.GreaterEquals(this.date2);
Result: False

SAP Cloud Applications Studio – Version May 2018 (1805)

246 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
Date.GreaterThan

Description Indicates whether or not a date is later than another date.

Example this.date1 = Date.ParseFromString("20100215");

this.date2 = Date.ParseFromString("20100402");
this.result = this.date1.GreaterThan(this.date2);
Result: False

Date.LessEquals

Description Indicates whether or not a date is earlier than or equal to another date.

Example this.date1 = Date.ParseFromString("20100215");

this.date2 = Date.ParseFromString("20100402");
this.result = this.date1.LessEquals(this.date2);
Result: True

Date.LessThan

Description Indicates whether or not a date is earlier than another date.

Example this.date1 = Date.ParseFromString("20100215");

this.date2 = Date.ParseFromString("20100402");
this.result = this.date1.LessThan(this.date2);
Result: True

Date.IsBetween

Description Indicates whether or not a date is between two specified date values.

Example this.date1 = Date.ParseFromString("20100215");

this.date2 = Date.ParseFromString("20100330");
this.date3 = Date.ParseFromString("20100402");
this.result = this.date2.IsBetween(this.date1, this.date3);
Result: True

Date.GetDay

Description Returns the day of a date.

Example this.date = Date.ParseFromString("20100215");

this.result = this.date.GetDay();
Result: String value 15

Date.GetWeekday

Description Returns the day of the week of a date.

Example this.date = Date.ParseFromString("20100215");

this.result = this.date.GetWeekday();
Result: Integer value 1 to 7

Date.GetMonth

Description Returns the month of a date.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 247
Example this.date = Date.ParseFromString("20100215");
this.result = this.date.GetMonth();
Result: String value 02

Date.GetYear

Description Returns the year of a date.

Example this.date = Date.ParseFromString("20100215");

this.result = this.date.GetYear();
Result: String value 2010

Date.GetWeek

Description Returns the calendar week of a date.

Example this.date = Date.ParseFromString("20100215");

this.result = this.date.GetWeek();
Result: String value 07

Date.AddDuration

Description Adds a duration to a date.

Example this.date = Date.ParseFromString("20100215");

this.result = this.date.AddDuration(Duration.ParseFromString("P3D"););
Result: Date value 20100218

Date.SubtractDuration

Description Subtracts a duration from a date.

Example this.date = Date.ParseFromString("20100215");

this.result =
this.date.SubtractDuration(Duration.ParseFromString("P3D"););
Result: Date value 20100212

Date.Delta

Description Returns the delta duration between two specified date values.

Example this.StartDate = Date.ParseFromString("20150214");

var OneMonthLater =
this.StartDate.AddDuration(Duration.ParseFromString(“P1M”);
this.DeltaAsMonth = this.StartDate.Delta(OneMonthLater);
this.DeltaAsDays = this.StartDate.Delta(OneMonthLater,true);
Result:
Duration value of DeltaAsMonth =P1M, calculated as 30 days
Duration value of DeltaAsDays =P28D, calculated as 28 days

Date.StartOfMonth

Description Returns the start of the month related to a specified date.

SAP Cloud Applications Studio – Version May 2018 (1805)

248 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Example this.date = Date.ParseFromString("20100215");
this.result = this.date.StartOfMonth();
Result: Date value 20100201

Date.EndOfMonth

Description Returns the end of the month related to a specified date.

Example this.date = Date.ParseFromString("20100215");

this.result = this.date.EndOfMonth();
Result: Date value 20100228

Date.StartOfYear

Description Returns the start of the year related to a specified date.

Example this.date = Date.ParseFromString("20100215");

this.result = this.date.StartOfYear();
Result: Date with value 20100101

Date.EndOfYear

Description Returns the end of the year related to a specified date.

Example this.date = Date.ParseFromString("20100215");

this.result = this.date.EndOfYear();
Result: Date with value 20101231

Date.ConvertToGlobalDateTime

Description Converts a date into a global date and time value.

Example this.date = Date.ParseFromString("20100215");

this.result = this.date.ConvertToGlobalDateTime();
Result: Global date time value 20100215000000

Date.ParseFromString

Description Converts a string into a date. The service accepts both the internal format and the ISO format.

This service only supports static calls.

Example this.date = Date.ParseFromString("20100215");

Result: Date value 20100215

7.2.5.1.7 Date and Time (Reuse Library)

This SAP reuse library contains a function that you can use to convert a string into a date and time value.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 249
DateTime.ParseFromString

Description Converts a string into a date and time value.

This function only supports static calls.

Use this function only when an SAP business object uses the data type DateTime in namespace
http://sap.com/xi/BASIS/Global. However, do not use the DateTime data type in your
own business object definitions.

Example this.dateTime = DateTime.ParseFromString("2008-03-30T10:31:00Z");

Result: Date and time value 2008-03-30T10:31:00Z

7.2.5.1.8 Duration (Reuse Library)

This SAP reuse library contains functions that you can use to compare durations and to perform simple calculations
with durations.

Durations are represented as W3C xsd:duration according to ISO 8601.

Duration.Create

Description Creates a duration.

This function supports static calls only.

Example this.result = Duration.Create(1,0,14,0,0,0);

Result: Duration value P1Y14D

Duration.GreaterEquals

Description Indicates whether or not a duration is greater than or equal to another duration.

Example this.duration1 = Duration.ParseFromString("P3Y");

this.duration2 = Duration.ParseFromString("P5Y");
this.result = this.duration1.GreaterEquals(this.duration2);
Result: False

Duration.GreaterThan

Description Indicates whether or not a duration is greater than another duration.

Example this.duration1 = Duration.ParseFromString("P3Y");

this.duration2 = Duration.ParseFromString("P5Y");
this.result = this.duration1.GreaterThan(this.duration2);
Result: False

Duration.LessEquals

Description Indicates whether or not a duration is less than or equal to another duration.

SAP Cloud Applications Studio – Version May 2018 (1805)

250 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Example this.duration1 = Duration.ParseFromString("P3Y");
this.duration2 = Duration.ParseFromString("P5Y");
this.result = this.duration1.LessEquals(this.duration2);
Result: True

Duration.LessThan

Description Indicates whether or not a duration is less than another duration.

Example this.duration1 = Duration.ParseFromString("P3Y");

this.duration2 = Duration.ParseFromString("P5Y");
this.result = this.duration1.LessThan(this.duration2);
Result: True

Duration.AddDuration

Description Adds a duration to another duration.

The result is not normalized. Normalization can be forced by setting the parameter
ForceNormalization to True.

Example this.duration1 = Duration.ParseFromString("P28DT1H");

this.duration2 = Duration.ParseFromString("P10DT2H");
this.result = this.duration1.AddDuration(this.duration2);
Result: Duration value "P38DT3H"
this.result = this.duration1.AddDuration(this.duration2, true);
Result: Duration value P1M8D

Duration.SubtractDuration

Description Subtracts a duration from another duration.

The subtraction may not have an unambiguous result (the reason is, for example, that some months have
30 days, others have 31 days). In this case, the function will not return a result . The calculation can be
forced by setting parameter ForceCalculation to True. Then the function, for example, constantly
uses 30 days for the duration of each month.

Negative durations are not allowed. Therefore, the first duration value must be greater than the
second duration value.

Example this.duration1 = Duration.ParseFromString("P1M8D");

this.duration2 = Duration.ParseFromString("P10D");
this.result = this.duration1.SubtractDuration(this.duration2);
Result: As the result is ambiguous the function does not return a result. Instead it returns a corresponding
error message.
this.result = this.duration1.SubtractDuration(this.duration2, true);
Result: The function uses 30 days for the duration of each month. The result is the duration value P28D

Duration.ConvertToDays

Description Converts a duration into days.

Example this.duration = Duration.ParseFromString("P1Y14D");

this.result = this.duration.ConvertToDays();
Result: Integer value 379

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 251
Duration.ConvertToHours

Description Converts a duration into hours.

Example this.duration = Duration.ParseFromString("P1Y14D");

this.result = this.duration.ConvertToHours();
Result: Integer value 9101

Duration.ParseFromString

Description Converts a string into a duration

This function supports static calls only.

Example this.duration = Duration.ParseFromString("P1Y14D");

Result: Duration value P1Y14D

7.2.5.1.9 Global Date and Time (Reuse Library)

This SAP reuse library contains functions that you can use to compare global date and time values and to perform
simple calculations with global date and time values. Furthermore, it contains other useful global date and time
features, for example, functions that you can use to determine the start or end of a global date and time of a month.

For GlobalDateTime elements, use the data type GLOBAL_DateTime of namespace http://sap.com/xi/
BASIS/Global.

Some functions include the IsUTC parameter. This parameter indicates whether global date and time is passed in
Coordinated Universal Time (UTC) or to the time zone of the user. This parameter is needed because the user
interface does not pass the date and time in UTC but in the time zone of the user.

GlobalDateTime.GreaterEquals

Description Indicates whether or not a global date and time value is greater than or equal to another global date and
time value.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.gDateTime2 = GlobalDateTime.ParseFromString("20100402235401");
this.result = this.gDateTime1.GreaterEquals(this.gDateTime2);
Result: False

GlobalDateTime.GreaterThan

Description Indicates whether or not a global date and time value is greater than another global date and time value.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.gDateTime2 = GlobalDateTime.ParseFromString("20100402235401");
this.result = this.gDateTime1.GreaterThan(this.gDateTime2);
Result: False

SAP Cloud Applications Studio – Version May 2018 (1805)

252 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
GlobalDateTime.LessEquals

Description Indicates whether or not a global date and time value is less than or equal to another global date and time
value.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.gDateTime2 = GlobalDateTime.ParseFromString("20100402235401");
this.result = this.gDateTime1.LessEqual(this.gDateTime2);
Result: True

GlobalDateTime.LessThan

Description Indicates whether or not a global time value is less than another global time value.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.gDateTime2 = GlobalDateTime.ParseFromString("20100402235401");
this.result = this.gDateTime1.LessThan(this.gDateTime2);
Result: True

GlobalDateTime.Equals

Description Indicates whether or not a global date and time value is equal to another global date and time value.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.gDateTime2 = GlobalDateTime.ParseFromString("20100402235401");
this.result = this.gDateTime1.Equals(this.gDateTime2);
Result: False

GlobalDateTime.IsBetween

Description Indicates whether or not a global date and time value is between two other specified global date and time
values.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.gDateTime2 = GlobalDateTime.ParseFromString("20100330235401");
this.gDateTime3 = GlobalDateTime.ParseFromString("20100402235401");
this.result =
this.gDateTime2.IsBetween(this.gDateTime1,this.gDateTime3);
Result: True

GlobalDateTime.GetDate

Description Returns the date of a global date and time value.

Example this.gDateTime = GlobalDateTime.ParseFromString("20100215104352");

this.result = this.gDateTime.GetDate();
Result: Date value 20100215

GlobalDateTime.GetTime

Description Returns the time of a global date and time value.

Example this.gDateTime = GlobalDateTime.ParseFromString("20100215104352");

this.result = this.gDateTime.GetTime();
Result: Time value 104352

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 253
GlobalDateTime.GetDay

Description Returns the day of a global date and time value.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.result = this.gDateTime.GetDay( );
Result: String value 15

GlobalDateTime.GetMonth

Description Returns the month of a global date and time value.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.result = this.gDateTime.GetMonth( );
Result: String value 02

GlobalDateTime.GetYear

Description Returns the year of a global date and time value.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.result = this.gDateTime.GetYear( );

Result Result: String value 2010

GlobalDateTime.GetWeek

Description Returns the calendar week of a global date and time value.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.result = this.gDateTime.GetWeek( );
Result: String value 07

GlobalDateTime.GetHour

Description Returns the hours of a global date and time value.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.result = this.gDateTime.GetHour( );
Result: String value 10.

GlobalDateTime.GetMinute

Description Returns the minutes of a global date and time value.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.result = this.gDateTime.GetMinute( );
Result: String value 43

GlobalDateTime.GetSecond

Description Returns the seconds of a global date and time value.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.result = this.gDateTime.GetSecond( );
Result: String value 52

SAP Cloud Applications Studio – Version May 2018 (1805)

254 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
GlobalDateTime.AddDuration

Description Adds a duration to a global date and time value.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.result =
this.gDateTime.AddDuration(Duration.ParseFromString("P3DT1H"));
Result: Global date time value 20100218114352

GlobalDateTime.SubtractDuration

Description Subtracts a duration from a global date and time value.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.result =
this.gDateTime.SubtractDuration(Duration.ParseFromString("P3DT1H"));
Result: Global date time value 20100212094352

GlobalDateTime.Delta

Description Returns the delta duration between two global date and time values.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.gDateTime2 = GlobalDateTime.ParseFromString("20100218114352");
this.result = this.gDateTime1.Delta(this.gDateTime2);
Result: Duration value P3DT1H

GlobalDateTime.StartOfMonth

Description Returns the start of a month related to a global date and time value.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.result = this.gDateTime.StartOfMonth();
Result: Global date time value 20100201000000

GlobalDateTime.EndOfMonth

Description Returns the end of a month related to a global date and time value.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.result = this.gDateTime.EndOfMonth();
Result: Global date time value 20100228235959

GlobalDateTime.StartOfYear

Description Returns the start of a year related to a global date and time value.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.result = this.gDateTime.StartOfYear();
Result: Global date time value 20100101000000

GlobalDateTime.EndOfYear

Description Returns the end of a year related to a global date and time value.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 255
Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");
this.result = this.gDateTime.EndOfMonth();
Result: Global date time value 20101231235959

GlobalDateTime.ConvertToDate

Description Converts a global date and time value into a date.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.result = this.gDateTime.ConvertToDate();
Result: Date value 20100215

GlobalDateTime.ConvertToDateTime

Description Converts a global date and time value into a date and time value.

Use this function only when an SAP business object uses the DateTime data type in the http://
sap.com/xi/BASIS/Global namespace. Do not use the DateTime data type in your own
business object definitions.

Example this.gDateTime1 = GlobalDateTime.ParseFromString("20100215104352");

this.result = this.gDateTime.ConvertToDateTime();
Result: Date time value 2010-02-15T10:43:52.0000000Z

GlobalDateTime.ConvertToLocalDateTime

Description Converts a global date and time value into a local date and time value. You can specify target time zone . If
no time zone is specified, the function converts the global date and time value into the time zone of the
user that is currently logged on.

Example this.gDateTime = GlobalDateTime.ParseFromString("20080330120000");

this.result = this.gDateTime.ConvertToLocalDateTime();
Result: Local date time value in the time zone of the user.
this.result = this.gDateTime.ConvertToLocalDateTime("CET");
Result: Local date time value 20080330140000 CET

GlobalDateTime.ConvertToLocalNormalisedDateTime

Description Converts a global date and time value into a local normalized date and time value. You can specify a time
zone. If no time zone is specified, the time zone of the user that is currently logged on is used.

Example this.gDateTime = GlobalDateTime.ParseFromString("20080330120000");

this.result = this.gDateTime.ConvertToLocalNormalisedDateTime();
Result: Local normalized date time value with the time zone of the user.
this.result = this.gDateTime.ConvertToLocalNormalisedDateTime("CET");
Result: Local normalized date time value 20080330140000 CET

SAP Cloud Applications Studio – Version May 2018 (1805)

256 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
GlobalDateTime.ParseFromString

Description Converts a string into a global date and time value. The function accepts both the internal format and the
ISO format.

This function supports static calls only.

Example this.result = GlobalDateTime.ParseFromString("20100215104352");

Result: Global date time value 20100215104352

7.2.5.1.10 Language Code (Reuse Library)

This SAP reuse library contains a function for language codes.

LanguageCode.ParseFromString

Description Converts a string into a language code. Before the conversion the system checks if the string is a valid
language code. The function accepts ISO codes only.

This function supports static calls only.

Example this.description.languageCode = LanguageCode.ParseFromString("EN");

Result: Language code with content “E”.

7.2.5.1.11 Local Date and Time (Reuse Library)

This SAP reuse library contains functions that deal with local date and time values.

LocalDateTime.ConvertTimeZone

Description Converts a local date and time value from one time zone into another time zone.

Example this.localDateTime = LocalDateTime.ParseFromString("20100215104352

CET");
this.result = this.LocalDateTime.ConvertTimeZone("UTC");
Result: Local date time value 20100215094352 UTC

LocalDateTime.ConvertToGlobalDateTime

Description Converts a local date and time value into a global date and time value.

Example this.localDateTime = LocalDateTime.ParseFromString("20080330120000

CET");
this.result = this.localDateTime.ConvertToGlobalDateTime();
Result: Global date time value 20080330100000

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 257
LocalDateTime.ParseFromString

Description Converts a string into a local date and time value. The function accepts both the internal format and the
ISO format.

This function supports static calls only.

Example this.result = LocalDateTime.ParseFromString("20100215104352 CET");

Result: Local date time value 20100215104352 CET

7.2.5.1.12 Local Normalised Date and Time (Reuse Library)

This SAP reuse library contains a function that deals with local normalized date and time values.

LocalNormalisedDateTime.ConvertToGlobalDateTime

Description Converts a local normalized date and time value into a global date and time value.

Example import ABSL;

var global2;
var locnorm;
var global3;
global2 = GlobalDateTime.ParseFromString("20080330120000");
locnorm = global2.ConvertToLocalNormalisedDateTime();
global3 = locnorm.ConvertToGlobalDateTime();
Result: Global date time value 20080330120000

7.2.5.1.13 Number Range (Reuse Library)

Overview
This SAP reuse library contains functions that you can use to draw numbers. The drawn numbers are separated by
identifiers that support different number ranges for different object types, for example document types. These
identifiers are called number range objects.

NumberRange.DrawNumber

Description Draws a new number; ideally the next number in the sequence of a given number range object.
The first value in the range always equals to 1; and the last value is 999.999.999.
In cases where the current value has reached the maximum value 999.999.999, the system raises a
message, and the number range is reset to 0. Hence, the next drawn number is 1.

Example var recordNumber = NumberRange.DrawNumber("RECORD");

var numberRangeObject : ID = "ORDER";
var orderNumber = NumberRange.DrawNumber( numberRangeObject );
Result: The value of the number range object RECORD and ORDER is the next number in sequence.

SAP Cloud Applications Studio – Version May 2018 (1805)

258 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
NumberRange.GetNumber

Description Returns the current value of the number range object.

In cases where there are no earlier calls to this specific number range object, the value is 0.

Example var recordNumber = NumberRange.GetNumber("RECORD");

var numberRangeObject : ID = "ORDER";
var orderNumber = NumberRange.GetNumber( numberRangeObject );
Result: The current value of the number range objects RECORD and ORDER are returned.

NumberRange.ResetRange

Description Resets the value of the number range object to 0.

The next drawn number is 1..

Example NumberRange.ResetRange("RECORD");
var numberRangeObject : ID = "ORDER";
NumberRange.ResetRange( numberRangeObject );
Result: The value of the number range objects RECORD and ORDER is set to 0.

7.2.5.1.14 Numeric (Reuse Library)

This SAP reuse library contains functions that you can use for integers and decimals.

Numeric.IsNumeric

Description Indicates whether a string contains a numeric value or not.

This function supports static calls only.

Example this.result = Numeric.IsNumeric("1.5A");

Result: False

Numeric.ParseFromString

Description Converts a string into a numeric value. Before the conversion the system checks if the string is a valid
numeric value.
The decimal point can be a dot as well as a comma depending on the locale.

This function supports static calls only.

Examples this.result = Numeric.ParseFromString("1.5");

Result: Numeric value 1.5
this.result = Numeric.ParseFromString("1,5");
Result: Numeric value 1.5

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 259
Numeric.RoundToString

Description Converts a numeric value into a string by rounding it to a given number of decimal places. The string format
depends on the locale of the current user. If you want to ensure that the dot is used as decimal mark
independently of the locale, you need to provide the optional RawRepresentation parameter. This
parameter is useful, for example, when the sting needs to be parsed again into a numeric value using the
Numeric.ParseFromString function.

Example this.pi = 3.14159;

this.result = this.pi.RoundToString( 2 );
Result: "3.14" or "3,14" (depending on the locale of the user)

If you want to ensure that the dot is used as decimal mark consistently, use the following
statement: this.result = this.pi.RoundToString( 2 , true);

7.2.5.1.15 Numeric Character (Reuse Library)

This SAP reuse library contains functions for codes and identifiers with implementation type NUMC.
For information about the data types and their implementation type, see the Business Center at https://
www.sme.sap.com under SAP Business ByDesign Community Wiki SAP Business ByDesign Studio Public
Solution Model . You can find the information in the Published Data Types List.

NumericCharacter.ParseFromString

Description Converts a string into a numeric character. Before the conversion the system checks if the string is a valid
numeric character.

This function supports static calls only.

Example this.numcCode.content = Numeric.ParseFromString("05");

Result: Numeric character value 05

7.2.5.1.16 Quantity Conversion (Reuse Library)

This SAP reuse library contains functions that you can use to compare quantities and to perform simple calculations
of quantities. The functions allows to use different units of measure if they are convertible.

QuantityConversion.GreaterEquals

Description Indicates whether or not a quantity is greater than or equal to another quantity.

SAP Cloud Applications Studio – Version May 2018 (1805)

260 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Example this.quantity1.Content = 52;
this.quantity1.unitCode = "EA";
this.quantity2.Content = 52;
this.quantity2.unitCode = "EA";
this.result = this.quantity1.GreaterEquals(this.quantity2);
Result: True

QuantityConversion.GreaterThan

Description Indicates whether or not a quantity is greater than another quantity.

Example this.quantity1.Content = 52;

this.quantity1.unitCode = "EA";
this.quantity2.Content = 52;
this.quantity2.unitCode = "EA";
this.result = this.quantity1.GreaterThan(this.quantity2);
Result: False

QuantityConversion.LessEquals

Description Indicates whether or not a quantity is less than or equal to another quantity.

Example this.quantity1.Content = 52;

this.quantity1.unitCode = "EA";
this.quantity2.Content = 52;
this.quantity2.unitCode = "EA";
this.result = this.quantity1.LessEquals(this.quantity2);
Result: True

QuantityConversion.LessThan

Description Indicates whether or not a quantity is less than another quantity.

Example this.quantity1.Content = 52;

this.quantity1.unitCode = "EA";
this.quantity2.Content = 52;
this.quantity2.unitCode = "EA";
this.result = this.quantity1.LessThan(this.quantity2);
Result: False

QuantityConversion.Equals

Description Indicates whether a quantity is equal to another quantity or not.

Example this.quantity1.Content = 52;

this.quantity1.unitCode = "EA";
this.quantity2.Content = 52;
this.quantity2.unitCode = "EA";
this.result = this.quantity1.Equals(this.quantity2);
Result: True

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 261
QuantityConversion.Add

Description Adds two quantities. You can add quantities of different units of measure (UoM). If you do not specify a
target UoM, the function returns the result in the UoM of the first quantity.

Example this.quantity1.Content = 53;

this.quantity1.unitCode = "EA";
this.quantity2.Content = 52;
this.quantity2.unitCode = "EA";
this.result = this.quantity1.Add(this.quantity2);
Result: Quantity value 105 EA

QuantityConversion.Subtract

Description Subtracts a quantity from another quantity. You can substract quantities of different units of measure
(UoM). If you do not specify a target UoM, the function returns the result in the UoM of the first quantity.

Example this.quantity1.Content = 53;

this.quantity1.unitCode = "EA";
this.quantity2.Content = 52;
this.quantity2.unitCode = "EA";
this.result = this.quantity1.Subtract(this.quantity2);
Result: Quantity value 1 EA

QuantityConversion.Divide

Description Divides a quantity by another quantity. The result is a decimal value.

Example this.quantity1.Content = 58;

this.quantity1.unitCode = "EA";
this.quantity2.Content = 37;
this.quantity2.unitCode = "EA";
this.result = this.quantity1.Divide(this.quantity2);
Result: Decimal value 1,56756756756756

7.2.5.1.17 Time (Reuse Library)

This SAP reuse library contains the following functions that you can use, for example, to compare times.

Time.GreaterEquals

Description Indicates whether or not a time value is greater than or equal to another time value.

Example this.time1 = Time.ParseFromString("120157");

this.time2 = Time.ParseFromString("230000");
this.result = this.time1.GreaterEquals(this.time2);
Result: False

Time.GreaterThan

Description Indicates whether or not a time is greater than another value.

SAP Cloud Applications Studio – Version May 2018 (1805)

262 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Example this.time1 = Time.ParseFromString("120157");
this.time2 = Time.ParseFromString("230000");
this.result = this.time1.GreaterThan(this.time2);
Result: False

Time.LessEquals

Description Indicates whether or not a time value is less than or equal to another value.

Example this.time1 = Time.ParseFromString("120157");

this.time2 = Time.ParseFromString("230000");
this.result = this.time1.LessEquals(this.time2);
Result: True

Time.LessThan

Description Indicates whether or not a time value is less than another value.

Example this.time1 = Time.ParseFromString("120157");

this.time2 = Time.ParseFromString("230000");
this.result = this.time1.LessThan(this.time2);
Result: True

Time.GetHour

Description Returns the hour of a time value.

Example this.time = Time.ParseFromString("120157");

this.result = this.time.GetHourl();
Result: String value 12

Time.GetMinute

Description Returns the minutes of a time value.

Example this.time = Time.ParseFromString("120157");

this.result = this.time.GetMinute();
Result: String value 01

Time.GetSecond

Description Returns the seconds of a time value.

Example this.time = Time.ParseFromString("120157");

this.result = this.time.GetSecond();
Result: String value 57

Time.Delta

Description Returns the duration delta between two specified time values.

Example this.time1 = Time.ParseFromString("120157");

this.time2 = Time.ParseFromString("230000");
this.result = this.time1.Delta(this.time2);
Result: Duration value PT10H58M3S

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 263
Time.ParseFromString

Description Converts a string into a time value. The function accepts both the internal format and the ISO format.

This function supports static calls only.

Example this.result = Duration.ParseFromString("120157");

Result: Time value 12:01:57

7.2.5.1.18 UUID (Reuse Library)

This reuse library contains functions for Universal Unique Identifiers (UUIDs).

UUID.ParseFromString

Description Converts a string into a UUID.

This function supports static calls only.

Example this.result.content =
UUID.ParseFromString("00163E01023602DD88AFE2F34FC4C3F3");
Result: UUID 00163E01023602DD88AFE2F34FC4C3F3

UUID.Generate

Description Generates a UUID.

This function supports static calls only.

Example this.result.content = UUID.Generate();

Result: A UUID that is different each time the function is called.

7.2.5.1.19 Sensitive Personal Data (Reuse Library)

This SAP reuse library contains functions for read access logging (RAL).

SensitivePersonalData.WriteDirectAcessLog

Description Writes direct access logs when sensitive personal data is read and sent through one of the channels.
Channels can be, for example, ABSL_MSG.

SAP Cloud Applications Studio – Version May 2018 (1805)

264 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Example var code : RALChannelCode;
code = "ABSL_MSG";
raise
DemoMessage.Create("I",this.TOCUST.TaxNumber.GetFirst().TaxID.content);
RALLogItem1 =
this.TOCUST.TaxNumber.GetFirst().TaxID.content.GetRALLogItem();
RALLogItemCollection.Collection.Add(RALLogItem1);
SensitivePersonalData.WriteDirectAccessLog(code.GetDescription(),RALLogI
temCollection);

GetRALLogItem

Description Creates an instance of RAL log item, that will be recorded in the Read Access Log. This context function
can be used only for the fields marked as Sensitive Personal Data.

Example var code : RALChannelCode;

code = "ABSL_MSG";
raise
DemoMessage.Create("I",this.TOCUST.TaxNumber.GetFirst().TaxID.content);
RALLogItem1 =
this.TOCUST.TaxNumber.GetFirst().TaxID.content.GetRALLogItem();
RALLogItemCollection.Collection.Add(RALLogItem1);
SensitivePersonalData.WriteDirectAccessLog(code.GetDescription(),RALLogI
temCollection);

GetChangeLogInfo

Description Fetches the BO name, Node name, or Node ID when used with the ChangeHistoryEnabled node.
Use this function to delete the ChangeLogHistory attached to the respective node in deletion BADI absl.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 265
Example var result : DataDestructionBAdIDestroyCustomDataResultDataStructure;
var ChangelogInfo :
DataDestructionBAdIDestroyCustomDataResultChangeDocumentNodeDetails;
var ChangelogInfoCollection :collectionof
DataDestructionBAdIDestroyCustomDataResultChangeDocumentNodeDetails;
if(InputData..BusinessPartnerRole == "Private Account")
{

var CustRoot = Customer .Retrieve(InputData.BusinessPartnerUUID);

var CustomerID = CustRoot.InternalID;

var PrivateAccountRoot = PrivateAccntCopy.Retrieve(CustomerID);

raise NjInfo.Create("I");

var time = Library::Context.GetCurrentUserTime();

var str = time.ToString();

PrivateAccountRoot.Account_ID = "XXXX".Concatenate(str);

ChangelogInfo = PrivateAccountRoot.GetChangeLogInfo();
ChangelogInfoCollection.Add(ChangelogInfo);
ChangelogInfo.Clear();

result.ChangeDocumentNodeDetails = ChangelogInfoCollection;
result.ErrorOccurredDuringDestroy = false;

}
return result;

7.2.5.1.20 Web Service Utilities

This SAP reuse library contains functions related to Web services.

For more information, see Web Services Quick Guide [page 529].

WebServiceUtilities.ExecuteWebService

Descriptio Calls a REST or RSS/Atom mashup Web service. This reuse library focuses on relatively simple Web services
n that can be modeled as a mashup Web service. If you need to control the Web service call in more detail, you can
use the WebServiceUtilities.ExecuteRESTService reuse function.
For more information, see Using a Mashup Web Service in a Script File [page 507].

Example var result = WebServiceUtilities.ExecuteWebService(serviceID, parameters);

var content = result.ResponseContent;
var returnCode = result.ReturnCode;

SAP Cloud Applications Studio – Version May 2018 (1805)

266 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
WebServiceUtilities.ExecuteRESTService

Descriptio Calls a REST Web service defined in an External Web Service Integration scenario. For more information, see
n Integrate an External Web Service Using REST [page 552].
This reuse library allows you to control the Web service call using a set of parameters. You can, for example,
dynamically create the request body or use specific authentication mechanisms or header parameters.
The following parameters need to be filled:
● CommunicationScenarioName: Name of the communication scenario (.csd) defined in the studio
● ServiceName: Name of the External Web Service Integration scenario (.wsid) defined in the studio
● HttpMethod: Function supports the following HTTP methods: ‘GET’, ‘POST’, ‘PUT’, ‘DELETE’
● ContentType: Specifies the character encoding (for example, text/html) of the request
● ResourceName: Resource name of the rest service that is concatenated to the defined URL in the service
of the communication arrangement
● URLParam: Additional URL parameters that are concatenated to the defined URL in the service of the
communication arrangement
● HeaderParameters: Header parameters of the request
● Body: Body of the request. Body has to fit with defined content type.

After executing the service, the function fills the following parameters in the result structure:
● ReturnCode: Return code of the REST call, for example, 200for success
● Content: Content of the response
● HeaderParameters: Header parameters of the response
● ContentType: Content type of the response

Example var headerParams : collectionof NameAndValue;

var headerParam : NameAndValue;
var urlParams : collectionof NameAndValue;
var urlParam : NameAndValue;
headerParam.Name = "Accept-Encoding";
headerParam.Value = "gzip,deflate,sdch";
headerParams.add(headerParam);

headerParam.Name = "Accept-Language";
headerParam.Value = "de-DE,de;q=0.8,en-US;q=0.6,en;q=0.4";
headerParams.add(headerParam);

urlParam.Name = "listZipCodeList";
urlParam.Value = "20910";
urlParams.add(urlParam);

var result =
WebServiceUtilities.ExecuteRESTService(communicationScenarioName,
serviceName,"GET", "ext/plain", "ndfdXMLclient.php", urlParam, headerParams,
"");

For more information, see Example: Consume a REST Service [page 554].

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 267
WebServiceUtilities.EncryptWithHashBasedMessageAuthenticationCode

Descriptio Encrypts a message with a keyed-hash message authentication code.

n The following parameters need to be filled:
● Scenario: Communication scenario name
● Algorithm: Function supports the following hash algorithms: 'SHA256', 'SHA512'
● Key: Placeholder for secret cryptographic key
● Message: Message that is encrypted with the specified key and hash algorithm

This function is available only for REST based services, and not for SOAP based services.

Example var hmac =

WebServiceUtilities.EncryptWithHashBasedMessageAuthenticationCode(Scenario,
"SHA256", Root.SecretKey, message);

7.2.5.2 SAP Reuse Libraries for Business Areas

7.2.5.2.1 SAP Reuse Libraries for Business Areas Reference

The SAP reuse libraries for business areas provide additional, very specific services to the scripting language that
are relevant for functions in the business areas of the cloud solution from SAP, for example, in the Financial
Management business area. These services are all based on entities provided by SAP.

To use an SAP reuse library for a specific business areas, you need to import the namespace of the relevant
business area with the import keyword, for example, import
AP.FO.ProductDataMaintenance.Global;. For more information about the import keyword, see Syntax
for Implementation of Business Logic [page 210].

List of SAP Reuse Libraries for Business Areas

● Accounting Coding Block Assignment Utilities [page 269]
This SAP reuse library contains a service that is based on the AccountingCodingBlockDistribution
dependent object provided by SAP.
● Address Snapshot Utilities [page 269]
This SAP reuse library contains a service that is based on the Address Snapshot business object provided
by SAP.
● Date Time Utilities [page 270]
This SAP reuse library contains a service that is based on advanced functions for date and time processing.
● Financials Process Utilities [page 271]
This SAP reuse library contains a service that is relevant for the Financial Management business area.
● Financials Set of Books Utilities [page 272] (relevant for SAP Business ByDesign only)

SAP Cloud Applications Studio – Version May 2018 (1805)

268 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 This SAP reuse library contains a service that is based on the Set of Books business object provided by
SAP.
● Material Utilities [page 272]
This SAP reuse library contains a service that is based on the Material business object provided by SAP.
● Price Component Utilities [page 275]
This SAP reuse library contains a service that is based on the PriceAndTaxCalculation dependent object
provided by SAP.

7.2.5.2.2 Accounting Coding Block Assignment Utilities

To use this SAP reuse library, you need to import the AP.IS.CodingBlock namespace.

AccountingCodingBlockAssignmentUtilities.ToMessage

Description Converts the AccountingCodingBlockAssignment subnode of the

AccountingCodingBlockDistribution dependent object into the
AccountingCodingBlockAssignment global data type.

Example FormData.ItemAccountingCodingBlockAssignment =
this.ToItemAccountingCodingBlockAssignment.ToMessage( );
In this example, FormData.ItemAccountingCodingBlockAssignment is
theAccountingCodingBlockAssignment global data type.
this.ToItemAccountingCodingBlockAssignment refers to the
AccountingCodingBlockAssignment subnode of the
AccountingCodingBlockDistribution dependent object.
Result: Accounting coding block assignment.

7.2.5.2.3 Address Snapshot Utilities

To use this SAP reuse library, you need to import the AP.FO.Address.Global namespace.

AddressSnapshotUtilities.ToForm

Description Converts an address into a format that can be used in a print form. The data stored in an instance of the
Address Snapshot business object is converted into the FormAddress global data type.

Example this.SenderCountry = "US";

this.MaximumOfLines = 12;
this.UseStreetAddress = true;
FormData.PurchaseOrder.SellerPartyAddress =
this.SellerParty.AddressSnapshot.ToForm( this.SenderCountry,
this.MaximumOfLines, this.UseStreetAddress );
In this example, AddressSnapshot refers to the AddressSnapshot business
object.FormData.PurchaseOrder.SellerPartyAddress is the FormAddress global data type .
Result: Form address, for example,
FormData.PurchaseOrder.SellerPartyAddress.FormattedAddressDescription = "AMS / 166 South High
Street / Akron OH 44308 / US"

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 269
7.2.5.2.4 Date Time Utilities

This SAP reuse library contains a service that is based on advanced functions for date and time processing. To use
this library, you need to import the AP.IS.DateAndTime.Global namespace.

DateTimeUtilities.GetNextActiveTimePoint

Description Returns the next active time value based on the calendar, direction (+ or -) and the date and time value
passed.

If you do not provide a calendar, the default calendar is used.

Example this.CurrentDateTime.Date = Date.ParseFromString("20080330")

this.CurrentDateTime.Time = Time.ParseFromString("101010");
this.Direction = "+";
this.CalCode.content = "11";
this.NextDateTime =
DateTimeUtilities.GetNextActiveTimePoint(this.CurrentDateTime,
this.Direction, this.CalCode);
Result: Next date value: 31.03.2008, next time value: 000000

DateTimeUtilities.MoveTimePoint

Description The MoveTimePoint operation moves a time point by a specified duration either forwards or backwards on
a given calendar. The response structure returns the time point considering working or non-working days
when a calendar is used for calculation. If the operation is used without a calendar, the default (gregorian)
calendar is used.

If you do not provide a calendar, the default (gregorian) calendar is used.

CalendarCode: ID of the working day calendar.
CalendarUUID: UUID of a calendar schema with operating hours.
CalendarUUID overrules the CalendarCode if both provided.
Direction: plus (+) or minus (-).
Duration: Required in ISO format e.g. "P2D" = 2 days, "PT48H" = 48 hours.

SAP Cloud Applications Studio – Version May 2018 (1805)

270 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Example this.CurrentDateTime.Date = Date.ParseFromString("20140908010000")
this.CurrentDateTime.TypeCode = "5"; (5 is Local Normalised Date Time)
this.Duration = ABSL:Duration.ParseFromString("PT48H");
this.Direction = "+";
this.CalCode.content = "11";
this.CalUUID.content =
ABSL:UUID.ParesFromString("00000000000102DCAE83346B4F5F1B49";
this.NextDateTime =
DateTimeUtilities.MoveTimePoint(this.CurrentDateTime, this.Duration,
this.Direction, this.CalCode, this.CalUUID);
Result: Next date value: 20140916130000
Result Explanation: Calendar Schema: Monday to Friday 09:00 to 17:00 based on EST, EST time zone
difference to UTC: +4 hours(based on calculation day 08.09.2014) Calendar schema on UTC: Monday to
Friday 13:00 to 21:00
Start time point is 08.09.2014 01:00:00 (UTC) which is outside the operating hours, so it starts at next
active time point: 08.09.2014 13:00:00
Every working day has 8 operating hours so 48 hours correspond to 6 working days. The calculation ends
on 15.09.2014 21:00:00 so next active time point is 16.09.2014 13:00:00.

7.2.5.2.5 Financials Process Utilities

This reuse library contains a service that is relevant for the Financial Management business area. To use this library,
you need to import the AP.FO.CompanyFinancialsProcessControl.Global namespace.

FinancialsProcessUtilities.GetProcessLockStatus

Description Returns the process lock status for a given accounting transaction date, company and business transaction
type group. Please note that on the user interface of SAP Business ByDesign, process lock is called “Process
Control” and accounting transaction date is called “Posting Date” or “Proposed Posting Date” .
For information about the process lock, see the SAP Business ByDesign Library under Business
Areas Financial Management Financial and Management Accounting General Leger Master
Data Companies View Quick Guide for Companies (General Ledger) Set the Process Control .

This service supports static calls only.

Example this.BTTGroup = "02";// Customer Invoicing

this.TransactionDate = Date.ParseFromString("20110623");
this.BlockingStatus =
FinancialsProcessUtilities.ProcessLock( this.TransactionDate,
this.BTTGroup, this.ToCompany );
In this example, this.ToCompany refers to the Company business object provided by SAP.
Result: Process lock status code, for example, 1 for status “not blocked”.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 271
7.2.5.2.6 Financials Set of Books Utilities (SAP Business ByDesign
Only)

This SAP reuse library contains a service that is based on the Set of Books business object provided by SAP. To
use this library, you need to import the AP.FinancialAccounting.Global namespace.

SetofBooksUtilities.GetFiscalYearStartEndDate

Descriptio Returns the start date and the end date of the fiscal year for a given company, set of books, and fiscal year.
n

Example import ABSL;

import AP.Common.GDT as common;
import AP.FinancialAccounting.Global;
import AP.FO.MOM.Global;
var FYDates : DatePeriod;
var comp : Company;
var fyID : FiscalYearID;
var ext: Fisc;
var tempDate : common:Date;
var year : Year;
if(!this.CompanyId.IsInitial())
{
if(!this.sobid.content.IsInitial())
{
comp = Company.Retrieve(this.CompanyId);
var temp = "2012";
fyID = NumericCharacter.ParseFromString(temp);
if(comp.IsSet())
{
FYDates =
SetofBooksUtilities.GetFiscalYearStartEndDate(this.sobi
d, fyID, comp);
this.FYStartDate = FYDates.StartDate;
this.FYEndDate = FYDates.EndDate;
{
{
{
Result:
Start date of the fiscal year, for example,01012012 for year 2012
End date of the fiscal year, for example, 31122012 for year 2012

7.2.5.2.7 Material Utilities

This SAP reuse library contains a service that is based on the Material business object provided by SAP. To use
this library, you need to import the AP.FO.ProductDataMaintenance.Global namespace.

SAP Cloud Applications Studio – Version May 2018 (1805)

272 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
MaterialUtilities.QuantityConversion

Description Converts a quantity of a material or product into a different unit of measure or quantity specification.

Example this.quantity_in.content = 1;
this.quantity_in.unitCode = "XPX";
this.unit_out = "EA";
this.quantity_out =
this.toMaterial.QuantityConversion( this.quantity_in, this.unit_out );
In this example, toMaterial refers to the Material business object.
Result: Quantity value, for example, 20 EA

7.2.5.2.8 Output Management Utilities

This SAP reuse library contains a service that is based on output management functionality. To use this reuse library,
you need to import the following namespaces:
● AP.Common.GDT
● BASIS.Global
● DocumentServices.Global

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

OutputManagementUtilities.GetPDF

Descriptio Provides business object data in a portable document format (PDF) document.
n

Example //variables
var FormTemplateLanguage = "E";
var PDF : BinaryObject;
var FormTemplateCode : OutputRequestFormTemplateCode;
FormTemplateCode.content = "ZMEI2TXR_P3JE6"; //Code is Form Template Header
Code

// Reuse Service Call

PDF =
OutputManagementUtilities.GetPDF(this,FormTemplateCode,FormTemplateLanguage)
;
Result: A PDF, which can be used further for storage, for example, as a business object attachment.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 273
OutputManagementUtilities.CreatePrintQueueItem

Descriptio Enables you to send custom PDFs to the print queue.

n

Example import ABSL;

import AP.Common.GDT;
import BASIS.Global;
import DocumentServices.Global;
varuserAccountID:UserAccountID;
userAccountID.content =“Enter USER ID”;
var binaryContent:BinaryObject;
binaryContent.content = "255044462D312E360D25E2E3CFD30D0A31312030206F626A0A3C
3C2F46696C7465722F466C6174654465636F64652F466972737420392F4C656E677468203136
";
//Input for CreatePrintQueueItem:
//[Login User ID, Document Name, No. of Copies, PDF Binary Content, Queue ID]
this.PrintUUID =
OutputManagementUtilities.CreatePrintQueueItem(userAccountID,“<Document
Name>”,1,binaryContent,"DEFAULT");

OutputManagementUtilities.CreatePrintQueueItemWithFormTemplate

Descriptio Enables you to create print queue instances based on the form template code, country code, language fields as
n inputs to fetch the corresponding form template. The XML binary content along with the form template is used
to generate the actual PDF content.

SAP Cloud Applications Studio – Version May 2018 (1805)

274 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Example import ABSL;
import AP.Common.GDT;
import BASIS.Global;
import DocumentServices.Global;
varuserAccountID:UserAccountID;
userAccountID.content =“<Enter USER ID>”;
var binaryContent:BinaryObject;
var lang:DataType::LanguageCode;
var country:CountryCode;
var formTemplateCode:OutputRequestFormTemplateCode;
var companyID:OrganisationalCentreID;
var orgUnit:OrganisationalCentreID;
var channelType:CommunicationMediumTypeCode;
formTemplateCode = "C0001";
lang = "EN";
country ="US";
channelType ="PRT";
companyID ="MC10000";
orgUnit ="MC42100";
binaryContent.content = "255044462D312E360D25E2E3CFD30D0A31312030206F626A0A3C
3C2F46696C7465722F466C6174654465636F64652F466972737420392F4C656E677468203136
";
//Input for CreatePrintQueueItemWithFormTemplate:
//[Login User ID, Document Name, Queue ID, No. of Copies, PDF Binary Content,
FormTemplateCode, Language, Country Code, CompanyID, Org. Unit ID, Channel
Type]
this.PrintUUID =
OutputManagementUtilities.CreatePrintQueueItemWithFormTemplate(userAccountID
,"<Document Name>","DEFAULT",
1,binaryContent,formTemplateCode,lang,country,companyID,orgUnit,channelType)
;

7.2.5.2.9 Price Component Utilities

This SAP reuse library contains a service that is based on the PriceAndTaxCalculation dependent object
provided by SAP. To use this library, you need to import the AP.FO.PriceAndTax.Global namespace.

PriceComponentUtilities.ToMessage

Description Converts thePriceAndTaxCalculation dependent object into the FormPriceComponent global

data type.

Example FormData.PriceComponent =
this.PriceAndTaxCalculation.PriceComponent.ToMessage( );
In this example, FormData.PriceComponent is the FormPriceComponent global data
type .this.PriceAndTaxCalculation.PriceComponent refers to the
PriceAndTaxCalculation dependent object.
Result: Form price component.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 275
7.2.6 SAP Built-In Functions

7.2.6.1 SAP Built-In Functions Reference

The SAP built-in functions of the scripting language extend the scope of the syntax for the implementation of your
business logic in a similar way as the basic reuse libraries. However, in contrast to the reuse libraries, you do not
need to import a namespace to use the built-in functions.

List of SAP Built-In Functions

The built-in functions are listed in the following:
● Generic Built-In Functions [page 276]
● Built-In Functions for Codes [page 277]
● Built-In Functions for Strings [page 277]
● Built-In Functions for Numeric Characters [page 283]
● Built-In Functions for Identifiers [page 283]
● Tracing Built-In Functions [page 577]

7.2.6.2 Generic Built-In Functions

These functions bind to more than one data type.

Function Binds to Data Types Description

Clear All data types except for Boolean data types. Clears a value.

IsInitial All data types except for Boolean data types. Indicates whether a value is initial
or not. Returns a Boolean value.

ToString ● All base types except for string data types Converts a value into a string.
● All non-base types that are not structured For binary values UTF-8 encoding
is used. Invalid byte sequences are
● Amount (http://sap.com/xi/AP/Common/GDT)
replaced by the replacement
● Quantity (http://sap.com/xi/AP/Common/GDT) character (U+FFFD). The
● LOCAL_DateTime (http://sap.com/xi/BASIS/Global) replacement character is shown as
● LOCALNORMALISED_DateTime (http://sap.com/xi/BASIS/Global) a black diamond with a white
question mark.

Example:
if (!this.numericValue.IsInitial()) {
this.string = this.numericValue.ToString();
this.numericValue.Clear();
}

SAP Cloud Applications Studio – Version May 2018 (1805)

276 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
7.2.6.3 Built-In Functions for Codes

You can use these functions to read the description of numeric code data types or character-based code data types.
If you use a structured data type, the method binds to the structure but not to the content element.

GetDescription

Description Returns the description of a code value in the language of the user. For some data types, for example, if
you use the RegionCode data type, you also need to provide the ListID element.

Examples var codeDescriptionInUserLanguage = code.GetDescription();

var codeDescriptionFrenchRegionCode = regionCode.GetDescription("FR");

GetDescriptionInOtherLanguage

Description Returns the description of a code value in a specified language. For some data types, for example, if you
use the RegionCode data type, you also need to provide the ListID element.

Example var codeDescriptionInEnglish =

code.GetDescriptionInOtherLanguage(LanguageCode.ParseFromString("EN"));

GetAllValuesAndDescriptions

Description Returns a collection of values and descriptions for a code data type in the language of the user. For some
data types, for example, if you use the RegionCode data type, you also need to provide the ListID
element.

Examples var allCodeValuesDescriptionsInUserLanguage =

code.GetAllValuesAndDescriptions();
var allFrenchRegionCodeValuesAndDescriptions =
regionCode.GetAllValuesAndDescriptions("FR");

GetAllValuesAndDescriptionsInOtherLanguage

Description Returns a collection of values and descriptions for a code data type in a specified language. For some data
types, for example, if you use the RegionCode data type, you also need to provide the ListID element.

Examples var allCodeValuesAndDescriptionsInEnglish =

code.GetAllValuesAndDescriptionsInOtherLanguage(LanguageCode.ParseFromSt
ring("EN"));
var allFrenchRegionCodeValuesAndDescriptionsInEnglish =
regionCode.GetAllValuesAndDescriptionsInOtherLanguage(LanguageCode.Parse
FromString("EN"),"FR");

7.2.6.4 Built-In Functions for Strings

These functions contain description and processing functions for character strings.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 277
Concatenate

Description Concatenates two strings.

Example this.string = "aaabbbccc";

this.result = this.string.Concatenate("test");
Result: String value aaabbbccctest

Contains

Description Indicates whether or not a string contains a substring.

If the source string is empty, the result is false and the system raises an information message. If the
substring is empty, the result is false and the system raises an error message.

Example this.string = "aaabbbccc";

this.result = this.string.Contains("bbb");
Result: True

EndsWith

Description Indicates whether a string ends with a substring or not.

If the source string is empty, the result is false and the system raises an information message. If the
substring is empty, the result is false and the system raises an error message.

Example this.string = "aaabbbccc";

this.result = this.string.EndsWith("ccc);
Result: True

Find

Description Searches from left to right and returns the position of a substring in a string. Optionally, you can define a
search area by specifying the start position only or by specifying the start position as well as the length of
the search area. If no substring is found, the function returns the value "-1".
The function returns the value “-1” and raises a message if the system encounters one of the following
issues:
● The substring is empty (error message)
● The start position is not within the length of the string (error message)
● The length succeeds the length of the string (error message)
● The source string is empty (information message)

Example this.string = "aaabbbcccbbb";

this.result = this.string.Find("bbb");
Result: Integer value 3
Specifying the start position of the search area:
this.string = "aaabbbcccbbb";
this.result = this.string.Find("bbb", 5);
Result: Integer value 9
Specifying the start position and lengh of the search area:
this.string = "aaabbbcccbbb";
this.result = this.string.Find("bbb", 5, 3);
Result: Integer value –1

SAP Cloud Applications Studio – Version May 2018 (1805)

278 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
FindLast

Description Searches from right to left and returns the position of a substring in a string. Optionally, you can define a
search area by specifying the start position only or by specifying the start position and the length of the
search area. If no substring is found, the function returns the value "-1".
The function returns the value “-1” and raises a message if the system encounters one of the following
issues:
● The substring is empty (error message)
● The start position is not within the length of the string (error message)
● The length succeeds the length of the string (error message)
● The source string is empty (information message)

Example this.string = "aaabbbcccbbb";

this.result = this.string.FindLast("bbb");
Result: Integer value 9
Specifying the start position of the search area:
this.string = "aaabbbcccbbb";
this.result = this.string.FindLast("bbb", 8);
Result: Integer value 3
Specifying start position and length of the search area:
this.string = "aaabbbcccbbb";
this.result = this.string.FindLast("bbb", 8, 5);
Result: Integer value 3

FindLastRegEx

Description Searches from right to left and returns the position of a regular expression pattern in a string. Optionally,
you can define a search area by specifying the start position only or by specifying the start position and the
length of the search area. If no substring is found, the function returns the value "-1".
The function returns the value “-1” and raises a message if the system encounters one of the following
issues:
● The substring is empty (error message)
● The start position is not within the length of the string (error message)
● The length succeeds the length of the string (error message)
● The source string is empty (information message)

For information about the operators that you can use in a regular expression pattern, see the ABAP Keyword
Documentation.

Example this.string = "aaa bbb ccc bbb ccc";

this.result = this.string.FindLastRegex("b\\s+");
Result: Integer value 14
Specifying the start position of the search area:
this.string = "aaa bbb ccc bbb ccc";
this.result = this.string.FindLastRegex("b\\s+",8);
Result: Integer value 6
Specifying start position and length of the search area:
this.string = "aaa bbb ccc bbb ccc";
this.result = this.string.FindLastRegex("b\\s+", 16, 2);
Result: Integer value 14

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 279
FindRegEx

Description Searches from left to right and returns the position of a regular expression pattern in a string. Optionally,
you can define a search area by specifying the start position only or by specifying the start position and the
length of the search area. If no substring is found, the function returns the value "-1".
The function returns the value “-1” and raises a message if the system encounters one of the following
issues:
● The substring is empty (error message)
● The start position is not within the length of the string (error message)
● The length succeeds the length of the string (error message)
● The source string is empty (information message)

For information about the operators that you can use in a regular expression pattern, see the ABAP Keyword
Documentation.

Example this.string = "aaa bbb ccc bbb ccc";

this.result = this.string.FindRegex("b\\s+");
Result: Integer value 6
Specifying the start position of the search area:
this.string = "aaa bbb ccc bbb ccc";
this.result = this.string.FindRegex("b\\s+", 8);
Result: Integer value 14
Specifying start position and length of the search area:
this.string = "aaa bbb ccc bbb ccc";
this.result = this.string.FindRegex("b\\s+", 8, 5);
Result: Integer value —1

Length

Description Returns the length of a string.

Example this.string = "test";

this.result = this.string.Length();
Result: Integer value 4

Matches

Description Indicates whether or not the source string matches the regular expression pattern.
The function raises a message and returns the result false, if the system encounters one of the following
issues:
● The regular expression pattern is empty (error message)
● The regular expression pattern is invalid (error message)
● The source string is empty (information message)

Example this.string = "entitlement";

this.RegEx = "entitle.ent";
this.result = this.string.Matches(this.RegEx);
Result: True

SAP Cloud Applications Studio – Version May 2018 (1805)

280 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
Replace

Description Replaces all occurrences of a substring in a string with another substring.

If the substring is empty, the function returns the source string. If the source string is empty, the function
returns an empty string.

Example this.string = "aaabbbccc";

this.result = this.string.Replace("bbb", "test");
Result: String value aaatestccc

ReplaceRegEx

Description Returns all locations in a string with a substring that match a regular expression pattern. Optionally, you
can define a search area by specifying the start position only or by specifying the start position and the
length of the search area.
If the substring is empty or the regular expression pattern is invalid, the function returns the source string
and raises an error message. If the source string is empty, the function returns an empty string and raises
an information message.
For information about the operators that you can use in a regular expression pattern, see the ABAP Keyword
Documentation.

Example this.string = "aaa bbb ccc bbb";

this.result = this.string.ReplaceRegex("b\\s+","test");
Result: String value aaa bbtestccc bbb

StartsWith

Description Indicates whether or not a string starts with a substring.

If the source string is empty, the result is false and the system raises an information message. If the
substring is empty, the result is false and the system raises an error message.

Example this.string = "aaabbbccc";

this.result = this.string.StartsWith("ccc");
Result: False

Substring

Description Returns a substring of a string starting at a specified position. Optionally, you can define the length of the
substring.
The function raises a message and returns an empty string, if the system encounters one of the following
issues:
● Either the start position or the sum of start position and length of the substring is not within the
length of the string (error message)
● The length of the substring succeeds the length of the string (error message)
● The source string is empty (information message)
● The start position or the length of the substring is a negative number (error message)

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 281
Example ● Substring of a string starting at a specified position:
this.string = "aaabbbccc";
this.result = this.string.Substring(3);
Result: String value bbbccc
● Defined length of the substring:
this.string = "aaabbbccc";
this.result = this.string.Substring(4,3);
Result: String value bbc

ToLowerCase

Description Converts a string into lower case.

If the source string is empty, the system returns an empty string and raises an information message.

Example this.string = "AAAbbbCCC";

this.result = this.string.ToLowerCase();
Result: String value aaabbbccc

ToUpperCase

Description Converts a string into upper case.

If the source string is empty, the system returns an empty string and raises an information message.

Example this.string = "AAAbbbCCC";

this.result = this.string.ToUpperCase();
Result: String value AAABBBCCC

Trim

Description Deletes leading and trailing characters. It is not relevant for the result, in which order you pass the
characters to the system. If you do not specify a character, the system removes all blank characters.
If the source string is empty, the system raises an information message and returns an empty string.

Example this.string = " aaabbbccc ";

this.result = this.string.Trim();
Result: String value aaabbbccc

TrimLeft

Description Deletes leading characters. It is not relevant for the result, in which order you pass the characters to the
system. If you do not specify a character, the system removes all blank characters.
If the source string is empty, the system returns an empty string and raises an information message.

Example this.string = "xyz xyz abcd";

this.result = this.string.TrimLeft("zyx");
Result: String value xyz abcd

TrimRight

Description Deletes trailing characters. It is not relevant for the result, in which order you pass the characters to the
system. If you do not specify a character, the system removes all blank characters.
If the source string is empty, the system returns an empty string and raises an information message.

SAP Cloud Applications Studio – Version May 2018 (1805)

282 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Example this.string = "xyz xyz abcd";
this.result = this.string.TrimRight("bd ca");
Result: String value xyz xyz

7.2.6.5 Built-In Functions for Numeric Characters

This function binds to code and identifier data types with the NUMC implementation type.
You can use the Repository Explorer tool window to explore the SAP data types that are released with the public
solution model (PSM) and their implementation type. For more information, see Repository Explorer [page 50].

ToNumeric

Description Converts a numeric character into a numeric value.

Example var numeric = numcCode.ToNumeric();

7.2.6.6 Built-In Functions for Identifiers

You can use these functions to remove leading zeros from or add leading zeros to numeric identifier data types and
character-based identifier data types.

As a prerequisite for this function, the alpha-conversion indicator for the data type must be set.

AddLeadingZeros

Description Adds leading zeros to the identifier.

Example this.productID = this.productID.AddLeadingZeros();

RemoveLeadingZeros

Description Removes leading zeros from the identifier.

Example this.productID = this.productID.RemoveLeadingZeros();

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 283
7.2.7 Basic Data Types

7.2.7.1 Behavior of Data Types

Overview
The scripting language supports basic data types such as string, numeric and Boolean values. In addition, the existing
metadata of the underlying SAP cloud platform for core data types (CDTs) and global data types (GDTs) is made
available.
The implementation type of the particular data type is taken into account during the mapping of CDTs and GDTs to
the basic types of the scripting language. In the studio, you can explore all SAP data types that are released with the
public solution model (PSM) and their implementation type in the Repository Explorer on the Data Types tab. For
more information, see Repository Explorer [page 50].

Basic Data Types

The basic data types that are supported by the studio are listed in the following table:

Implementation SAP GDT or SAP CDT, For

Basic Type Type Properties XSD Data Type Example:

Boolean xsd:boolean Indicator

Numeric INT1 1-byte integer (internal). Value xsd: SMALLNONNEGATIVEINTE

(FLTP) range: 0 to 255. The unsignedByte GER_DecimalValue
MinimumValue attribute and the
MaximumValue attribute define
the business contract of the data
type. These attributes do not limit
the value range technically.

INT4 4-byte integer (internal). Value xsd:int ● NumberValue

range: -2 (MinimumValue ), ● IntegerValue
147,483,648 to +2,147,483,647
(MaximumValue) .

DEC Decimal number with fixed length xsd:decimal ● Amount.content

(MaximumDigits) and fixed ● Quantity.conten
number of fractions t
(MaximumFractions).
● Measure.content
● DecimalValue
● SMALLNONNEGATIV
E_Ratio
● Percent

SAP Cloud Applications Studio – Version May 2018 (1805)

284 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Implementation SAP GDT or SAP CDT, For
Basic Type Type Properties XSD Data Type Example:

DF34_DEC Decimal floating point numbers of

this type are represented internally
with 34 decimal places in
accordance with the IEEE-754-2008
standard (DF34_DEC). Value range:
numbers between 1E6145(1E-34 - 1)
and -1E-6143 for the negative range,
0 and +1E-6143 and 1E6145(1 -
1E-34) for the positive range. Values
lying between these ranges are in the
subnormal range and are rounded.
Outside the subnormal range, each
34-digit decimal number can be
represented precisely by such a
decimal floating point number.

Numeric NUMC Character string containing the xsd:token AccountingPeriodID

Character digits 0 to 9 only. Valid content of a FiscalYearID
numeric text field. The
maxLength property specifies the
maximum length of the string.

String CHAR, SSTR, Character string containing any ● xsd:toke ● Text.content

and STRG alphanumeric characters, including n ● LANGUAGEINDEPEN
special characters. SAP cloud
● xsd: DENT_SHORT_Name
systems are Unicode systems with
string ● LONG_Descriptio
the system code page UTF-16. A
character has a length of two bytes. ● xsd:anyU n.content
The maxLength property specifies RI ● BusinessTransac
the maximum length of the string. tionDocumentID
● ID
● EmailURI
● ApprovalStatusC
ode
● Amount.currency
Code

Binary RSTR, RAW String of bytes ● xsd:base BinaryObject. In

● 64 particular: usage of
Binary AttachmentFolder
dependent object

UUID XSDUUID_RAW Universally unique identifier xsd:token UUID

Date DATS Gregorian date “YYYY-MM-DD” xsd:xsd:Date Date

GlobalDateTi XSDDATETIME Gregorian date and time xsd:DateTime GLOBAL_DateTime

me _LONG_Z “2011-12-25T02:30:00Z”

Time TIMS Time “HH:MM:SS” xsd:time Time

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 285
 Implementation SAP GDT or SAP CDT, For
Basic Type Type Properties XSD Data Type Example:

Duration XSDDURATION Duration, for example xsd:duration Duration

_ISO “P12Y11M2DT4H12M40S”

LanguageCod XSDLANGUAGE Language code, for example “E” xsd:language LanguageCode

e

For more information, see the data type definitions of the World Wide Web Consortium (W3C ) at http://
www.w3.org/TR/xmlschema-2/ .

Validation by the User Interface and Web Service Runtime

The user interface (UI) runtime of the SAP cloud solution validates the user input according to the data type definition.
The following data type properties are checked in particular:
● For strings: Maximum length
● For numeric values: Minimum and maximum value
● For Boolean expressions: Usually represented by a checkbox
● For date, time, and duration values: Defined length and content

As a consequence, you do not need to implement validations in your script files to ensure that the user input matches
the data type definition. The SAP web service runtime validates the service input according to the data type definition
(XSD schema validation).

Internal Variables of the Scripting Language

Internal string variables defined in the scripting language are not restricted in length. “Not restricted” means that
the variables are limited by the memory quota of a session, which is defined by the system administrator.
Internal numerical variables defined in the scripting language are of the DF34_DEC implementation type.

var string = this.ShortText; // string is a unrestricted string

var i = this.IntegerValue; // i is of DF34_DEC type
In the following example, a very long text is used:
var string = "Lorem ipsum dolor sit amet, consectetur …"
// very long text, containing \"culpa\" at position 1000+ and \"augue\" at
position 2000+
position = string.Find("\"culpa\"");
string.Substring(position); // result: ""culpa" …" (not restricted)

position = string.Find("\"augue\"");
this.ShortNote = string.Substring(position);// result: ""augue" duis …" (40
char)

SAP Cloud Applications Studio – Version May 2018 (1805)

286 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
Conversion

Syntax
If variables are typed with data types that belong to the same basic type in the scripting language, they are implicitly
converted by the scripting language. For example:
this.ID = this.ShortName;
if ( this.Amount.content > this.IntegerValue) …
If variables are typed with data types that belong to different basic types in the scripting language, they need to be
converted by using conversion functions, for example, ToString(), Numeric.ParseFromString(),
GlobalDateTime.ConvertToDate()..

Behavior
If you perform operations on string variables in your script files, you need to ensure that the length of the result
strings match the data type definition. For example:
// ShortName is typed with LANGUAGEINDEPENDENT_SHORT_Name -> length = 10
// LongName is typed with LANGUAGEINDEPENDENT_LONG_Name -> length = 40
this.ShortName = this.LongName.Substring(0, 10);

The program terminates when saving if the length of the LongName field is greater than 10 characters and no
check exists.

If the content of a variable is outside the range that is specified by the data type definition, the following can occur
as a consequence:
● Program termination, for example, an overflow error
● A system message
● An implicit conversion, for example, a cutoff

Variables of unrestricted length, for example, variables of the LANGUAGEINDEPENDENT_Text data type, are
truncated at a length of 255 characters as soon as they are saved to the database. For texts that are longer
than 255 characters, use the TextCollection dependent object.

For variables that are typed with numerical data types, rounding is performed according to the definition of the target
data type. While the scripting language uses decfloat34 internally, the values are rounded according to the
definition of the data type as soon as the value is assigned to a business object element.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 287
 Note: The Quantity.content data type is specified as a decimal value with 31 digits and 14 fractions.
this.IntegerValue1 = 1 / 3; // result: 0
this.IntegerValue2 = 2 / 3; // result: 1
var num = 1/3;
this.IntegerValue3 = num * 3; // result: 1
this.IntegerValue4 = this.IntegerValue1 * 3; // result: 0
this.Quantity1.content = 1 / 3000000000; // result: 0.00000000033333
this.Quantity2.content = 2 / 3000000000; // result: 0.00000000066667
num = 1/3000000000;
this.Quantity3.content = num * 3000000000; // result: 1
this.Quantity4.content = this.Quantity1.content * 3000000000; // result:
0.99999
this.Quantity5.content = 1 / 3000000000000000000; // result: 0
num = 1/3000000000000000000;
this.Quantity6.content = num * 3000000000000000000; // result: 1
this.Quantity7.content = this.Quantity5.content * 3000000000000000000; //
result: 0
num = this.Quantity5.content;
this.Quantity8.content = num * 3000000000000000000; // result: 0

Additional Properties for Identifier Data Types

For identifier data types, additional properties are specified in the GDT definition:
● Upper case conversion
● Alpha conversion
Alpha conversion fills purely numeric user input like “4711” with leading zeros from the left side to allow better
sorting in character fields. For example, if alpha conversion is not used, an alphabetic sorting would lead to
sorting results such as: “1”, “10”, “100”, “1000”, “2”, “20”, “200”, and so on.

The UI runtime performs upper case conversion and alpha conversion automatically. The scripting language,
however, does not perform these types of conversion automatically. Therefore you need to ensure this in your script
files.

ID data type (supporting upper case conversion and alpha conversion)

var string =
"123456789a123456789b123456789C123456789D123456789E123456789F123456789G1234567
89H123456789G123456789I";
this.ID = string;
position = this.ID.Find("A"); // result: -1
The result is —1 because the content of the ID is not automatically converted to upper case. To convert
to upper case, use the ToUpperCase built-in function, for example:
var string =
"123456789a123456789b123456789C123456789D123456789E123456789F123456789G1234567
89H123456789G123456789I";
this.ID = string.ToUpperCase();
position = this.ID.Find("A"); // result: 9

SAP Cloud Applications Studio – Version May 2018 (1805)

288 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
Variables Typed with Code Data Types
Code data types can be mapped to the string basic type or the numeric character basic type. The behavior of a
variable typed with a code data type, for example, PriorityCode, ApprovalStatusCode and
Amount.currencyCode, is as follows:
● The variable can contain alphanumeric characters or numeric characters. The value range is then defined by
fixed or configurable code lists.
● A variable can be assigned, compared, and so on, to a string data type (“=”, “==”, “+”) if the variable is typed
with a code data type mapped to the string basic type . If the code data type, however, is mapped to the
numeric character basic type, you need to use the ToString built-in function in order to assign or compare
the variable to a string data type.
● The variable cannot be assigned, compared, and so on, to other code data types (“=”, “==”, “+”)

The UI runtime performs a content check of the code list. The scripting language, however, does not perform this
check automatically. Therefore you need to ensure this in your script files.

var string = "123456789a123456789b123456789C123456789D";

this.ApprovalStatusCode = string; // result: "12"
// Note: "12" is not an allowed code value.
// Note: Assignment between IDs is not allowed.
this.ApprovalStatusCode = this.DeliveryPriorityCode;

7.3 Front-End Script for the UI Designer

7.3.1 Front-End Script Reference

Overview
The front-end script is the programming language used in the user interface designer (UI designer) to define a set
of rules and the logic of the behavior of UI controls. For example, you can write a front-end script to enable an edit
button only when a field is selected on the user interface. The front-end script must only be used for user interface
related adaptation; it must not contain any business logic.
Front-end scripts are used in the following use cases:
● Dynamic setting of UI properties such as Visible, Enabled, Read-only, Mandatory, and Color
● UI-specific code lists
● Dynamic calls of event handlers (for example, for dynamic OBN links)

Script Execution
All scripts (including calculation rules) are executed in a sequential manner together with all other events by the
event queue processor in the UI runtime on the client. Parallel execution of scripts is not possible. For each execution
of a script, the scripts environment is recreated. All variables, including global variables, are reset.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 289
 Due to this execution strategy:
● A large number of executing script instances (such as those triggered by the recalculation of
properties) or slow scripts can cause the client to react slowly. This is because all scripts in the event
queue are processed before event handler operations that are triggered by end user interaction.
● Events that are triggered by a script — either directly or implicitly due to data manipulation — are also
queued and processed only after the script has terminated.

Syntax
The scripts are defined as part of a UI component model. The UI component models are stored and processed as
XML files; the script sources are stored as character data sections within these UI component models. The character
set of the scripts is based on UTF-8.
Each script and each block used inside control statements is a sequence of statements. For more information, see
Lexical Structure of Front-End Scripts [page 292] and Syntax of Front-End Scripts [page 293].
For more code samples, see Front-End Code Snippets [page 297].

Any software coding or code lines/strings (“Code”) provided in this documentation are only examples
and are not intended for use in a productive system environment. The Code is only intended to better
explain and visualize the syntax and phrasing rules for certain SAP coding. SAP does not warrant the
correctness or completeness of the Code provided herein and SAP shall not be liable for errors or damages
cause by use of the Code, except where such damages were caused by SAP with intent or with gross
negligence.

Interacting with UI Runtime

The following figure provides an overview of the UI client runtime environment that the front-end script interacts
with.

SAP Cloud Applications Studio – Version May 2018 (1805)

290 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
Client Controller Overview

Interacting with Runtime Data

The interaction with runtime data is accomplished by accessing members of the global variable $data. For more
information, see Interacting with Runtime Data [page 303].

Interacting with Runtime Component Controller

Each script is executed as an operation of an event handler and runs within the scope of the UI component controller.
The global variable $controller provides information about UI component controller's state and methods to
interact with the component controller. For more information, see Global Variable: $controller [page 307].

Using the Text Pool

Scripts should never contain any literals that are intended to be presented to the end user, because they cannot be
translated. Texts for the end user should also never be created by concatenating variables or variables and literals,
because the order of the elements may have to change in different languages. Instead, you should use modeled texts
from the text pool of the UI component.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 291
7.3.2 Lexical Structure of Front-End Scripts

The lexical structure of the front-end scripts contains identifiers, comments, and literals.

Identifiers
Identifiers consist of:
● Letters: a-z, A-Z
● Digits: 0–9
● Special: underscore ( _ )

Identifiers must start with a letter or an underscore. There is no length restriction for identifiers.

We recommend using reasonable identifiers since parsing times are adversely affected by large identifiers.

Comments
Comments follow Java/C# specification:
● Single line comments start with //. The remainder of the line is considered part of the comment.
● Comments delimited by /* and */. All content between the delimiters is considered part of the comment.

Literals
● String Literals
String expressions begin and end with double or single quote marks, and these string expressions are subject
to backslash escape.
The scripting engine does not support any escape sequences in the literals.

In general, we do not recommend using escape sequences.

● Numeric Literals
○ -1234: Numeric integers must only contain decimal digits (other characters such as underscore ( _ ) are
not supported).
○ 123.56: Decimals must consist of two strings of decimal digits separated by a period ( . ).

See Also
Syntax of Front-End Scripts [page 293]

SAP Cloud Applications Studio – Version May 2018 (1805)

292 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
7.3.3 Syntax of Front-End Scripts

The syntax of the front-end script contains variables, statements, and expressions.

Variables
The following variables are supported:
● Global variables prefixed by a $-character
The UI runtime framework automatically adds the following global variables into the script environment:
○ $controller: allows interaction with the UI component controller. For more information, see Global
Variable: $controller [page 307].
○ $data: allows access to and modification of the data of the UI component. For more information, see
Interacting with Runtime Data [page 303].
○ $textpool: allows the use of modeled texts from the text pool of the UI component.
○ $eventArgs: allows accessing event-specific data.
○ $currentrow: for calculation rules of controls used inside iterator elements (for example, cell renderers
in the table control), $currentrow provides access to the list row against which the control is bound.
● Local variables

The basic types that can be used for scripting correspond to the types used by the UI controller:
● boolean
● integer: a 32–bit integer value
● decimal: a 128–bit data type. Compared to floating-point types, the decimal type has a greater precision
and a smaller range, which makes it suitable for financial and monetary calculations.
● string: string literals
● date: date and time
● data object references: references to elements from the data container of the UI component.

The initial type of a variable is determined the first time the variable is assigned a value. Afterwards, only values of
the same type can be assigned.
Constants are not supported.

Statements
Simple statements are as follows:

assignment statement

Syntax assignment :=
reference = expression

Example tuesday = 'Tuesday'

number = 10

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 293
print statement

Syntax arguments :=
expression
| expression, argument_list

print_statement :=
print expression
| print arguments

Example print "SAO cloud solution"

print "Value", a

Comment The print() statement, although supported, does not have any practical value for the scripts used in the runtime
framework. It is used for internal debugging purposes only.

Control statements are as follows:

if statement

Syntax if_statement:
if_predicate block end
| if_predicate block else_block
| if_predicate block elseif_statement

if_predicate:
if expression then
| if expression NEWLINE

else_block:
else block end

elseif_statement:
elseif_predicate block end
| elseif_predicate block else_block
| elseif_predicate block elseif_statement

elseif_predicate:
elif expression then
| elif expression NEWLINE

SAP Cloud Applications Studio – Version May 2018 (1805)

294 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Example if ( true ) then print 'ok' end

if ( true )
print 'ok'
end

a=1;
if ( a==2 )
print 'ko' ;
elif ( a==1 )
print 'ok' ;
else
print 'ko' ;
end

a=1;
if ( a==2 )
print 'ko' ;
elif ( a==1 )
b=3;
if ( b==2 )
print 'ko' ;
elif ( b==1 )
print 'ko' ;
else
print 'ok' ;
end
else
print 'else reached' ;
print 'ko' ;
end

unless statement

Syntax unless_statement :=
unless_predicate block end
| unless_predicate block else_block

unless_predicate :=
unless expression then
| unless expression NEWLINE;

else_block :=
else block end

Example unless ( false )

print 'ok'
end

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 295
ternary statement

Syntax ternary_statement :=
expression ? statement : statement

Example a=1; b=3; c=3;

((a > 0) and (b == 3)) ? (a=1) : (c=2)

Comment In this example, the expression on the left side evaluates to "true".
The assignment statement a=1 is executed.

for statement

Syntax for_statement :=
for_in block end

for_in:
for reference in expression NEWLINE

Example result = ''

for i in 2..9
result = result + i
end

Comment Only integer ranges in the form 2..5 (last item included) and 2...5 (last item excluded) are supported. All other
expressions will raise a runtime error.

while statement

Syntax while_statement:
while_predicate block end

while_predicate:
while expression NEWLINE

Example i=0
while i<5
print i
i=i+1
end

Expressions
The front-end script interpreter supports the following expressions:
● literals, decimal numbers, integer numbers, constants true and false
● parentheses to indicate precedence
● method invocations
● variables
● unary expressions
● boolean expressions
● relational expressions
● equality expression

SAP Cloud Applications Studio – Version May 2018 (1805)

296 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 ● not expression
● range expression: only integer ranges in the form 2..5 (last item included) and 2...5 (last item excluded) are
supported.
● #, —, *, /

All statements are expressions, including methods and variables. The last member pushed onto the stack is
considered as the return value of a method, there is no return statement. The return value of a calculation
rule in the runtime framework is determined in the same way. To return a value from a method or from the
front-end script program, use an expression.
Example
a // will return the value of the variable 'a'
result = a // will also return the value of the variable 'a' because the assignment
statement is an expression and puts 'a' onto the stack

The variable result has been introduced to facilitate adoption of the runtime framework. It is a common
cause of error that after an assignment to result (which is a way of moving a value to the stack), another
statement moves another value to the stack and this is then used as the result of the calculation rule.

7.3.4 Front-End Code Snippets

Index of Code Samples

The following code snippets are front-end script examples and are grouped thematically:
Lists in Data Container
● Get Lead Selection Data
● Get Lead Selection in a Hierarchical List
● Change Data for All List Entries
● Evaluate a Clicked Link in a List
● Disable a Button Based on a Field in Selected Row in a List
● Set Lead Selection of a List
● Working with Lead Selection in Lists
● Working with Lead Selection in Hierarchical Lists
● Build Up a List and Fill Its Content

Calculation Rules
● Make a Control Read Only Using Calculation Rule
● Accessing Data List Values from Calculation Rules
● Access Description Values of Codes in Scripts and Calculation Rules

Language Constructs
● And/Or/If Clauses
● Break Out of a Loop

Other
● Call Another EventHandler

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 297
 ● Using Textpool for Translatable Text
● Format Amount Field with Right Decimals Depending on Currency Code
● Using $System.Saved
● Prevent the Context from Becoming Dirty
● Check If an Object-Based Navigation (OBN) Target Is Assigned to the User

Any software coding or code lines/strings (“Code”) provided in this documentation are only examples
and are not intended for use in a productive system environment. The Code is only intended to better
explain and visualize the syntax and phrasing rules for certain SAP coding. SAP does not warrant the
correctness or completeness of the Code provided herein and SAP shall not be liable for errors or damages
cause by use of the Code, except where such damages were caused by SAP with intent or with gross
negligence.

Lists in Data Container

Get Lead Selection Data

Description Gets lead selection data from a list and changes an unbound data model field that is assigned to
attribute SelectedVariant of a pane container. Script is executed OnLeadSelectionChange of
DataList:List in Data Model.
Result: In an object worklist, the displayed preview pane changes when a new line is selected.

Example lead = $data.List.LeadSelectedIndex;

if (lead > -1)
paymenttype = $data.List.Get(lead).PaymentType;
if (paymenttype == "18")
$data.UIState._SelectedVariant = "IncomingCheck"
else
$data.UIState._SelectedVariant = "NoData"
end
end

Get Lead Selection in a Hierarchical List

Description Gets lead selection data from a hierarchical list.

Example p_lead = $data.List.LeadSelectedIndex;

if (p_lead > -1)
c_lead = $data.List.Get(p_lead).List.LeadSelectedIndex;
if (c_lead > -1)
$controller.HandleEvent("EventOnChild");
else
$controller.HandleEvent("EventOnParent");
end
end

Change Data for All List Entries

Description Calculates or changes fields in a list.

SAP Cloud Applications Studio – Version May 2018 (1805)

298 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Example for i in 0..($data.List.Count-1)
$data.List.Get(i).Column11 = "Hello World " + i
end

Evaluate a Clicked Link in a List

Description If a link is clicked in a list, and the lead selection does not change, you need to check the event
argument.
Note that if you have a simple source side dispatching script (only one variable involved), we
recommend using the Eventhandler condition instead of a script.

Example row = $eventArgs.RowIdentifier;

if (row)
paymenttype = $data.DataList.Get(row).PaymentType;
if (paymenttype == "18")
$controller.HandleEvent("FireIncomingCheck")
elseif (paymenttype == "4")
$controller.HandleEvent("FireOutgoingCheck")
else
$controller.HandleEvent("NotSupported")
end
end

Disable a Button Based on a Field in Selected Row in a List

Description You need to create a variable of type Boolean and initial value "true" at root level. Associate the same
with enabled property of the button. In the OnClick event of the button, associate an EventHandler
of type script and use the following script.

Example leadIndex = $data.DataList.LeadSelectedIndex;

if (leadIndex > -1)
status =
$data.DataList.Get(leadIndex).TaxDeclarationLifeCycleStatusCode;
if(status == "2")
$data.result = false;
else
$data.result = true;
end
else
$data.result = true;
end

Set Lead Selection of a List

Description Note that the selection applies only to the data which is available on the client.

Example lead = 2
$data.DataList.SetLeadSelectedIndex(lead)

Working with Lead Selection in Lists

Description Obtains a reference to the selected row in a flat list.

Example row = $data.MyList.LeadSelectedRow

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 299
Working with Lead Selection in Hierarchical Lists

Description Obtains a reference to the selected row in a hierarchical list.

Example row = $data.MyList.LeadTreeSelectedRow

Build Up a List and Fill Its Content

Description This function may be useful for custom radio button groups.
Note that you will have to set the text via a textpool element.

Example $data.DataList.Add( )
$data.DataList.Add( )
for i in 0..($data.DataList.Count-1)
$data.DataList.Get(i).Code = i
$data.DataList.Get(i).Value = "text" + i
end

Calculation Rules

Make a Control Read Only using Calculation Rule

Description In the property dialog of the control, the ReadOnly attribute is available. If you open the editor and
chose the Calculation Rule selection, a script window opens. To insert new lines, use the Shift + Enter
key combination. In the example below, you must make sure to add IssuerBankCode as an
invalidation trigger to execute the script.
Note that the value of the last expression is used as the result of a calculation rule. The actual name
of the parameter does not matter. This will lead to unwanted side effects if you use any expressions
after determining the return value. To avoid this, make sure to do a final expression of the return
value at the end of your script. The recommended name for the parameter is result.

Example if ($data.IssuerBankCode == "4711")

result = true;
else
result = false;
end
// ... any other assignments can happen here
result = result

Accessing DataList Values from Calculation Rules

Description If you want to get the current value of a datalist field in a calculation rule, you can use
$controller.Resolve and the relative path of the field in the datalist.
Note that there is limited SAP List Viewer (ALV) functionality for calculated fields in lists. For example,
there is no sorting and grouping.
In the example below, to ensure that the value is always recalculated correctly, you also have to add
the fields LowerBoundaryFiscalYearID_LRL_DE and LowerBoundaryAccountingPeriodID_LRO_DE
as invalidation triggers of your calculation rule.

Example if ( $controller.Resolve("./TestRunIndicator_LRI_DE") )
result = $textpool.Lookup("PTK") //Test
else
result = $textpool.Lookup("PTL") //Update
end

SAP Cloud Applications Studio – Version May 2018 (1805)

300 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
Access Description Values of Codes in Scripts and Calculation Rules

Description You can access the code value description by adding .Description.

Example code = $data.CountryCode

description = $data.CountryCode.Description

text = "Code: " + code + ", Description: " + description

$data.CalculatedValue = text

Language Constructs

And/Or/If Clauses

Description You can put parts of the and/or/if clause in one row.

Example LeadSelection = $data.Interactor1_KA.LeadSelectedIndex

if ( LeadSelection > -1 )
SelectedRow = $data.Interactor1_KA.Get(LeadSelection)
if ( SelectedRow.InspectionTypeCode_EP != 5 and
SelectedRow.Status_ES == 5 and SelectedRow.KIT_KFQ == "NO" and
$controller.Utils.IsInitial(SelectedRow.BRCA_EM) )
result = false
else
result = true
end
end

Break Out of a Loop

Description Useful for conditional breakouts from the loops, such as selecting a checkbox depending on a
condition.

Example LeadSelection = $data.DataList.LeadSelectedIndex;

KeyFigureLeadSelected = $data.DataList.Get(LeadSelection).dataField;

i = 0;
while i < $data.DataList.RowCount
if ( $data.DataList.Get(i).dataField == KeyFigureLeadSelected )
break;
else
$data.ManageExceptions.Get(LeadSelection).checkbox1 =
true;
end
end
i = i + 1;
end

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 301
Other

Call Another Event Handler

Description The following shows how to call the event handlers "FireIncomingCheck" and
"FireAccountingDocument" from a script.

Example if (paymenttype == "18")

$controller.HandleEvent("HandleIncomingCheck")
else
$controller.HandleEvent("HandleAccountingDocument")
end

Using Textpool for Translatable Text

Description Translatable text should not be hard coded in scripts. You should define a new entry in TextPool with
parameter binding.

Example $data.PreviewTitle = $textpool.Lookup("_tUt43CUQ4E0ZhtAgUA0Em")

Format Amount Field with Right Decimals Depending on Currency Code

Description To format an amount according to a currency code, you need a new statement.

Example amount = 2.1

currencyCode = "EUR"
result = $controller.Utils.AmountToString(amount, currencyCode)

Using $System.Saved

Description You can use $System.Saved in your scripts as follows.

Example if ($controller.Utils.IsInitial($data.$System.Saved))
result = true
else
result = false
end

Prevent the Context from Becoming Dirty

Description Note that DirtyState is an unbound field that needs to be added under /Root in the data model to
save the dirty state temporarily.
To prevent the context from becoming dirty, for example on executing a business object action (and
thus preventing the work protect popup from being shown), you have to do as follows.

Example 1. Add a script operation before the business object action is executed which saves the current
dirty state:
$data.DirtyState = $data.$System.IsDirty
2. Add another script operation after the business object action is executed which resets the
dirty state to the previous value:
$data.$System.IsDirty = $data.DirtyState

SAP Cloud Applications Studio – Version May 2018 (1805)

302 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
Check If an Object-Based Navigation (OBN) Target Is Assigned to the User

Description You can check if an OBN target configured for a floorplan has a valid UI assigned to the current user.

Example $controller.CheckNavigationTarget("ServiceRequestRootCreateWithRefer
ence")

See Also
Front-End Script Reference [page 289]

7.3.5 Interacting with Runtime Data

Overview
The interaction with runtime data is accomplished by accessing members of the global variable $data. The global
variable $data provides access to the controller data container of the UI component by providing a reference to the
Root structure.

Structure of Runtime Data

The data container of the UI runtime stores the data of the current UI data in the form of named data elements.
Types of data elements are as follows:
● Data Structures
Data structures may contain other data elements (fields, structures, and lists). Each member inside a
structure can be uniquely identified by its name.
The Root of the data container is the entry point to all data available for a UI component instance.
● Data Fields
Data fields are used to hold data values. The following base types are supported:
○ string
○ integer
○ float
○ date
○ boolean
○ binary
Note that it is not possible to work with binary data fields in scripting.
○ time
Note that it is not possible to work with time data fields in scripting.
○ datetime
Note that it is not possible to work with datetime data fields in scripting.
● Data Lists
Lists contain zero or more List Rows, which are derived from data structures.

The overall composition structure of the data container is determined at design time. It is not possible to add
additional members to a data structure at runtime.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 303
Referencing Runtime Data

When you use the following rules to work with data container elements, you acquire references to data element
instances. The data elements are mutable.

Accessing Members of Structures

Data structure members can be accessed using the syntax <data structure reference>.<member name>.
The result is a reference to the member data element or null if the member does not exist.
Note that when a structure data element is created by the data container, all members are initialized:
● Data field members are created with their initial values.
● Data structure members are created and their members are initialized.
● List members are created and hold zero rows.

Examples:
// access the field 'NameField' underneat the 'Root' structure
nameFieldRef = $data.NameField

// access a sub structure

subStructRef = $data.SubStruct

// acess a member of the sub structure

subFieldRef1 = subStructRef.SubField

// directly access a member of the sub structure

subFieldRef2 = $data.SubStruct.SubField
Working with Lists
Lists hold zero or more rows of uniform data structures.
Once you have acquired a reference to a list, you may use the following methods and properties to work with the list:
If your list is bound to the backend, the rows that are available in the client may only represent a snapshot of the
actual rows the list holds. De-referencing via index is generally discouraged in this case because all indices apply to
the current snapshot of rows available in the client.

Method/Property Returns Description Example

Add() Reference Adds a new list row and returns a myListRef = $data.MyList
to new list reference to resulting list row myListRowRef = myListRef.Add()
row instance. myListRowRef.ProductTitle = 'SAP
instances This may only be used with unbound Business ByDesign'
lists. For bound lists, explicitly myListRowRef.Vendor = 'SAP AG'
modeled list operations have to be
used.

Delete(rowIdentif Deletes a row identified by the rowrowIdentifier = '12'

ier(string)) identifier rowIdentifier. $data.MyList.Delete(rowIdentifier
This may only be used with unbound )
lists. For bound lists, explicitly
modeled list operations have to be
used.

SAP Cloud Applications Studio – Version May 2018 (1805)

304 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
 Delete(index(inte Deletes the row with the zero-based $data.MyList.Delete(2)
ger)) index from the list.
This may only be used with unbound
lists. For bound lists, explicitly
modeled list operations have to be
used.

Clear() Clears the list (removes all row $data.MyList.Clear()

instances).
This may only be used with unbound
lists. For bound lists, explicitly
modeled list operations have to be
used.

Get(rowIdentifie Reference Returns the list row with the rowRef = $data.MyList.Get('12')
r(string)) to the row specified row identifier or null if no
instance such row exists.

Get(index(string)) Reference Returns the list row at the zero- rowRef = $data.MyList.Get(2)
to the row based index of the list.
instance

LeadSelectedIndex integer Returns the zero-based index of the index =

lead selected row or -1 if no lead $data.MyList.LeadSelectedIndex
selection exists.
Returns 999999999 if the lead
selected row instance is not
available on the client (for example,
due to paging).

LeadSelectionNotOnP boolean Returns true if the lead selected isNotOnPage =

age row instance is not available on the $data.MyList.LeadSelectionNotOnPa
client (for example, due to paging). ge

LeadSelectedRow Reference Returns the lead selected row rowRef = $data.LeadSelectedRow

to the row instance if a lead selection exists and
instance the lead selected row instance is
available on the client, which may
not always be the case (for example,
due to paging)

LeadTreeSelectedRow Reference Returns the lead selected row rowRef =

to the row instance for a hierarchical list along $data.LeadTreeSelectedRow
instance the chain of lead selections in the
hierarchical list.

RowCount integer Returns the number of rows that are count = $data.RowCount
currently available on the client for
this list.
The value may be smaller than
EffectiveRowCount for paged
lists.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 305
EffectiveRowCount integer Returns the number of rows of the count = $data.EffectiveRowCount
list.
This number may exceed the
number of rows which are available
on the client.

Working with data fields

The scripting environment is agnostic of the CCTS type system used by the UI layer. Do not use scripting to
construct or format any representation of a data field value which is intended to be presented to an end user.
Use text pool replacements instead.

Once you have acquired a reference to a data field instance, you may work with it like a normal scripting variable.
This means you may assign or retrieve the value.
Additional properties exist for data fields:

Property Returns Description Example

Code Code Returns the code value for a code- codeValue = $data.CodeField.Code
value list field. The value of the field itself
(string) contains the key of the code (which
may differ from the code value for
hierarchical code lists). Returns
null if the code list item for the
code has not yet been read or if the
field does not have a code list.

Description Descriptio Returns the description a code-list codeValue =

n (string) field (translated human-readable $data.CodeField.Description
text). Returns null if the code list
item for the code has not yet been
read or if the field does not have a
code list.

IsEnabled Enabled Returns whether or not the field is enabledValue = $data.IsEnabled

value enabled. For fields bound to node
(boolean) attributes, the enabled state is
determined by the BO / ECO. Client-
only fields are always enabled.

Locator string Returns the binding expression of locator = $data.SomeField.Locator

the field (including row identifiers if
the field is contained in list(s)).

ModelLocator string Returns the binding expression of locator =

the field (without row identifiers if $data.SomeField.ModelLocator
the field is contained in list(s)).

SAP Cloud Applications Studio – Version May 2018 (1805)

306 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
7.3.6 Global Variable

7.3.6.1 Global Variable: $controller

Overview
The $controller global variable enables script developers to access state information of the UI component
controller and to call controller methods.

Controller State Properties

Property Type Description Example

ErrorOccu boolean Returns a boolean value that indicates whether an error has if($controller.ErrorOccu
rred occurred. rred)
// block executed on
error
end

Transient boolean Returns a boolean value that indicates whether or not a if($controller.Transient
ErrorOccu transient error has occurred. Transient errors are typically ErrorOccured)
rred caused by input validation errors and have to be resolved by // block which executes
the end user before normal processing can resume. on transient error
end

GetCurren string Returns the current logon language of the running session. $data.currLanguage =
tLanguage $controller.GetCurrentLa
nguage();

Utils <object> Returns an object instance which provides general utilities for utils=$controller.Utils
working with all data types. For more information, see General
Utilities for Working with Data [page 308].

StringUtils <object> Returns an object instance which provides utilities for working utils =
with strings. For more information, see Utilities for Working $controller.StringUtils
with Strings [page 309].

Controller Methods

Method Description Example

HandleEvent(eventNa Adds the event with the name eventNameto the $controller.HandleEvent('MyEvent'
me(string)) event processing queue of the controller. The )
method invocation is not synchronous.

OpenLink(uri(string)) Opens the target uri in a new window $controller.OpenLink('http://

www.sap.com')

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 307
Resolve(bindingExpres Resolves the data field that is addressed by the $controller.Resolve('/Root/
sion(string)) specified binding expression. For more LastName')
information, see Binding Expression
[page 310].

CheckNavigationTarge Returns a boolean value that indicates whether or isactive =

t(outPortName(string) not a navigation is possible via the out-port with $controller.CheckNavigationTarget
) the name outPortName. ('MyOutPort')
This value is true for all dynamic navigations.

7.3.6.2 General Utilities for Working with Data

Utils returns an object instance which provides general utilities for working with all data types.

Method Type Description Example

IsInitial(data(object)) boolean This a=0

expression if($controller.Utils.IsInitial(a))
is true if the // this block will execute
argument end
data
contains
the initial
value for its
type.

AmountToString(amount(decimal), string Returns the amount = 2.1

currencyCode(string)) amount currencyCode = "EUR"
value as a result =
string $controller.Utils.AmountToString(amount,
formatted currencyCode)
according
to the
currency
code. This
also
ensures
that the
correct
number of
decimal
digits as
defined by
the
currency is
used.

SAP Cloud Applications Studio – Version May 2018 (1805)

308 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
7.3.6.3 Utilities for Working with Strings

An object instance with utilities for working with strings is exposed via the global variable
$controller.StringUtils.

Property Type Description Example

BeginsWith(text(string), boolean Returns a boolean if($controller.StringUtils.BeginsWith('SAP

pattern(string)) value which cloud solution', 'SAP'))
indicates whether // this block will execute
text starts with end
pattern.

EndsWith(text(string), boolean Returns a boolean if($controller.StringUtils.EndsWith('SAP

pattern(string)) value which cloud solution', 'SAP'))
indicates whether // this block will not execute
text ends with end
pattern.

Contains(text(string), boolean Returns a boolean if($controller.StringUtils.Contains('SAP

pattern(string)) value which cloud solution', 'cloud'))
indicates whether // this block will execute
text contains end
pattern.

AsciiToChar(ascii(integer)) string Returns the ascii if(s = $controller.StringUtils.Contains(32)

character (as a if(s == ' ')
string) which // this block will execute
corresponds to the end
code ascii.

IndexOfString(text(string), integer Returns the zero-position =

pattern(string)) based first position
$controller.StringUtils.IndexOfString('SAP
of pattern in cloud solution', 'cloud')
text or -1, if if(position == 4)
pattern does not // this block will execute
occur in text. end

Length(text(string)) integer Returns the number l = $controller.StringUtils.Length('SAP')

of characters in if(l == 3)
text. // this block will execute
end

LeftSubString(text(string), string Returns the first s =

length(integer)) length characters $controller.StringUtils.LeftSubString('SAP
of text. ods', 3)
if(s == 'SAP')
// this block will execute
end

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 309
RightSubString(text(string), string Returns the last s =
length(integer)) length characters $controller.StringUtils.RightSubString('SAP
of text. ods', 3)
if(s == 'ByD')
// this block will execute
end

Trim(text(string)) string Returns text s = $controller.StringUtils.Trim(' SAP ods

without leading and ')
trailing blanks. if(s == 'SAP ods')
// this block will execute
end

LeftTrim(text(string)) string Returns text s = $controller.StringUtils.LeftTrim(' SAP

without leading ods ')
blanks. if(s == 'SAP ods ')
// this block will execute
end

RightTrim(text(string)) string Returns text s = $controller.StringUtils.RightTrim(' SAP

without trailing ods ')
blanks. if(s == ' SAP ods')
// this block will execute
end

Replace(text(string), string Replaces all s = $controller.StringUtils.Replace('SAP

oldValue(string), occurences of ods', 'ods', 'cloud')
newValue(string)) oldValue in text if(s == 'SAP cloud')
to newValue and // this block will execute
returns the result as end
a new string.

7.3.6.4 Binding Expression

Using the Resolve controller method, script developers can use binding expressions to resolve the value of a field.
binding_expression :=
/Root binding_particles

binding_particles :=
binding_particle
| binding_particle binding_particle

binding_particle :=
/{data element name}
| /{list name}[{row identifier}]
| /{list name}/@{row index}

SAP Cloud Applications Studio – Version May 2018 (1805)

310 © 2018 SAP SE. All rights reserved. • P U B L I C Scripting Languages
Particles
All binding expressions must start with the /Root particle and must specify at least one additional particle.
Each particle addresses a member of its parent by name.
● Example 1: Assume that a data field named LastName is defined under the root of the data model, the
expression /Root/LastName can be used to address the data field.
● Example 2: Assume that a data field named LastName is defined as a member of the structure Address, which
is defined under the root of the data model, the expression /Root/Address/LastName can be used to
address the data field.

List Rows
List rows can be addressed as follows:
● By providing the row identifier
Example: Assume that a data field named LastName is defined as a member of the list Addresses, which is
defined under the root of the data model, and the row identifier of the row to be addressed is 4711, the
expression /Root/Addresses[4711]/LastName can be used to address the field.
● By providing the (zero-based) row index
Example: Assume that a data field named LastName is defined as a member of the list Addresses, which is
defined under the root of the data model, and the row identifier of the row to be addressed is the fifth row in
the list, the expression /Root/Addresses/@4/LastName can be used to address the field.

Using indices is not a reliable way of addressing rows in lists that may be paged. Unless modeled
otherwise, all bound lists are paged by default.

● Via the lead selection

Example: Assume that a data field named LastName is defined as a member of the list Addresses, which is
defined under the root of the data model, the expression /Root/Addresses/LastName can be used to
address the field of the row of the list Addresses, which has the lead selection.

SAP Cloud Applications Studio – Version May 2018 (1805)

Scripting Languages P U B L I C • © 2018 SAP SE. All rights reserved. 311
8 Developer Desktop

8.1 Overview of the Developer Desktop

The development tools provided by the SAP Cloud Applications Studio (“studio”) are presented in an integrated
development environment (IDE) based on Microsoft Visual Studio. The user interface (UI) of the studio is referred
to as the developer desktop. From the developer desktop you access specific features and tools of the development
environment.

Any software coding or code lines/strings (“Code”) provided in this documentation are only examples
and are not intended for use in a productive system environment. The Code is only intended to better
explain and visualize the syntax and phrasing rules for certain SAP coding. SAP does not warrant the
correctness or completeness of the Code provided herein and SAP shall not be liable for errors or damages
cause by use of the Code, except where such damages were caused by SAP with intent or with gross
negligence.

SAP Cloud Applications Studio – Version May 2018 (1805)

312 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Choose a Help Topic for the Developer Desktop

● Business Configuration [page 314] ● Analytics [page 440]

Learn how to create and change business topics, Learn how to create and change data sources, and
business options, and business configuration sets for create and manage reports, and get informed about
your solution. Also find out how to configure a business analytical report content, transformation rules, and
configuration view and assign it to the Business aggregation.
Configuration work center and how to check your In addition, find information on the tools available in
content in the business adaptation catalog. the SAP cloud solution to assist you in defining your
In addition, find information on the tools available in reports.
the SAP cloud solution to assist you in creating and ● Mashups [page 475]
editing your business configuration content. Learn about creating mashups using the studio and
● Business Objects [page 346] the UI designer.
Learn how to create a business object, define its nodes ● Service Integration [page 519]
and relevant elements, create script files, activate your Learn how to configure internal communication to
business object, and generate the screens for your communicate with business objects in different
business object. deployment units, and create XML file input to import
● Extensibility external XML data into a business object.
○ Business Object Extensions [page 378] In addition, find information on the tool for file input in
Learn how to create a business object extension, the SAP cloud solution.
define business logic for a business object ● Web Services [page 529]
extension, screens, reports, and the Enterprise Learn how to create, modify, authorize and test a Web
Search. service, and how to remove authorization to a Web
○ Process Extension Scenarios [page 395] service.
A process extension scenario links the data from ● Mass Data Run [page 464]
one business context to other related business Learn how to create a mass data run for your custom
contexts. Learn how to create a process business object.
extension scenario from a list of predefined
● Print Forms [page 438]
extension scenarios.
Learn how to create a print form, add a preview button
○ Enhancement Implementations [page 400] to it, and test the print form. In addition, find
SAP provides enhancement options based on information on the tools available in the SAP cloud
SAP technology that allow you to enhance the solution to assist you in creating and editing your print
standard behavior of specific applications of the forms.
SAP cloud solution without modifying the
● Approval Process [page 425]
standard solution. Learn how to create
Learn how to create a default approval process, assign
enhancement implementations of SAP
it to the UI, and test it.
enhancement options.
In addition, find information on the tools available in
● Reuse Libraries [page 403] the SAP cloud solution to assist you in creating and
Learn how to create and define your own reuse editing your approval process.
libraries and reuse functions to organize complex code
in your solution or to reuse your code in script files.
● Code List Data Type [page 406]
Learn how to define a code list data type for your
solution and use it when you create your custom
business object or business object extension.
● Notification Rules
Learn how to enable your custom business object for
notification rules.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 313
Find out about Debugging, Tracing, Dump Analysis, and
Translation

● Debugging [page 566] ● Dump Analysis [page 582]

Learn how to use the debugger to observe the runtime The Dump Analysis tool window presents dump
behavior of your solution and to locate logic errors. The information in a reader friendly format. Learn how the
debugger works with your script files and allows you tool window supports you in finding the root cause of
to break the execution of your solution at specified a dump.
breakpoints to examine your code and to display
● Report an Incident [page 565]
values of variables defined in your solution.
If you encounter a problem during development, you
● Tracing [page 573]
can report an incident in the SAP cloud solution to
Learn how to use tracing to record information about
request help in solving the problem.
your code as it is being executed. From the Trace
● Translation [page 584]
Explorer, you can run a local trace, run a trace for a
Find out how you can translate your solution content
business user in the SAP cloud solution, use incident
into the languages supported by the SAP cloud
traces for troubleshooting purposes, and view the
solution.
results of a recorded trace.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

8.2 Business Configuration

8.2.1 Business Configuration Quick Guide

In SAP cloud solutions, business configuration enables prospective or existing customers to evaluate and set up
their system in the production environment to meet company-specific requirements. It also allows customers to
adapt and optimize their solutions at any time as business needs change.
You must create business configuration content for all solution capabilities that you create using the studio. You
create business configuration content in the studio and anchor your solution in the business adaptation catalog
(BAC) so that it is available for activation by customers who buy your solution.

● You cannot create business configuration content in solution templates.

● You can create business configuration content on your development tenant only.

Availability

SAP Cloud Applications Studio – Version May 2018 (1805)

314 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Business and Technical Background

Business Adaptation Catalog (BAC)

The full set of the SAP cloud solution's capabilities is outlined in a central business adaptation catalog (BAC). This
catalog organizes and structures the capabilities into a hierarchy of business areas, packages, topics, and options.
Solutions created in the studio require business configuration content that then appears as elements (BAC elements)
in the catalog and allows administrators to implement solutions in the production environment.
For more information, see here [page 320].

Business Configuration Content

You can define the following business configuration content in the studio:

Business Configuration Content

Type Use How To...

Business option (mandatory) Create a business option when no selective adaptation ...Create a Business Option
of business configuration content is required. [page 324]

Business topic and business Create a business topic when you need to provide ...Create a Business Topic and
options multiple business options to key users. Business Options [page 326]

Country Define a country if your solution requires country- ...Create a Country and Business
specific scoping for a country that is not supported by Options [page 329]
the SAP standard cloud solution.

Business configuration set Create a BC set to configure the behavior of business ...Create a BC Set Using an SAP BCO
(BC set) processes in your solution and define code list data [page 332]
types that you can use to model fields in a business ...Create a BC Set Using a Custom
object. BCO [page 336]
Create a BC set using an SAP business configuration
object (BCO) to configure the behavior of standard
business processes in the SAP cloud solution.

Business configuration object Create a custom BCO to define solution-specific ...Create a Business Configuration
(BCO) business configuration content on which you can base Object [page 334]
a BC set.

Business configuration view Create a BC view to allow key users to change the values ...Create a Business Configuration
(BC view) defined in a BC set during fine-tuning. View [page 337]

Fine-tuning project template Create a fine-tuning project template to provide sample ...Create a Fine-Tuning Project
content for a specific scenario that is defined by SAP. Template [page 340]

Defining Business Configuration Content

When you create a solution in the studio, you must create business configuration content that contains at least one
business option to allow customers who buy your solution to activate the solution in the production environment.
For more information, see here [page 321].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 315
Configurable Code Lists
You can use the business configuration wizards to create configurable code lists.
For more information, see Configurable Code Lists.

Maintenance of Business Configuration Content

A customer-specific solution is in maintenance mode, if it has been assembled and downloaded; the solution status
then is Assembled. You can make changes to the solution in a patch; however, you can only make restricted changes
to certain content types. These change and delete restrictions ensure that you do not make changes to a solution
that could lead to loss of data or create inconsistencies or errors on a customer's production tenant.
For information about creating a patch, see Patches [page 166].
For information about the change and delete restrictions for business configuration content in a solution that is in
maintenance mode, see Maintenance of Business Configuration Content [page 322].

Customer Tools for Business Configuration

If you want to know more about how customers configure their solutions and work with business configuration
content, take a look at the "Configuring Your SAP Solution" topic in the documentation in your SAP cloud solution.

Tasks

Tasks in the Business Configuration Wizard

You perform the following tasks using the Business Configuration Wizard:
● Create a Business Option
You can create a business topic to group business options and provide multiple business options for
customers to customize your solution.
For more information, see here [page 324].
● Create a Business Topic and Business Options
You can create a business topic to group business options and provide multiple business options for
customers to customize your solution.
For more information, see here [page 326].
● Create a Country and Business Options
You can define a country and create one or more business options, if your solution requires country-specific
scoping for a country that is not supported by the SAP cloud solution.
For more information, see here [page 329].
● Change a Business Option or a Business Topic
1. In the studio, open the solution that contains the business option or business topic you want to change.
2. In the Solution Explorer, right-click the solution and select Open.
The Business Configuration Wizard opens.
3. Make your changes and then click Save.
To change a business option that you added to a business topic, in the Create Business Options and
Assign Solution Content step, use the Change Business Option function.
● Delete a Business Option or a Business Topic
1. In the studio, open the solution that contains the business option or business topic you want to change.
2. In the Solution Explorer, right-click the solution and do one of the following:

SAP Cloud Applications Studio – Version May 2018 (1805)

316 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 ● If you have created only one business option, select Delete.
● To delete a business topic and all business options you added to the business topic, select Delete.
● To delete a business option that you added to a business topic without deleting the business topic:
1. Select Open.
The Business Configuration Wizard opens.
2. In the Create Business Options and Assign Solution Content step, select the business option
you want to delete and then click Delete Business Option.

For information about the change and delete restrictions for business configuration content in a
solution that is in maintenance mode, see Maintenance of Business Configuration Content
[page 322].

Create Business Configuration Set

Solution Explorer Business Configuration Create Business Configuration Set

You perform the following tasks using the Business Configuration Set Wizard:
● Create a BC Set Using an SAP BCO
You can create a business configuration set (BC set) using an SAP business configuration object (BCO) to
configure the behavior of standard business processes in the SAP cloud solution. If you create an
implementation of an enhancement option which is for single use only, you can also define a BC set using an
SAP BCO so that you can enhance the filter values.
For more information, see here [page 332].
● Create a BC Set Using a Custom BCO
You can create a business configuration set (BC set) using a business configuration object (BCO) that you
have defined in your solution.
For more information, see here [page 336].
● Change a Business Configuration Set
1. In the studio, open the solution that contains the business configuration set (BC set) you want to change.
2. If the BC set is based on a business configuration object (BCO) defined in the solution and you want to
add or change a field, change the referenced BCO by doing the following:
a. In the Solution Explorer, clean all BC sets that are based on the BCO by right-clicking the .bcc files
and selecting Clean.
b. Double-click the .bco file.
The BCO opens in a document window.
c. On the Fields tab, add or change one or more fields and then save your changes.
d. In the Solution Explorer, right-click the .bco file and select Activate.
You can only activate a BC set that is based on a BCO that you changed by opening the BC set in a
document window and saving it.
3. In the Solution Explorer, double-click the .bcc file.
The Business Configuration Set Wizard opens.
4. Make your changes, for example, by adding or changing the field values of any fields you add or changed
in the BCO.
You cannot change the name of a BC set.
5. In the Solution Explorer, right-click the .bcc file and select Activate.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 317
 For information about the change and delete restrictions for business configuration content in a
solution that is in maintenance mode, see Maintenance of Business Configuration Content
[page 322].

Create Business Configuration Object

You perform the following tasks using the Business Configuration Object Wizard:
● Create a Business Configuration Object
In the Solution Explorer, click the Add New Item button and select Business Configuration Object.
You can create a business configuration object (BCO) and use it as the basis of a business configuration set
(BC set).
For more information, see here [page 334].
● Change a Business Configuration Object
1. In the Solution Explorer, clean all BC sets that are based on this BCO by right-clicking the .bcc files and
selecting Clean.
2. In the Solution Explorer, double-click the .bco file.
The business configuration object opens in a document window.
3. On the Fields tab, add or change one or more fields and then save your changes.
4. In the Solution Explorer, right-click the .bco file and select Activate.
● Delete a Business Configuration Object
In the Solution Explorer, right-click the .bco file and select Delete.

To delete a business configuration object that is used in a business configuration set, you must first
delete the BC set.

For information about the change and delete restrictions for business configuration content in a
solution that is in maintenance mode, see Maintenance of Business Configuration Content
[page 322].

Create Business Configuration View

You perform the following task in the studio and in the UI designer:
● Create a Business Configuration View
In the Solution Explorer, click the Add New Item button and select Business Configuration View.
For more information, see here [page 337].

Create a Tax Decision Tree (available for SAP Business ByDesign only)
You can create a tax decision tree to automatically determine a tax event for a country that does not have an SAP
country version in SAP Business ByDesign.
For more information, see Create a Tax Decision Tree [page 341].

Create a Fine-Tuning Project Template (available for SAP Business ByDesign only)
You perform the following tasks in the studio and in the SAP cloud solution in the Business Configuration work center:
● Create a Fine-Tuning Project Template
In the Solution Explorer, click the Add New Item button and select Implementation Project Template.

SAP Cloud Applications Studio – Version May 2018 (1805)

318 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 You can create a fine-tuning project template in the studio as part of a solution. Fine-tuning project templates
provide sample content for a specific scenario that is defined by SAP, such as Financials Chart of Account.
The fine-tuning activities you need to complete for the template are explicitly listed.
For more information, see Create a Fine-Tuning Template [page 340].
● Complete an Implementation Project Template
Solution Explorer *.bct Complete
1. In the studio, open the solution that contains the implementation project template you want to complete.

You can complete a project once the design has been accepted.

2. In the Solution Explorer, right-click the .bct file of the active implementation project template and select
Complete.
Under Edit Activities, the activities are no longer displayed as links.
3. Optional: Check the status of the implementation project template in the studio by doing the following:
a. Open the implementation project template in the studio by double-clicking the .bct file.
b. Check that the status of the implementation project template is Completed, that a completion date
is displayed, and that you can no longer change the description.
● Reopen an Implementation Project Template
Solution Explorer *.bct Reopen
1. In the studio, open the solution that contains the implementation project template you want to reopen.
2. In the Solution Explorer, right-click the .bct file of the completed implementation project template and
select Reopen.
3. Optional: Check the status of the implementation project template in the studio by doing the following:
a. Open the implementation project template in the studio by double-clicking the .bct file.
b. Check that the status of the implementation project template is Active and that no completion date
is displayed.
4. Optional: Check the status of the implementation project template in the SAP cloud solution by doing
the following:
a. In the SAP cloud solution, choose Business Configuration Implementation Projects and select
your project.
b. Check that the Edit Project Scope and Open Activity List functions are available and that the status
of the project is Started.

Check Content in the Business Adaptation Catalog

To check content in the business adaptation catalog (BAC), for example, for testing purposes, you must be
assigned the Business User role and have access rights for the Business Configuration work center. For more
information, see User Setup Quick Guide [page 31].

1. In the SAP cloud solution, in the Business Configuration work center, open the Implementation Projects view.
2. Select a project and click Edit Project Scope .
The Edit Project Scope guided activity is displayed. The business topic or business option you created using
the Business Configuration Wizard is displayed in the Scoping phase under Scoping Element. The description
and scoping questions you defined in the Business Configuration Wizard are displayed in the Questions phase.

Deploy Business Configuration

In the Solution Explorer, click the solution and select Deploy Business Configuration.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 319
You deploy your business configuration content be able to use it in a solution. The system makes the parameter
values available in the development environment for testing.

If you have defined BAC elements for your solution, a dialog box opens when you use the Deploy Business
Configuration function. You have to select one of the following options:
● Deploy all business configuration content for your solution
● Deploy only the business configuration content for your solution that is assigned to the business
options you have selected in the business adaptation catalog

This allows you to test both partial and complete activation of your business configuration content in the
development environment.

8.2.2 Business and Technical Background

8.2.2.1 Business Adaptation Catalog

Overview
The full set of the SAP cloud solution's capabilities is outlined in a central business adaptation catalog (BAC). This
catalog organizes and structures the capabilities into a hierarchy of business areas, packages, topics, and options.
Solutions created in the studio require business configuration content that then appears as elements (BAC elements)
in the catalog and allows administrators to implement solutions in the production environment.
Customers work with the SAP cloud solution in the production environment after it has gone live. This environment
contains all elements required to run the customer's business processes using the SAP cloud solution and customers
can adapt the solution in the Business Configuration work center.

Features
When you create a solution in the studio, you must create business configuration content that contains at least one
business option to allow customers who buy your solution to activate the solution in the production environment.
A business option represents the most detailed decision level involved in defining or adapting a solution capability.
Business options can be hidden or can appear in scoping, fine-tuning, and/or the solution proposal. Each business
option specifies a particular way to perform a function. Each business option belongs to a business topic. For
information about how to create a business option, see Create a Business Option [page 324].
Optionally, you can also create the following business configuration content:
● Business topic
A business topic relates to specific functions within an application area. In the standard SAP solution,
examples are Account Management and Time Administration. Each business topic belongs to a business
package and contains a number of business options.
For information about how to create a business topic, see Create a Business Topic and Business Options
[page 326].
● Business configuration set (BC set)
A BC set is a technical container for the configuration settings and corresponding values that are associated
with a business option. The content contained within BC sets is deployed to the runtime environment where
it is loaded into the underlying configuration tables. Each configuration setting within a BC set has attributes
which specify whether it is hidden, visible, or changeable for the customer.

SAP Cloud Applications Studio – Version May 2018 (1805)

320 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 For information about how to create a BC set using an SAP business configuration object (BCO), see Create
a BC Set Using an SAP BCO [page 332].
● Business configuration view (BC view)
To allow administrators to change the values of a BC set during fine-tuning, you can create a BC view and
assign this view to the Business Configuration work center.
For information about how to create a BC view, see Create a Business Configuration View [page 337].

See Also
Business Configuration Quick Guide [page 314]

8.2.2.2 Defining Business Configuration Content

Overview
When you create a solution in the studio, you must create business configuration content that contains at least one
business option to allow customers who buy your solution to activate the solution in the production environment.
You can assign your business option to a standard business topic or you can create a business topic to which you
add your business options.

Prerequisites
● You have created and opened a solution in the studio. For more information, see Create a Customer-Specific
Solution [page 165].
● You understand the dependencies that exist between the elements in the business adaptation catalog and
the constraints that are applied by the selections that administrators make during scoping. For more
information, see Scoping.
● To check content in the business adaptation catalog, for example, for testing purposes, you must be assigned
the Business User role and have access rights for the Business Configuration work center. For more
information, see User Setup Quick Guide [page 31].

Process Flow
1. In the studio, you create one or more business options.
If you create more than one business option, you group your business options in a business topic. For
information about how to create one business option, see Create a Business Option [page 324]. For
information about how to create more than one business option, see Create a Business Topic and Business
Options [page 326].
2. You define your business options.
a. You provide a scoping question and details about each business option.
During scoping, administrators select or deselect a business option by answering its associated scoping
question. Scoping questions are located in the business adaptation catalog (BAC) at the business topic
level. A scoping question is displayed for each business option in the BAC. In the SAP cloud solution,
customers can review the details you provide about BAC elements on the Overview and Relevance
tabs.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 321
 b. If you want to assign a business configuration set (BC set) to the business option, you specify whether
you want customers to be able to adapt the field values of the BC set during fine-tuning.
When an administrator of the SAP solution selects a business option in the scoping phase that is relevant
for fine-tuning, they can adjust the values of the business configuration sets (BC sets) assigned to this
business option by performing a fine-tuning activity.
For more information about implementing a project in an SAP production system and the Fine-Tune
phase, see Implementing a Project — First Implementation.
c. You select additional functionality required by your solution by selecting the relevant business topics
from the business adaptation catalog list.
d. You define where you want the business configuration content to be available in the business adaptation
catalog.
For more information about the business adaptation catalog, see Business Adaptation Catalog
[page 320] and "Configuring Your SAP Solution" in the documentation in your SAP cloud solution.
3. Optional: You create a BC set and assign it to a business option.
You specify whether administrators are able to add or delete the values of specific fields in fine-tuning.
For more information, see
● Create a BC Set Using an SAP BCO [page 332]
● Create a BC Set Using a Custom BCO [page 336]
4. Optional: You create a business configuration view (BC view) for a BC set using the UI designer and assign
this view to the Business Configuration work center.
For more information, see Create a Business Configuration View [page 337].

You can only create a BC view for a BC set that uses a custom BCO. You cannot create a BC view for
an SAP BCO.

5. You activate your business configuration content.

The system generates the required business configuration object(s) and data type(s).
6. You trigger deployment of your business configuration content to be able to use the content in your solution.

When you use the Deploy Business Configuration function, a dialog box opens. You have to select one
of the following options:
● Deploy all business configuration content for your solution
● Deploy only the business configuration content for your solution that is assigned to the business
options you have selected in the business adaptation catalog

This allows you to test both partial and complete activation of your business configuration content in
the development environment.

7. You check that your business configuration content appears in the BAC in the SAP cloud solution.
For more information, see Business Configuration Quick Guide [page 314].

8.2.2.3 Maintenance of Business Configuration Content

Overview
A customer-specific solution is in maintenance mode, if it has been assembled and downloaded; the solution status
then is Assembled. You can make changes to the solution in a patch; however, you can only make restricted changes
to certain content types. These change and delete restrictions ensure that you do not make changes to a solution
that could lead to loss of data or create inconsistencies or errors on a customer's production tenant.

SAP Cloud Applications Studio – Version May 2018 (1805)

322 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Change and Delete Restrictions
The following tables give an overview of the change and delete restrictions for business configuration content in a
solution that is in maintenance mode.

Maintenance of Business Topics

Action Allowed

Change Type of Business Configuration No

Change Name No

Change Description Yes

Change Anchor No

Change Required Scope With restrictions: You can remove the required scope, but you
cannot add required scope.

Change assigned business options With restrictions: see "Maintenance of Business Options"
below

Delete assigned business options No

Change content assigned to business options No

Create (and delete) a new business option Yes

Maintenance of Business Options

Action Allowed

Change Name No

Change Description Yes

Change Visible in Scoping setting With restrictions:

● If the Visible in Scoping option is not selected, selection
is allowed.
● If the Visible in Scoping option is selected, removal is
not allowed.

Change Visible in Fine-Tuning setting Yes

Change Mandatory setting No

Change Scoping Question / Statement Yes

Change Anchor No

Maintenance of Business Configuration Objects

Action Allowed

Delete business configuration object Yes

Change Name No

Change Description Yes

Change Create Code List Data Type setting No

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 323
Action Allowed

Change or delete fields No

Add or delete new fields Yes

Create (and delete) a new business configuration object Yes

Maintenance of Business Configuration Sets

Action Allowed

Delete business configuration set Yes

Change Business Configuration Object Type No

Change Name No

Change Description No

Change Business Configuration Object No

Business configuration set field values: Change or delete rows No

Business configuration set field values: Add or delete new rows Yes

Create (and delete) a new business configuration set Yes

Maintenance of Business Configuration View

Action Allowed

Delete business configuration view Yes

See Also
Business Configuration Quick Guide [page 314]
Lifecycle Management of Customer-Specific Solutions [page 138]
Maintenance Mode [page 170]

8.2.3 Tasks

8.2.3.1 Create a Business Option

Overview
You can create a business topic to group business options and provide multiple business options for customers to
customize your solution.
If you want to create more than one business option, you need to create a business topic first to group the business
options. For more information, see Create a Business Topic and Business Options [page 326].

SAP Cloud Applications Studio – Version May 2018 (1805)

324 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Prerequisites
● You have created and opened a solution in the studio. For more information, see Create a Customer-Specific
Solution [page 165].
● To check content in the business adaptation catalog, for example, for testing purposes, you must be assigned
the Business User role and have access rights for the Business Configuration work center. For more
information, see User Setup Quick Guide [page 31].

Procedure
1. In the Solution Explorer, do the following:
a. Click the Add New Item button.
The Add New Item dialog opens.
b. Select SAP Business Configuration BAC Elements and click Add.
The Business Configuration Wizard opens.
2. In the Create and Anchor Elements in the Business Adaptation Catalog step, do the following:
● Under Type of Business Configuration, select Business Option.
● Under Basic Information, do the following:
○ Enter a name and a description for the business option and then enter a scoping question.
Your scoping question indicates the functionality of the business option and allows administrators
to decide whether to select the business option during project implementation. For more
information about project implementation, see Implementing a Project — First Implementation.
○ Optional: Select Visible in Fine-Tuning if you want to assign a business configuration set (BC set)
to the business option and you want customers to be able to adapt the field values of the BC set
during fine-tuning; then under Fine-Tuning, do the following:
1. If customers must complete a fine-tuning activity before the solution goes live, select
Mandatory for Go-Live.
2. Enter a description for the fine-tuning activity.

A fine-tuning activity is only mandatory for go-live in the customer system if a BC set that
was created using a custom business configuration object (BCO) is assigned to the
business option. In this case, you must also create a BC view. For more information about
creating a BC view, see Create a Business Configuration View [page 337].

○ On the Overview tab, write a text that describes the function that this element provides and the
benefits of using this element. Aim to write no more than three to five sentences. However, when
additional valuable information is available, you should include it.

Example: The Foreign Currency Remeasurement Methods for Cash business

option provides a procedure for converting the value of cash balances held in foreign
currency to the company currency at a key date, for example, at the end of the month.

○ On the Relevance tab, write a text that describes when or why the customer should select this
element and what are the implications of selecting or not selecting this element. Explain the
relevance of this element in terms of real-world business requirements.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 325
 Example: The Foreign Currency Remeasurement Methods for Cash business
option is relevant for companies that have cash accounts stated in foreign
currencies.automatically included in your scope.

● Under Business Adaptation Catalog (BAC), do the following:

○ Next to the Anchor field, click Select and anchor your business topic in the BAC by expanding the
tree and selecting a business topic or business option group.
○ Optional: Next to the Required Scope field, click Select and then select the standard BAC elements
in the cloud solution that you require for your solution by expanding the tree and selecting one or
more business packages or business topics.
○ Click Next.
3. In the Review step, check that the information you have entered is correct and then click Finish.
The system assigns all content that is relevant for business configuration such as business objects and
business configuration sets (BC sets) to your business option. The content is displayed under the business
option.
4. In the Solution Explorer, right-click the .bac file and then select Activate to make the business option available
in the BAC.

Result
The system has added the business option to the business adaptation catalog (BAC). You can check the result by
logging on to the cloud solution as a business user. You select an implementation project in the Business
Configuration work center and edit the project scope. The Scoping step displays the BAC elements and you can
navigate to the business option you created.

See Also
Business Configuration Quick Guide [page 314]

8.2.3.2 Create a Business Topic and Business Options

Overview
You can create a business topic to group business options and provide multiple business options for customers to
customize your solution.

Prerequisites
● You have created and opened a solution in the studio. For more information, see Create a Customer-Specific
Solution [page 165].
● To check content in the business adaptation catalog, for example, for testing purposes, you must be assigned
the Business User role and have access rights for the Business Configuration work center. For more
information, see User Setup Quick Guide [page 31].

SAP Cloud Applications Studio – Version May 2018 (1805)

326 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Procedure
1. In the Solution Explorer, do the following:
a. Click the Add New Item button.
The Add New Item dialog opens.
b. Select SAP Business Configuration BAC Elements and click Add.
The Business Configuration Wizard opens.
2. In the Create and Anchor Elements in the Business Adaptation Catalog step, do the following:
● Under Type of Business Configuration, select Business Topic and Business Options.

If you need to create only one business option, under Type of Business Configuration, select
Business Option. For information about how to create one business option for a solution, see
Create a Business Option [page 324].

● Under Basic Information, do the following:

○ Enter a name and a description for the business topic.
○ On the Overview tab, write a text that describes the function that this element provides and the
benefits of using this element. Aim to write no more than three to five sentences. However, when
additional valuable information is available, you should include it.

Example: The Bank Directory File Upload business topic allows you to upload
a bank directory from a provider of your choice into SAP’s cloud solution. Before
uploading the file, you must ensure that the contents of the file, namely the bank data,
matches the order prescribed in the SAP format.

○ On the Relevance tab, write a text that describes when or why the customer should select this
element and what are the implications of selecting or not selecting this element. Explain the
relevance of this element in terms of real-world business requirements.

Example: The Bank Directory File Upload business topic is relevant if you wish
to upload a bank directory from a provider of your choice.

● Under Business Adaptation Catalog (BAC), do the following:

○ Next to the Anchor field, click Select and anchor your business topic in the BAC by expanding the
tree and selecting a business package.
○ Optional: Next to the Required Scope field, click Select and select the standard BAC elements in
the cloud solution that you require for your solution by expanding the tree and selecting one or
more business packages or business topics. If you reference SAP content in BC sets, you need
to select the SAP business topic to which the corresponding business option is assigned as the
required scope. The system checks this selection before test deployment.
3. In the Create Business Options and Assign Solution Content step, create your business options by doing the
following:
a. Click Create Business Option.
The Create Business Option dialog box opens.
b. In the Create Business Option dialog box, under Basic Information, do the following:
1. Enter a name and a description for the business option.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 327
 2. On the Overview tab, write a text that describes the function that this element provides and the
benefits of using this element. Aim to write no more than three to five sentences. However, when
additional valuable information is available, you should include it.

Example: The Foreign Currency Remeasurement Methods for Cash business

option provides a procedure for converting the value of cash balances held in foreign
currency to the company currency at a key date, for example, at the end of the month.

3. On the Relevance tab, write a text that describes when or why the customer should select this
element and what are the implications of selecting or not selecting this element. Explain the
relevance of this element in terms of real-world business requirements.

Example: The Foreign Currency Remeasurement Methods for Cash business

option is relevant for companies that have cash accounts stated in foreign
currencies.automatically included in your scope.

c. Optional: If you want the business option to appear in the BAC, select Visible in Scoping and under
Scoping, do the following:
● If your business option provides functionality that is essential for your solution, select
Mandatory and enter a scoping statement that describes the functionality of the business option.
By default, the business option will be in scope when a customer selects the business topic in the
BAC.
● If your business option is not mandatory, enter a scoping question. Your scoping question
indicates the functionality of the business option and allows administrators to decide whether to
select the business option during project implementation.
d. Optional: Select Visible in Fine-Tuning if you want to assign a business configuration set (BC set) to
the business option and you want customers to be able to adapt the field values of the BC set during
fine-tuning; then under Fine-Tuning, do the following:
1. If customers must complete a fine-tuning activity before the solution goes live, select Mandatory
for Go-Live.
2. Enter a description for the fine-tuning activity.

A fine-tuning activity is only mandatory for go-live in the customer system if a BC set that was
created using a custom business configuration object (BCO) is assigned to the business option.
In this case, you must also create a BC view. For more information about creating a BC view,
see Create a Business Configuration View [page 337].

e. Under Anchor Business Option below, you can either accept the selection of Header Element of the
Solution or select SAP Element and then Select Anchor to anchor your business option in the BAC.
Expand the tree and select your business topic, an SAP business topic or business option group and
click OK.
f. Repeat the steps above for each business option and click Next.
The Create Business Options and Assign Solution Content step now displays all business options that
you created on the right.
4. In the Create Business Options and Assign Solution Content step, assign solution content to each business
option by using the arrow buttons or by means of drag-and-drop.
The system displays the solution content you assign under the business option. You can also use the arrow
buttons or drag-and-drop to unassign solution content.

SAP Cloud Applications Studio – Version May 2018 (1805)

328 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 You must assign all solution content such as business objects and BC sets to a business option
before you trigger test deployment of your solution. If dependencies exist between BC sets defined
in your solution. for example, a value defined in one BC set is referenced in a second BC set, you
must assign both BC sets to the same business option or you must assign the referenced BC set
to a mandatory business option.

5. In the Review step, check that the information you have entered is correct and then click Finish.
6. In the Solution Explorer, right-click the .bac file and then select Activate to make the business topic available
in the BAC.

Result
The system has added the business topic to the business adaptation catalog (BAC). You can check the result by
logging on to the cloud solution as a business user. You select an implementation project in the Business
Configuration work center and edit the project scope. The Scoping step displays the BAC elements and you can
select the business topic that you created.
If you have created all business configuration content your solution requires, you can trigger deployment of your
business configuration content to be able to use the content in your solution. To do this, right-click your solution and
select Deploy Business Configuration.

When you use the Deploy Business Configuration function, a dialog box opens. You have to select one of the
following options:
● Deploy all business configuration content for your solution
● Deploy only the business configuration content for your solution that is assigned to the business
options you have selected in the business adaptation catalog

This allows you to test both partial and complete activation of your business configuration content in the
development environment.

See Also
Business Configuration Quick Guide [page 314]

8.2.3.3 Create a Country and Business Options

Overview
You can define a country and create one or more business options, if your solution requires country-specific scoping
for a country that is not supported by the SAP cloud solution.

Prerequisites
● You have created and opened a solution in the studio. For more information, see Create a Customer-Specific
Solution [page 165].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 329
 ● To check content in the business adaptation catalog, for example, for testing purposes, you must be assigned
the Business User role and have access rights for the Business Configuration work center. For more
information, see User Setup Quick Guide [page 31].

Procedure
1. In the Solution Explorer, do the following:
a. Click the Add New Item button and click Add.
The Add New Item dialog opens.
b. Select SAP Business Configuration BAC Elements .
The Business Configuration Wizard opens.
2. In the Create and Anchor Elements in the Business Adaptation Catalog step, do the following:
a. Under Type of Business Configuration, select Country and Business Options.
b. Under Basic Information, enter a name and description and then select the country for which your
solution is relevant.
3. In the Create Business Options and Assign Solution Content step, create one or more business options for
your country by doing the following:
a. Click Create Business Option.
The Create Business Option dialog box opens.
b. In the Create Business Option dialog box, under Basic Information, do the following:
● Enter a name and a description for the business option.
● On the Overview tab, write a text that describes the function that this element provides and the
benefits of using this element. Aim to write no more than three to five sentences. However, when
additional valuable information is available, you should include it.

The Time Recording Integrated with Procurement business option allows you to use
time recording for third party service agents, such as consultants and service
technicians. The working times of service agents can then be allocated to procured
services and purchase orders. The recorded times are taken into account in invoice
verification.

● On the Relevance tab, write a text that describes when or why the customer should select this
element and what are the implications of selecting or not selecting this element. Explain the
relevance of this element in terms of real-world business requirements.

The Time Recording Integrated with Procurement business option is relevant if you
want to consider the working time recorded by service agents for invoice verification.
If the Services with Time Sheet Recordings for Projects business option (within the
Service and Non-Stock Material Procurement business topic) is selected, this business
option is automatically included in your scope.

c. Optional: If you want the business option to appear in the BAC, select Visible in Scoping and under
Scoping, do the following:
1. If your business option provides functionality that is essential for your solution, select
Mandatory and enter a scoping statement that describes the functionality of the business option.
If your business option is not mandatory, enter a scoping question. Your scoping question
indicates the functionality of the business option and allows administrators to decide whether to
select the business option during project implementation.

SAP Cloud Applications Studio – Version May 2018 (1805)

330 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 When you define a country, you must create at least one business option that is visible
in scoping.

2. Click Select Anchor and anchor your business option in the BAC by expanding the tree and
selecting a business topic or a business option group.
d. Optional: Select Visible in Fine-Tuning if you want to assign a business configuration set (BC set) to
the business option and you want customers to be able to adapt the field values of the BC set during
fine-tuning; then under Fine-Tuning, do the following:
1. If customers must complete a fine-tuning activity before the solution goes live, select Mandatory
for Go-Live.
2. Enter a description for the fine-tuning activity.

When you define a business configuration set (BC set), you must also specify whether
administrators are able to add or delete the values of specific fields. For more information about
creating a BC set, see Create a BC Set with a Custom BCO [page 336].

e. Repeat the steps above for each business option.

The Create Business Options and Assign Solution Content step now displays all business options that
you created for the country on the right.
4. In the Create Business Options and Assign Solution Content step, assign solution content to each business
option by using the arrow buttons or by means of drag-and-drop.
The system displays the solution content you assign under the business option. You can also use the arrow
buttons to unassign solution content. Click Next.

You must assign all solution content such as business objects and BC sets to a business option
before you trigger test deployment of your solution. If dependencies exist between BC sets defined
in your solution. for example, a value defined in one BC set is referenced in a second BC set, you
must assign both BC sets to the same business option or you must assign the referenced BC set
to a mandatory business option.

5. In the Review step, check that the information you have entered is correct and then click Finish.
6. In the Solution Explorer, right-click the .bac file and then select Activate to make the country and its business
options available in the BAC.
7. Check that the system has added the country and the business options you created to the business adaptation
catalog (BAC) by doing the following:
a. Log on to the cloud solution as a business user.
b. In the Business Configuration work center, open the Implementation Projects view.
c. Select a project and click Edit Project Scope .
The Edit Project Scope guided activity is displayed.
d. In the Country and Type of Business step, click Edit Countries and check that the country you created
is display in the list of available countries.
e. In the Implementation Focus step, select Complete Solution.
f. In the Scoping step, check that the visible business options you created using the Business
Configuration Wizard are displayed.
The business options are displayed in the Scoping Element column under the business topic you
selected as an anchor. The description and scoping questions you defined in the Business
Configuration Wizard are displayed in the Questions step.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 331
Result
The system has added your country and the business options you created to the business adaptation catalog (BAC)
and you have checked the result in the cloud solution. The country description is displayed in the business adaptation
catalog in the Country and Type of Business step.
If you have created all business configuration content your solution requires, you can trigger deployment of your
business configuration content to be able to use the content in your solution. To do this, right-click the solution and
select Deploy Business Configuration.

When you use the Deploy Business Configuration function, a dialog box opens. You have to select one of the
following options:
● Deploy all business configuration content for your solution
● Deploy only the business configuration content for your solution that is assigned to the business
options you have selected in the business adaptation catalog

This allows you to test both partial and complete activation of your business configuration content in the
development environment.

See Also
Business Configuration Quick Guide [page 314]

8.2.3.4 Create a BC Set Using an SAP BCO

Overview
You can create a business configuration set (BC set) using an SAP business configuration object (BCO) to configure
the behavior of standard business processes in the SAP cloud solution. If you create an implementation of an
enhancement option which is for single use only, you can also define a BC set using an SAP BCO so that you can
enhance the filter values.

● You can only create a BC set using an SAP BCO if you are developing the solution on your development
tenant. For information, see Lifecycle Management of Customer-Specific Solutions on Your
Development Tenant [page 147].
● You cannot create BC sets using SAP BCOs in a solution template.

You can also create a BC set using a business configuration object that you have created in the solution. For more
information, see Create a BC Set Using a Custom BCO [page 336].

Prerequisites
● You have created and opened a solution in the studio. For more information, see Create a Customer-Specific
Solution [page 165].
● You have permission to access the business configuration objects (BCO) that are released with the SAP public
solution model (PSM).

SAP Cloud Applications Studio – Version May 2018 (1805)

332 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Procedure
1. In the Solution Explorer, do the following:
a. Click the Add New Item button.
The Add New Item dialog opens.
b. Select SAP Business Configuration Business Configuration Set and click Add.
The Business Configuration Wizard opens.
2. In the Select a BCO Type and Create a BC Set step, do the following:
a. Under Business Configuration Object Type, select Use SAP Business Configuration Object.
b. Under Basic Information, enter a name and a description.
c. Under Business Configuration Object, in the search field, type the name of the SAP BCO you want to
use or use the Search function to search for a BCO by deployment unit, namespace, or name.

You can only use BCOs that are released with the SAP public solution model (PSM).

Under Business Configuration Object, the system displays the deployment unit, the namespace, whether a
fine-tuning activity is available, and a description of the BCO.
3. In the Define the Values of Your Business Configuration Set step, specify the field values of your BC set by
doing the following:
a. In the BCO hierarchy view, select the root node.
If the BCO only has one node, by default, the hierarchy is hidden.
b. In the field columns, specify values for at least all mandatory fields.
An asterisk (*) is used to indicate mandatory fields. Field values must comply with the data type of the
field. You can display information about a field by clicking the field name.
c. Repeat the steps above for each node.
4. In the Review step, check that the information you have entered is correct and that the namespace of your
solution ( /BY*/) is added to the key field; then click Finish.
A new item with the file extension .bcc appears in the Solution Explorer under the project node. If you access
the values you defined for the BCO using the scripting language, for example, you create a query, the key
fields might contain the solution namepace as a prefix, which is also displayed in the Review step of the
Business Configuration Set Wizard.
5. In the Solution Explorer, right-click your business configuration set and select Activate.
The system generates the required business configuration object(s) and data type(s).
6. In the Business Configuration Wizard, in the Create Business Options and Assign Solution Content step, assign
your BC set to a business option by using the arrow buttons or by means of drag-and-drop.
For more information about assigning solution content to business options, see Create a Business Topic and
Business Options [page 326].
7. In the Solution Explorer, right-click your solution and select Deploy Business Configuration to be able to use
your business configuration content in a solution.
The system deploys the business configuration content you created and makes the field values available in
the development environment.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 333
 When you use the Deploy Business Configuration function, a dialog box opens. You have to select one
of the following options:
● Deploy all business configuration content for your solution
● Deploy only the business configuration content for your solution that is assigned to the business
options you have selected in the business adaptation catalog

This allows you to test both partial and complete activation of your business configuration content in
the development environment.

Result
You have created a BC set using an SAP BCO and assigned it to a business option.

See Also
Business Configuration Quick Guide [page 314]

8.2.3.5 Create a Business Configuration Object

Overview
You can create a business configuration object (BCO) and use it as the basis of a business configuration set (BC
set).

Prerequisites
You have created and opened a solution in the studio. For more information, see Create a Customer-Specific Solution
[page 165].

Procedure
1. In the Solution Explorer, do the following:
a. Click the Add New Item button.
The Add New Item dialog opens.
b. Select SAP Business Configuration Business Configuration Object and click Add.
The Business Configuration Wizard opens.
2. In the Create Business Configuration Object step, do the following:
● Under Basic Information, enter a name and description.
● Optional: Select Create Code List Data Type if you want the system to create a code list data type that
can be used, for example, in business objects and business objects extensions.
In this case, only one key field is allowed.

If you want to use a static code list in your solution, you can create a code list data type. For
more information, see Create a Code List Data Type [page 406].

SAP Cloud Applications Studio – Version May 2018 (1805)

334 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 3. In the Define Fields of the Business Configuration Object step, for each field you define, enter the following
data and click Next:
● Field name
● Field description
● Field type
Possible values are:
○ Key: key field of the business configuration object
○ Attribute: language-independent attribute of the business configuration object
○ Description: language-dependent attribute of the business configuration object
● Data type
For more information about the supported data types and default values, see Data Types [page 87].
● Data subtype
If you define a field of data type Code, you must select a data subtype.
● Length
● Decimal
● Mandatory
4. In the Review step, do the following:
a. Check that the information is correct:

Name [name of the business configuration object]

Description [description of the business configuration object]

Data Type* [name of the business configuration object]Code

* The data type is displayed if you have selected the Create Code List Data Type option in step
2.

b. Click Finish.
A new item with the file extension .bco appears in the Solution Explorer under the Business
Configuration node.
5. Activate the business configuration object by right-clicking the .bco file and selecting Activate.

Result
You have created a BCO that you can now use as the basis of a business configuration set (BC set). You can reference
the values of this BCO in more than one BC set. For more information, see Create a BC Set Using a Custom BCO
[page 336].

See Also
Business Configuration Quick Guide [page 314]
Create a BC Set Using an SAP BCO [page 332]

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 335
8.2.3.6 Create a BC Set Using a Custom BCO

Overview
You can create a business configuration set (BC set) using a business configuration object (BCO) that you have
defined in your solution.
You can also create a BC set using an SAP BCO. For more information, see Create a BC Set Using an SAP BCO
[page 332].

Prerequisites
You have created and activated a business configuration object in your solution. For more information about creating
a BCO, see Create a Business Configuration Object [page 334].

Procedure
1. In the Solution Explorer, do the following:
a. Click the Add New Item button.
The Add New Item dialog opens.
b. Select SAP Business Configuration Business Configuration Set and click Add.
The Business Configuration Wizard opens.

You can also right-click your custom BCO and select Create Business Configuration Set.

2. In the Select a BCO Type and Create a BC Set step, do the following:
a. Under Business Configuration Object Type, select Use Business Configuration Object Defined in
Solution.
b. Under Basic Information, enter a name and a description.
c. Under Business Configuration Object, in Name, select the business configuration object on which you
want to base your BC set; then click Next.

You can only use BCOs that you created in the solution.

3. In the Define the Values of Your Business Configuration Set step, specify the field values of your BC set.

● The field values must comply with the data type of the field. You can display information about
a field by clicking the field name.
● As a partner, you cannot enter values in the Key [Code]* field that start with “Z”. This
namespace is reserved for customers.
● When you, as a customer, enter values in the Key [Code]* field, these values should start with
“Z”. This guarantees that your entries cannot be overwritten by content delivered by a partner
solution. If, however, your business requires that you deviate from this recommendation, you
should inform the SAP partner to avoid clashes of content.

SAP Cloud Applications Studio – Version May 2018 (1805)

336 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Under Business Configuration Set Field Values, you can select Values can be added in Fine-Tuning; click
Next.
4. In the Review step, check that the information you have entered is correct and then click Finish.
A new item with the file extension .bcc appears in the Solution Explorer under the project node.
5. In the Solution Explorer, right-click the .bcc file and select Activate.
6. In the Business Configuration Wizard, in the Create Business Options and Assign Solution Content step, assign
your BC set to a business option by using the arrow buttons or by means of drag-and-drop.
For more information about assigning solution content to business options, see Create a Business Topic and
Business Options [page 326].
7. In the Solution Explorer, right-click your solution and select Deploy Business Configuration to be able to use
your business configuration content in a solution.
The system deploys the business configuration content you created and makes the field values available in
the development environment.

When you use the Deploy Business Configuration function, a dialog box opens. You have to select one
of the following options:
● Deploy all business configuration content for your solution
● Deploy only the business configuration content for your solution that is assigned to the business
options you have selected in the business adaptation catalog

This allows you to test both partial and complete activation of your business configuration content in
the development environment.

Result
You have created a BC set based on a BCO that is defined in your solution and assigned it to a business option.

See Also
Business Configuration Quick Guide [page 314]
Create a BC Set Using an SAP BCO [page 332]

8.2.3.7 Create a Business Configuration View

Overview
You can create a business configuration view (BC view) for a business configuration set (BC set) to allow
administrators to add new values during fine-tuning or to delete the values of a BC set. You create the view in the
studio and you model the view in the UI designer.

You can only create a BC view for a business configuration set (BC set) that was created using a custom
business configuration object (BCO). You cannot create a BC view for an SAP BCO.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 337
Prerequisites
● You have created a custom business configuration object (BCO). For information, see Create a Business
Configuration Object [page 334]. When you create your BCO, if you want the system to create a code list,
only one key field is allowed.
● To check content in the business adaptation catalog, for example, for testing purposes, you must be assigned
the Business User role and have access rights for the Business Configuration work center. For more
information, see User Setup Quick Guide [page 31].

Procedure
1. In the studio, create a business configuration view by doing the following:
a. In the Solution Explorer, activate the BCO for which you want to create the view by right-clicking
the .bco file ( ) and selecting Activate.
b. In the Properties window, make sure that the activation status of the BCO is Runtime objects up to
date.
c. Right-click the .bco file and select Create Business Configuration View.
The Create Business Configuration View dialog box opens.
d. Enter a name for the view, make sure that your BCO is selected, and then click OK.
A new item with the file extension .QA.uicomponent ( ) appears in the Solution Explorer.
e. In the Solution Explorer, open the BC view by right-clicking the .QA.uicomponent file and selecting
Open in UI Designer.
The view opens in the UI designer.
2. Optional: In the UI designer, modify the BC view, for example, change the field labels:
a. On the Designer tab, select the column whose name you want to change and in the Property Explorer,
under Text Information, click the Label field.
b. Click the arrow button and in the Dependent Property Editor, in the Overridden Text field, enter a new
name.
3. In the UI designer, assign your BC view to the Business Configuration work center by doing the following:
a. In the Configuration Explorer, open the Implementation Projects work center view by opening the /
SAP_BYD_APPLICATION_UI/BCTools/WorkCentre/ folder. The file name of the view is
ImplementationProjects_WCView.WCVIEW.uiwocview.
b. In the Extensibility Explorer, select the ImplementationProjects_WCView.ao.uianchor anchor
and click Assign Component to View.
c. In the Type field, select NavigationTarget.
d. In the Component field, select your BC view from the Repository. It is stored in the following folder:
[name of your solution]_BC] SRC [your BC view] . Click OK and Apply.

You can find the name of your solution in the studio: In the Solution Explorer, select your
solution. In the Properties, in the Project File field, there is the name of your solution.

e. Save and activate your UI and close the UI designer.

4. In the studio, create a BC set by doing the following:
a. In the Solution Explorer, right-click your .bco file and select Create Business Configuration Set.
The Business Configuration Set Wizard opens.

SAP Cloud Applications Studio – Version May 2018 (1805)

338 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 b. Follow the wizard steps and make sure that:
● Under Business Configuration Object Type, Use Business Configuration Object Defined in
Solution is selected.
● Under Basic Information, enter a name and description for the BC set.
● Under Business Configuration Object, the BCO you created is displayed in the Name field.
● You define that key users can add and delete field values during fine-tuning.
If you do not allow the addition nor the deletion of field values, customers will not be able to make
any changes on the BC view.
c. In the Solution Explorer, activate the BC set by right-clicking the .bcc file ( ) and selecting
Activate.
d. In the Properties window, make sure that the activation status of the BC set is Runtime objects up to
date.

For information about creating a BC set, see Create a BC Set Using a Custom BCO [page 336].
5. Make your BC view available in the business adaptation catalog (BAC) by doing the following:
a. In the Solution Explorer, select your solution and click Add New Item. Select BAC Elements and click
Add.
The Business Configuration Wizard opens.
b. Follow the wizard steps and create a business option or a business topic and more than one business
option.
Make sure that you select Visible in Fine-Tuning and, if appropriate, Mandatory for Go-Live for the
business option to which you want to assign the BC set that you created to make your BC view
accessible in fine-tuning.
c. In the Solution Explorer, right-click the .bac file ( ) and select Activate to make the business option
available in the BAC.
6. Open your BC view for testing in the cloud solution by doing the following:
a. Log on to the cloud solution as a business user.
b. In the cloud solution, in the Business Configuration work center, open the Implementation Projects
view.
c. Select a project and click Edit Project Scope .
The Edit Project Scope guided activity is displayed.
d. Follow the guided activity and answer the scoping question for your business option with Yes.
The business topic or business option you created is displayed in the Scoping phase under Scoping
Element. The description and scoping questions you defined are displayed in the Questions phase.
When you finish the guided activity, the activity you assigned to your business option is added to the
activity list.
e. In the Implementation Projects view, select the implementation project and click Open Activity List .
The Activity List guided activity opens and displays the Prepare phase. Activity List displays all activities
that are mandatory for go-live. You must add any activities that are optional manually. For information
about adding optional activities, see the activity list documentation in the cloud solution.
f. In the Activity List, click Hide Phased List and search for your activity by the activity description you
defined in the studio.
g. Select your activity and click Open .
Your BC view opens and you can test the result.

If you have assigned more than one BC view to the same business option, a fact sheet with the
links to all of the views is displayed when you click the activity.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 339
Result
You have created a business configuration view and opened it in the cloud solution. You can now test the result.

See Also
Business Configuration Quick Guide [page 314]

8.2.3.8 Create a Fine-Tuning Project Template

Overview
You can create a fine-tuning project template in the studio as part of a solution. Fine-tuning project templates provide
sample content for a specific scenario that is defined by SAP, such as Financials Chart of Account. The fine-tuning
activities you need to complete for the template are explicitly listed.

Prerequisites
You have created and opened a solution in the studio. For more information, see Create a Solution [page 165].

Procedure
1. In the Solution Explorer, right-click your solution and click Add New Item .
The Add New Item dialog opens.
2. Select SAP Business Configuration Implementation Project Template .
3. Enter a name and click Add.
The Create Implementation Project Template dialog opens.
4. In the Create Implementation Project Template dialog, do the following:
a. Enter a name and a description.
b. From the Activity Group list, select the scenario for which you want to create a template, for example,
Financials Chart of Account.
Information about the required scope of the template and the fine-tuning activities you need to
complete is displayed under the name of the activity group (currently: for Financials Chart of
Account).
c. Click OK to save the template.
A new item with the file extension .bct ( ) appears in the Solution Explorer under your solution.
5. Right-click the .bct file and select Activate.
The status of the template changes to Active.
6. Right-click the .bct file and select Open.
The template opens in a document window.
7. Under Scoping and Fine-Tuning, click Edit Project Scope.
The logon screen of the SAP cloud solution opens in your browser. Do the following:
8. Enter the user name and password that you entered when logging on to the repository.

SAP Cloud Applications Studio – Version May 2018 (1805)

340 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 The Edit Project Scope guided activity is displayed. Do the following:
a. In the Country and Type of Business step, click Edit Countries to add or remove countries and click Edit
Type of Business to select the type of business.
b. In the Implementation Focus step, select Complete Solution and click Next.
c. In the Scoping step, define the required scope of your template based on the information displayed
under Activity Group and click Next.

If you have created a fine-tuning project template for the Financials Chart of Account activity
group, select Financial Management and Accounting General Ledger .

d. In the Questions step, answer the relevant scoping questions based on the information displayed under
Activity Group and click Next.

Select Financial and Management Accounting General Ledger General Ledger and
under Income Statement by Function of Expense, select the In Scope checkbox. Confirm the
Review Status popup by clicking Yes.

e. In the Review step, review your scope changes and click Finish.
f. In the Confirmation step, click Close.
9. In the studio, refresh the template by clicking Refresh in the document window and then click Confirm
Milestone: Design Accepted.
In the cloud solution, the Confirm Milestone: Design Accepted view opens.
10. Select Design Accepted and click Confirm to confirm that you have finished defining the scope of your
template. Confirm the Design Accepted popup by clicking Yes.

You cannot move on to the next phases until you have confirmed this milestone. The confirmation
process can take up to 30 minutes.

11. In the studio, refresh the template by clicking Refresh in the document window .
The links to the individual activities that you need to complete are activated.
12. Complete the activity list by clicking the links to open each activity in the fine-tune phase of the implementation
project.

Result
You have created a fine-tuning project template in the studio and predefined the fine-tuning activities for a specific
scenario. You can now complete your implementation project template. For more information, see Business
Configuration Quick Guide [page 314].

See Also
Complete the Activity List [page 344]

8.2.3.9 Create a Tax Decision Tree

You can create a tax decision tree in the studio to automatically determine a tax event for a country that does not
have an SAP country version in SAP Business ByDesign.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 341
Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Prerequisite
You have created and activated the tax content of the country for which you want to create the tax decision tree. For
more information, see Create Tax Content for Non-Localized Countries in the SAP Cloud Applications Studio .

Procedure
1. In the Solution Explorer, do the following:
a. Select the Withholding Tax checkbox if you want to create the decision tree for withholding tax
determination.
b. Click Add New Item. The Add New Item dialog opens.
c. Select Tax Decision Tree and click Add. The Tax Decision Tree Wizard opens.
2. In the Create Decision Tree step, do the following:
a. Add a Name (2 characters only) and a Description.
b. Select a country from the dropdown list and specify a date from which the decision tree is valid.
c. Click Next to go to the next step.
3. In the Define the Decision Tree Structure step, do the following:
a. Click Add Question. The system creates a root node where you can add your first question.
b. Double-click the root node to define the question type. The Question Form dialog opens where you can
choose from three different parameters: Question, Result, and Error.
c. If you select Question and click OK, the system gives you an option to enter a Question, select a Test
Parameter, Comparison Parameters, and Comparison Value.
d. Specify the question and select the required test parameter, comparison parameters, and comparison
value.

SAP Cloud Applications Studio – Version May 2018 (1805)

342 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 The system provides you with a list of parameters that will help you create your decision tree:
VAT Decision Tree test parameter set

Test Parameter Context Parameters Comparison Value

Direction Indicator No contexts 1 – Sale, 2 – Purchase

Product Taxability No contexts 1– Good/Material, 3 – Asset Individual

Material, 2 – Service, 6 – Entitlement, 4–
Warranty

Country Partner Role, values – SF Country code (Automatically

(Ship From), ST (Ship To), determined)
CF (Contract From), CT
(Contract To)

ServicePointTaxableIndicator Tax Type, Taxable Country, X (true)

Taxable Region

Tax Exemption Reason Code Tax Type, Taxable Country, Tax exemption reason code value
Taxable Region

Business Partner Taxability Partner role (similar to 100 – Company

Country test parameter)

Withholding Tax Decision Tree test parameter set

Test Parameter Context Parameters Comparison Value

ProductTaxTypeIndicator Taxable Country, Tax Type, X (true)

Taxable Region

PartnerTaxGroup Taxable Country, Partner Role Withholding Tax Rate Type value for
[values -SF (Ship From), ST (Ship the corresponding tax type selected
To), CF (Contract From), CT in the context parameter
(Contract To)], Tax Type, Taxable
Region

IncomeType Taxable Country, Tax Type Income type value for the
corresponding tax type selected in
the context parameter

e. Click OK.
The system adds the question to the tree.
f. Click Add Question again. The system creates two nodes: True and False. Double-click True to add a
question as above. Similarly add a question to False. Continue the steps till you reach a result or an
error and click OK to finalize your decision tree.
g. Click Next to go to the Review step.
4. In the Review step, check that the information you have entered is correct and then click Finish.
A new item with the file extension .bccxtax ( ) appears in the Solution Explorer under the project node.
5. In the Solution Explorer, right-click the .bccxtax file and select Activate.
6. In the Solution Explorer, right-click your solution and select Deploy Business Configuration to be able to use
your decision tree in a solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 343
 The system deploys the decision tree content you have created and makes the decision values available in
the Business ByDesign system.

Result
You have created a tax decision tree, which you can use to determine the tax event when you process an invoicing
document in the SAP Business ByDesign system.

8.2.3.10 Complete the Activity List

Overview
You can match business requirements to the capabilities of your solution by completing an activity list of the
implementation and project management activities that customers need to perform before the solution can go live.
You do this in the Prepare phase, the Fine-Tune phase, and the Integrate and Extend phase of an implementation
project.
The system generates the activity list based on the scope defined for the implementation project template. The
activity list is divided into separate phases and includes all mandatory implementation and project management
activities that customers need to complete before the solution can go live. You can add optional activities to the
activity list and complete them; most optional activities relate to the Fine-Tune phase but may also relate to other
phases. In the Prepare phase and the Fine-Tune phase, you must confirm milestones that allow you to track the
status of your implementation project template.

Prerequisites
You have created and activated a fine-tuning project template in the studio and you have defined the scope of this
template in the SAP cloud solution. For more information, see Create a Fine-Tuning Template [page 340].

Procedure
1. Open the activity list to complete it for your implementation project template by doing the following:
a. In the studio, in the Solution Explorer, right-click the .bct file and select Open Project Overview.
The logon screen of the SAP cloud solution opens in your browser.
b. Enter the user name and password that you entered when logging on to the repository.
The Project Overview view opens.
c. Check that the description is correct and that the name in the Title field is the name of your
implementation project template with your project namespace as the prefix.
d. Click Open Activity List .
The Activity List guided activity opens and displays the Prepare phase.

To ensure that an implementation project template and its solution remain consistent, always open
an implementation project template in the Project Overview view by using the Open Project
Overview function in the studio.

2. In the Prepare phase, do the following:

a. In the Show filter, select My Activities in Project to find all activities that are assigned to you.

SAP Cloud Applications Studio – Version May 2018 (1805)

344 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 b. Complete the activities by doing the following:
a. To display which activities have to be completed first, in the Prerequisites Exist column, click
Yes.
A dialog box opens and lists the prerequisite activities.
b. Select the first activity and click Open .
c. Read the instructions for the activity and complete the activity as described.
d. Save your changes and close the activity.
e. Repeat the above steps for each activity.

Some activities contain data that cannot be copied to another system; therefore, they need to
be repeated in other systems. You can identify these activities in the Repetition Required column.
If you complete an activity in the development environment that requires repetition, the
customer must repeat this activity in the production system. Therefore, we recommend that
you provide documentation for these activities in your Solution Documentation. For more
information, see Documentation Types in the SAP Solution
(ESS_CON_PDI_MainDocTypes.xml). and Templates Quick Guide
(TemplatesQuickGuide.xml)..

c. On the Activity List screen, change the status of each completed activity to Closed. To do this, select
each activity, click Change Status , and then select Closed.

The Activity List screen indicates whether an activity is open, in process, or closed.
At the top of the screen, you can view the overall progress for each phase of your implementation
project template. At the bottom of the screen, you can view the total number of activities in the
activity list for the selected phase and the numbers of open, in process, and closed activities.

d. Confirm the Confirm Milestone: Design Accepted milestone.

3. In the Fine-Tune phase, do the following:
a. Complete the activities as described for the Prepare phase.

● Additional Information
Some activities in this phase have additional information to assist customers in
completing them. You can access the additional information either directly in the Help
Center of the relevant activity under Help Resources by clicking Help Center in the
Infobar.
● Mandatory and Optional Activities
By default, the activity list contains only mandatory activities. In the Fine-Tune phase and
the Integrate and Extend phase, you can add optional activities to the activity list.
● Translate Configuration Settings
You can only provide your configuration settings in fine-tuning activities in one language.
● Restore Default Fine-Tuning Settings
To avoid causing inconsistencies, you cannot delete standard fine-tuning settings.

b. Confirm the Confirm Milestone: Solution Accepted milestones.

4. In the Integrate and Extend phase, complete the activities as described for the Prepare phase and enter basic
data.

The activities you need to complete in the Integrate and Extend phase depend on the scope of your
implementation project template.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 345
Result
You have completed the activity list. You can now complete your fine-tuning project template in the studio. For more
information, see Business Configuration Quick Guide [page 314].

8.3 Business Objects

8.3.1 Business Objects Quick Guide

In the studio, you can create your own business object and define its nodes and relevant elements in the business
object definition. After you have defined your business object, you can generate the screens for your business object.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Business and Technical Background

Scripting Language
The scripting language is used to define business objects and business object extensions as well as to implement
the business logic for cloud partner solutions. This lightweight language is easy to learn and to use with its focused
set of features.
For more information, see here [page 173].

Syntax for Business Object Definition

You use specific keywords and functions to describe the structure and interface of a business object in the studio.
For more information, see here [page 174].

Screens
In the Create Screens dialog, you select the screens you want to use for your solution.
For more information see Screen Types [page 353].

Object-Based Navigation and Thing-Based Navigation

In the studio, you can choose between two different screen scenarios.
For more information, see Object-Based Navigation and Thing-Based Navigation [page 357].

SAP Cloud Applications Studio – Version May 2018 (1805)

346 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Queries
A query is a service operation that can be used for search and information retrieval operations. It is defined at a
business object node and has selection parameters. The result structure is defined by the business object node the
query is specified for; however, it may also include elements from different business object nodes.
For more information, see here [page 351].

Actions, Events and Validations

In the studio, script files are used to implement the business logic for actions, events or validations of business object
nodes.
For more information, see here [page 349].

Syntax for Implementation of Business Logic

Methods and keywords enable you to implement the business logic for your solution in your script files in the studio.
For more information, see here [page 210].

Reuse Libraries and Built-In Functions

The built-in functions and reuse libraries of the scripting language extend the scope and functions that you use to
implement the business logic of your solutions.
For more information, see the following documentation:
● Built-In Functions [page 276]
● Basic Reuse Libraries [page 238]
● Reuse Libraries for Business Areas [page 268]

Introduction to Business Object Modeling

The SAP cloud solutions are built using the concept of business objects to model the business environment. For
more information, see here [page 78].
For an example on how to build a solution, see Example: Building a Solution [page 93].

Public Solution Model

In the studio, you can explore SAP content and PSM documentation using the Repository Explorer tool window. For
information, see Repository Explorer [page 50].

Tasks

Create a Business Object

1. In the My Solutions tool window, open your solution.
2. In the Solution Explorer, right-click the project in your solution and select Add New Item .
3. In the Add New Item dialog box, select the Business Object template, enter a name for your business object,
and click Add.

If you use a template to create a new project item, do not change or delete the extension of the item
name. For example, do not delete the .bo file extension of the business object file.

A new item with the file extension .bo appears in the Solution Explorer.
A document window opens that displays your business object file in a code editor.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 347
Enter a Business Object Definition
In the code editor of the studio, you define your business object by describing the namespace and by adding business
object elements. To describe the structure and interface of the business object, you use specific keywords and
functions.
For more information on the syntax of business objects, see Syntax for Business Object Definitions [page 174].
For more information about entering a business object definition, see Enter a Business Object Definition
[page 360].

Add a Label and Tooltip to a Business Object

You can define a label and a tooltip for a business object field and display them on a screen.
For more information, see here [page 361].

Activate a Business Object

Once you have entered the business object definition in the code editor and saved it, you need to activate the business
object. This ensures that the runtime objects are generated that are required for the business object to function.
For more information about activating a business object, see Activate a Business Object [page 362].

Define the Business Logic for a Business Object

To define the business logic for your business object in the studio, you use event, action and validation script files.
For more information, see here [page 369].

Generate Screens for a Business Object

In the studio, you can generate screens in the SAP cloud solution based on your business object definitions, for
example, work centers, floorplans, and fact sheets.
For more information, see here [page 370].

Create a Query
In the studio, you can define queries that allow you to access and combine the fields defined in different nodes or
business objects in a single query and to combine data from different business object nodes. You can also use a
query to make a custom business object available in the enterprise search.
For more information about creating a query, see here [page 363].

Define Access Control

In the studio, you can implement instance-based access control for a business object you created by referencing an
SAP business object for which an access context is defined.
For more information about defining access control, see here [page 365].

Assign Access Rights

If you have implemented instance-based access control for a business object you created in the studio, you can
restrict read and write access in the SAP cloud solution on the basis of a work center view's access context.
For more information about assigning access rights, see here [page 368].

SAP Cloud Applications Studio – Version May 2018 (1805)

348 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Create an OWL Excel Export
Object Work Lists (OWL) generated for custom business objects allow you to export the OWL data to a Microsoft
Excel file. The file is based on a standard template, which you cannot change. However, you can format the generated
spreadsheet as required.
For more information, see here [page 372].

Enable Change History

You can use an embedded component to ensure that a change history is written for all changes made to your custom
business object. After adding the embedded component to your business object, you can display the change history
in the SAP cloud solution on the Changes tab of your work center. All changes such as add, create, and delete are
displayed in a list.
For more information, see here [page 375].

See Also
Maintenance of Business Objects [page 358]

8.3.2 Business and Technical Background

8.3.2.1 Actions, Events, and Validations

In the studio, script files are used to implement the business logic for actions, events or validations of business object
nodes.
Depending on whether you are implementing the business logic for business objects or the business logic for
business object extensions, you can create the following script files:

Business Object Business Object Extension

Action —

AfterModify event AfterModify event

BeforeSave event BeforeSave event

AfterLoading event AfterLoading event

OnSave validation OnSave validation

— Action validation

Features
Actions
An action is an element of a business object node hat describes an operation performed on that node, for example,
setting a status. The action operates on a set of node elements or instances that have been created or changed.
Action script files are provided if you have added actions to your business object definition.
Event

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 349
An event is used to compute data that can be derived from other node elements, for example, totals of items and
statuses, or from dependent objects, for example, AttachmentFolder or TextCollection.
The system executes an event implemented for custom business objects in ascending order from bottom to top,
that is, from subnode to root node. In case of events implemented for extended business it is the reverse: the system
executes an event in descending order from top to bottom, that is, from root node to subnode.
The following events are provided by the system:
● AfterModify
This event determines the data of a node when the data has been changed. This is especially useful for derived
data that needs to be updated immediately.
● BeforeSave
This event determines the current data of a node.

Please note that if a BeforeSave script file has modified a business object node, the system doesn't
execute the code of an AfterModify script file for this same node anymore.

● AfterLoading
You can implement this event to modify transient fields (only available for business objects) of the current
node of a business object. The system executes the AfterLoading event when it reads a node instance of
a business object from the data base.
You cannot use an AfterLoading event to do the following:
○ Read and modify a transient field of another node
○ Modify a persistent field
○ Create or delete a node
○ Call an action

The system doesn't execute an AfterLoading event for a node instance that is being initially created.
To calculate a transient field at this point in time, you can implement an AfterModify event.

Validations
A validation is used to check if particular conditions are fulfilled, such as the conditions for saving a business object
node. Validations can only read data and cannot change any values. The result of a validation must always evaluate
to a Boolean value, that is, to true or false. The system executes validations in no particular order. It executes all
of the validations, that is, even if a validation already returned false, the remaining validations are executed.
You can create the following validation script files:
● OnSave validation
You can use the OnSave validation to check whether a business object can be saved.

Please note that the system always executes the OnSave validation after having executed the
BeforeSave event.

A validation that checks whether the string “0243” is contained in the elemData field:
if (this.elemData.Contains("0243")) {
return(true);
}
else {
return(false);
}

For another example, see Example: Validate on Save [page 133].

SAP Cloud Applications Studio – Version May 2018 (1805)

350 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 ● Action validation (available for business object extensions only)
You can use an action validation to check whether an action of an SAP business object can be executed. As
a prerequisite, the action must be released in the public solution model (PSM). The system executes the
validation before it calls the corresponding action. The return value determines whether the action is executed
or not. If the action contains parameters, you can use them in the script file of the validation. You can raise
messages defined in the business object extension if the action cannot be executed.

You can create action validation script files only in solutions or solution templates that have been
created with the 1302/1211 compiler version or higher. You can find the compiler version in the
Properties window of your solution.

Mass Enablement
You can specify whether a script file is to be executed for multiple instances of business object nodes, which is
referred to as mass enabling.
If you work with mass-enabled script files, consider the following:
● To mass enable a script file, you select the Mass Enable checkbox in the Create Script Files dialog box. For
more information, see Define the Business Logic for a Business Object [page 369].
● If you want to modify a mass-enabled script file so that it can only be executed for single instances of business
object nodes, you need to delete the script file first and then re-create it.

Maintenance Mode
You can delete a script file when your solution is in maintenance mode. For more information, see Maintenance Mode
[page 170].

If you use the this keyword in the coding of a mass-enabled script file, this represents a collection of business
object node references.

Performance Checks
This feature provides you with suggestions on how to avoid dumps and improve performance of ABSL scripts,
business objects, business object extensions, mass data runs, and the solution itself. Right-click on
any .absl, .bo, .xbo, and .run file in the solution and click Run Performance Checks.
When you run a check on scripts, business objects, business object extensions, and mass data runs, the system
displays the list of tips that will enhance your system performance, and allows you to directly work on the script
without moving away from the screen. When you run a check on the solution, due to the large volume of objects
involved, the system runs a background job and sends you an e-mail with the list of tips and the particular lines where
you can implement the improvements.

8.3.2.2 Queries

Overview
A query is a service operation that can be used for search and information retrieval operations. It is defined at a
business object node and has selection parameters. The result structure is defined by the business object node the
query is specified for; however, it may also include elements from different business object nodes.
You can use queries to display business object data directly in an object worklist (OWL) using the user interface
designer (UI Designer) or to access the data using the scripting language. For more information about the usage in
UI designer, see Model an Object Work List [page 607] and Configure a Query [page 639].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 351
Query Types

Default Query
By default, each business object node of a custom business object has a query called QueryByElements. The query
contains all elements of the node as selection parameters and the query result contains instances of this node. In
general, the QueryByElements query has a linear dependency on the number of instances in the business object
node (t = O(n), where n is the number of business object instances in the database).
The QueryByElements query is a simple query and does not provide full-text indexing. We therefore recommend
that you use the default query when:
● The expected number of node instances or collections is small, for example, for an object with configuration
data, or when the execution frequency is low.
● The selection parameter list contains an equal condition on an element that is the alternative key of the node.
An alternative key is supported by an index so the runtime dependency is t = O(log n).

If you define an association in your business object as relevant for access control by using the
RelevantForAccessControl annotation and you use the default QueryByElements query, error
messages related to role-based access management (RBAM) might occur if you use the query to control
access. These RBAM error messages are suppressed when you create a complex query in your solution.

Complex Query
A complex query is a custom query that allows you to access and combine data from different business object nodes
or business objects in a single query. Complex queries support full-text indexing for all query elements (t = O(log n).
We therefore recommend that you define a complex query when a large number of records is expected in the node.
In the studio, you can create queries using the Query Wizard. For information, see Create a Query [page 363]. When
you define a query, you must specify which business object fields to include in the query. You can also specify which
elements you want to:
● Include as search parameters
● Use in text search
● Display in the query result

If an [1,n] association is defined for an element, you cannot use the field in the query result. We therefore recommend
that you select the most detailed node as the parent node. For more information about associations in business
object definitions, see Association [page 180].

If you want to implement instance-based access control for the results displayed in an object worklist
(OWL), you must create a complex query. You cannot create a default query for this scenario. For
information about defining access control, see Define Access Control [page 365].

Predefined Query of SAP Business Objects

Most of the business objects provided by SAP have predefined queries which you can use in the same way as a default
query or a custom query. However, you cannot use sorting and paging options for a predefined query.

Executing Queries
● Execute Function in Script Files

SAP Cloud Applications Studio – Version May 2018 (1805)

352 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 In script files, you typically use the Execute function which allows to pass selection parameters to the query
and returns a collection of node instances that match the selection. A query reads the data of a node directly
from the database which means that unsaved data that has been created or modified in the current session
or a session running in parallel is not taken into account.
If a query returns a collection of nodes, the collection is not sorted by default. However, if you have defined a
query on a custom business object, you can specify that the result is to be sorted by specified elements.
Another option is to use the Sort Collection functions (see Sort Collection [page 236]). Please note that
sorting a collection in memory is slower than sorting performed by a query that is executed on the database.
If you need to process only a small part of the result and the number of nodes matching the selection criteria
is quite high, you can optimize the amount of data that needs to be read from the database by using a sort
option. For example, if you want to find the last document saved by a particular user and the search criterion
is “Changed by the current user”, you can use the sort option “Descending by last changed date time” and
specify the maximum number of rows to be returned, for example “1”.
Obtaining business object nodes by using the Execute function gives you the most flexibility if you want to
further process the query result. You can then read or modify the data of the result, execute actions or retrieve
further data using associations. However, since the returned nodes reside in the buffer of the runtime, they
need to be considered whenever the runtime checks the buffer for modification. Thus, if you expect a large
result set and your solution does not need to modify the returned business object nodes, we recommend to
query for business object node data only. This can be achieve by using the ExecuteDataOnly function. This
function offers the same parameters as the Execute function but the query result is just a collection of node
data instead of node instances. Therefore, you cannot modify the data returned and you cannot directly
execute actions or use associations. However, the buffer of business objects nodes remains unchanged which
increases performance and avoids overriding instance that are already in the buffer.
If you do not even need to access the node data but are just interested in the number of entries that exist on
the database, you can use the Count function of the query. Count does not retrieve any data from the database
which means it is faster than performing the Count function on the collection that has been returned by the
Execute function or the ExecuteDataOnly function.
● Execute a Query to Explore a Business Object
The studio enables you to execute queries for SAP business objects and custom business objects to help you
better understand the business object data model. For SAP business objects, you access this function in the
Repository Explorer, for custom business objects, you call up this function in the Solution Explorer.
For more information, see Execute a Query to Explore a Business Object [page 53].

8.3.2.3 Screen Types

The studio enables you to create screens for your business object. In the Create Screens dialog, you are prompted
to select the screen types you want to use. For information on how to create screens, see Generate Screens for a
Business Object [page 370].
You can select the following screen types:

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 353
Screen
Type Description Example

Object A floorplan that allows

Instance business users to
Floorplan create, view, and edit a
(OIF) business object.
Typically, the OIF
shows multiple tab
pages.
You can use this
floorplan to model an
application interface
that allows the user to
create, delete, display, Object Instance Floorplan
and change the
attributes and
associations of
business objects.

Quick A floorplan that allows

Activity business users to
Floorplan perform a specific task
(QAF) quickly. This can be
self-contained or a
short subtask within
the context of a larger
task (for example, a
simple Create
operation).

Quick Activity Floorplan

SAP Cloud Applications Studio – Version May 2018 (1805)

354 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Screen
Type Description Example

Fact Sheet A sheet that displays

(FS) the most important
properties of a
business object on one
page.

Fact Sheet

Object A list pane that is

Work List always embedded in a
(OWL) work center view. The
OWL contains business
objects such as
purchase orders or
opportunities.
Business users can, for
example, search for,
display, and edit
business objects as
well as trigger follow-on Object Work List
processes.

Object A user interface pattern

Value that supports business
Selector users when they select
(OVS) values for an input field.
An OVS helps business
users to select one item
from a table of business
object instances.
If you choose Object
Value Selector (OVS), a
separate dialog box Object Value Selector
appears in which you
can select the business
object elements for the
OVS.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 355
Screen
Type Description Example

Work Part of a work center,

Center for example, the
View Overview or Reports
(WOCVIE view.
W)

Work Center View

Quick A slide-in window,

View (QV), which allows users to
not edit data without
available navigating away from
for SAP the UI currently
Business displayed.
ByDesign

Quick View

Quick A preview of detailed

Create information on a thing
(QC), that a user can see
not without navigating
available away from the UI
for SAP currently displayed.
Business Data shown in a QC
ByDesign cannot be edited.

Quick Create

Thing The TI shows all

Inspector aspects of a thing and is
(TI), a compact summary of
not all primary attributes,
available the tags, and the
for SAP actions that can be
Business carried out.
ByDesign

Thing Inspector

SAP Cloud Applications Studio – Version May 2018 (1805)

356 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Screen
Type Description Example

Thing A TT describes the

Type (TT), general UI properties of
not a thing. It is used for
available navigating between the
for SAP screens that are thing-
Business based and for the
ByDesign provisioning of REST
services for a thing.

8.3.2.4 Object-Based Navigation and Thing-Based Navigation

Overview
When you create the screens for your business object in the studio, you are asked to select the screen navigation
you want to use. The following sections describe the two types of navigation that are available (object-based and
thing-based navigation) and help you decide when to use what.

Object-Based Navigation
This is the navigation pattern used in SAP Business ByDesign.
When you use object-based navigation, you enter the application via work center and work center view to get to the
object work list. Then you leave the object work list to work on quick activity or object instance floorplan screens.
The following graphic shows the various screens that you can create for object-based navigation:

Screens Using Object-Based Navigation: (1) Work Center, (2) Work Center View, (3) Object Work List, (4) Quick Activity, (5) Object
Instance, (6) Object-Based Navigation

Thing-Based Navigation
This is the navigation pattern used in the other solutions. The fundamental integral part of thing-based navigation is
a thing.
What Is a Thing?

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 357
A thing is an object a user works with, such as product or business partner. It contains content that has been collected
from various applications, actions, and business objects. A thing is supposed to ensure easy consumption of that
content and a consistent user experience. It is assigned to a thing type.

For the thing ABC Corporation, the thing type would be Business Partners.

When you use thing-based navigation, you also navigate via a work center and a work center to an object worklist as
in object based navigation. However, in thing-based navigation, you can call up quick view and quick create screens
without leaving the object work list or go to a thing inspector screen.
The following graphic shows the various screens that are part of thing-based navigation:

Screens Using Thing-Based Navigation: (1) Work Center, (2) Work Center View, (3) Object Work List, (4) Quick Create (QC), (5)
Quick View, (6) Thing Inspector, (7) Thing Type, ES = Enterprise Search; FD = Feeder

When Do I Use What?

Generally speaking, you select the navigation pattern that is suited best for your solution. However, there are a few
restrictions that are listed in the following table:

Object-Based Navigation Thing-Based Navigation

Can Be Used for SAP Business ByDesign Yes No

Can Be Used for Other Cloud Solutions Yes Yes

Need to Define Outports in UI Designer Yes No

See Also
Generate Screens for a Business Object [page 370]
Screen Types [page 353]

8.3.2.5 Maintenance of Business Objects

Overview
A customer-specific solution is in maintenance mode, if it has been assembled and downloaded; the solution status
then is Assembled. You can make changes to the solution in a patch; however, you can only make restricted changes
to certain content types. These change and delete restrictions ensure that you do not make changes to a solution
that could lead to loss of data or create inconsistencies or errors on a customer's production tenant.

SAP Cloud Applications Studio – Version May 2018 (1805)

358 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Change and Delete Restrictions

The following table gives an overview of the change and delete restrictions for business objects in a solution that is
in maintenance mode. The system performs the change and delete restrictions checks when you save the business
object.

Adding Deletion Renaming

Allowed Allowed Allowed Comments

Business object Yes No No

Business object node Yes No No

Business object node element Yes No No

Business object action Yes Yes Yes

Business object node association Yes No Yes

The following changes are not
allowed:
● Removing the using clause

association ToBonusPlan
to BonusPlan using ID —>
association ToBonusPlan
to BonusPlan
● Changing the target of an
existing using clause

association ToBonusPlan
to BonusPlan using ID —>
association ToBonusPlan
to BonusPlan using ID2

Data type of element No No No

AlternativeKey annotation No Yes No

on existing element

AlternativeKey annotation Yes No No

on new element

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 359
 Adding Deletion Renaming
Allowed Allowed Allowed Comments

Multiplicity of node see see see The following changes are allowed:
comments comments comments [0,1] —> [0,n]
[1,1] —> any
[1,n] —> [0,n]
The following changes are not allowed:
[0,1] —> [1,1] or [1,n]
[0,n] —> any
[1,n] —> [0,1] or [1,1]

Multiplicity of association see see see The following change is allowed:

comments comments comments [1,1] —> [0,1]
The following change is not allowed:
[0,1] —> [1,1]

Association valuation see see see Adding or removing the Valuation

comments comments comments keyword is not allowed.

Multiplicity of association see see see Only the following multiplicity is allowed:
valuation comments comments comments [0,n]

Association valuation condition Yes Yes not Changing the conditions within a valuation
applicable expression is allowed.

Messages Yes Yes Yes

Business object query Yes Yes Yes

Assignment of deployment unit Yes Yes Yes

● If associations to business
objects in the deployment
unit are defined, changes to
the assignment cause an
error due to a cross-
deployment unit
association.
● If an integration scenario
has been defined, this has to
be adapted.

8.3.3 Tasks

8.3.3.1 Enter a Business Object Definition

In the code editor of the studio, you define your business object by describing the namespace and by adding business
object elements. To describe the structure and interface of the business object, you use specific keywords and
functions.
For more information on the syntax of business objects, see Syntax for Business Object Definitions [page 174].

SAP Cloud Applications Studio – Version May 2018 (1805)

360 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Prerequisites
You have opened your solution.

Procedure
1. Select the document window of your business object.
In the code editor, the following information is displayed:
● The import statement for the AP.Common.GDT SAP namespace that contains the standard data
types:
import AP.Common.GDT as apCommonGDT
You can import further namespaces so that you can use SAP business objects and data types when
you define elements and associations.
● The businessobject keyword and the name of your business object, for example, BonusRule.

The names of the .bo file and of the business object must be identical. Do not change the name
of the business object in the coding.

2. Define the nodes of your business object and their features, such as elements, actions, and associations with
other nodes.
In the following simple business object definition, the ID element is specified for the root node of the
BonusRule business object:
import AP.Commmon.GDT as apCommonGDT;
businessobject BonusRule {
element ItemID : ID;
}
For more information about the keywords that you can use, see Syntax for Business Object Definitions
[page 174].
3. In the File menu, click Save.

Result
You have defined your business object and can now activate it. For more information, see Activate a Business Object
[page 362].

8.3.3.2 Add a Label and Tooltip to a Business Object

Overview
You can define a label and a tooltip for a business object field. If you then add the business object field to a screen:
● the label is displayed on the screen instead of the field name
● the tooltip is displayed when you place the cursor on the field

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 361
Procedure
1. Create a business object element with a label and a tooltip using the following syntax:
[Label ("<label name>")] [Tooltip ("<tooltip name>")] element <element name> :
<data type>;
For more information, see Business Objects Quick Guide [page 346].
2. Generate screens for the business object. For more information, see here [page 370].

Result
In the Solution Explorer in the studio, right-click your screen and select Preview Screen. You are prompted to log on
to the cloud solution.

The label is displayed for the business object field. The tooltip is displayed when you place the cursor on the field.

See Also
Label (Business Object) [page 189]
Tooltip (Business Object) [page 193]

8.3.3.3 Activate a Business Object

Once you have entered the business object definition in the code editor and saved it, you need to activate the business
object. This ensures that the runtime objects are generated that are required for the business object to function.

Prerequisites
You have defined your business object in the code editor. For more information, see Enter a Business Object
Definition [page 360].

Procedure
In the Solution Explorer, right-click your business object and select Activate.
The content of your business object is activated.

SAP Cloud Applications Studio – Version May 2018 (1805)

362 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 How you can solve business object activation errors
If an error message appears that tells you that the business object cannot be activated, have a look at the
following table. It shows possible errors and how you can solve them:

What the error may be caused

by How to solve the error

The database table that is ● Delete some of the elements.

generated from the node ● Use smaller data types.
definition is too large.
● Split up the node(s).

There has been an incompatible ● Change the element definition back.

change in the definition of an ● Clean the business object.
element.
Please be aware that data may get lost.

8.3.3.4 Create a Query

In the studio, you can define queries that allow you to access and combine the fields defined in different nodes or
business objects in a single query and to combine data from different business object nodes. You can also use a
query to make a custom business object available in the enterprise search.
You can use these queries to include the query data in an object worklist (OWL) and to access information from
different nodes and business objects using the scripting language. You must create a query to implement instance-
based access control for the results displayed in the OWL.

If you define an association in your business object as relevant for access control by using the
RelevantForAccessControl annotation and you use the default QueryByElements query, error
messages related to role-based access management (RBAM) might occur if you use the query to control
access. These RBAM error messages are suppressed when you create a complex (custom) query in your
solution.

Prerequisites
● You have created and opened a solution in the studio. For more information, see Create a Customer-Specific
Solution [page 165].
● You have created and activated at least one custom business object in your solution. For information, see
Business Objects Quick Guide [page 346].
● To make a custom business object available in Enterprise Search:
○ The custom business object must contain a description field and a date field.
○ Create a screen scenario.

For more information, see Generate Screens for a Business Object [page 370].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 363
Procedure
1. In the Solution Explorer, right-click your business object and select Create Query.
The Query Wizard opens.
2. In the Create a Query step, under Basic Information, define your query by doing the following:
a. Select a business object, if your solution has more than one business object.
b. Select a parent node to link to the query, if your business object has more than one node.

The parent node is the starting point for the field selection in the Select Query Fields step. If
a [1,n] association is defined for a field, you cannot use the field in the query result. Therefore,
we recommend that you select the most detailed node as the parent node. For more
information about associations, see Syntax of Business Object Definitions [page 174].

c. Enter a query node name.

d. Optional: Enter a description.

By default, the query name is QueryByElements.

3. Optional: If you want to make your business object available in search queries, select Include in Enterprise
Search; then do the following:
a. Under Enterprise Search Details, define the following fields:
● Key Field
The field of the business object to be used in search queries to sort or filter search results by ID.
You can either use the implicit alternative key field SAP_UIID or use an alternative key field created
for the custom business object.
● Description Field
The field of the business object to be used in search queries to filter search results by description.
The text fields of the anchor node of the query or the subnodes of the anchor node of the query
can be used.
● Last Changed Field
The field of the business object to be used in search queries to sort or filter search results by last
change date. The Date/Date Time fields of the custom business object can be used.
b. Under UI Navigation, define the screen you want to open when an end user selects this business object
in the search results:

SAP Business ByDesign Other SAP Cloud Solutions

In the Navigation Target UI field, select the quick In the Thing Type field, select the thing type floorplan
activity floorplan (.QA.uicomponent) of your (_TT) of your solution.
solution. Additionally, you can also select Enable Feed, if you
When you select the Operation, the Inport field is filled want to reference the business object in the Feed view.
automatically.

c. Click Next.
4. Optional: If you want to enable read access logging for sensitive personal data, select Log Sensitive Personal
Data.
5. In the Select Query Fields step, select the fields you want to include in the query.
6. In the Define Query Parameters step, refine the properties of each query parameter.
a. Optional: Change the parameter field name.
b. Optional: Select the Selection checkbox if you want to include the parameter as a search parameter.

SAP Cloud Applications Studio – Version May 2018 (1805)

364 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 c. Optional: Select the Basic Find checkbox if you want the parameter to be used in a text search.
d. Optional: Select the Result checkbox if you want the parameter to be displayed in the query result.

You cannot use fields with [1,n] associations in a query result.

e. Click Next.
7. In the Review step, check that the information you have entered is correct and then click Finish.
A new item with the file extension .qry appears in the Solution Explorer.
8. In the Solution Explorer, right-click the business object and select Activate.

Result

You have created a custom query in your solution. In the Solution Explorer, a [query name].qry file ( ) is
displayed. You can now use the scripting language to:
● Access your query
● Set the query parameters in order to be able to return a list of business object instances based on these
parameters
● Execute the query
For more information, see Execute a Query to Explore a Business Object [page 53].

For more information, see Scripting Language [page 173].

You can create an object work list (OWL) and use the UI designer to design the screen to use the business object
query data. For more information, see Model an Object Work List [page 607] and Configure a Query
[page 639].
If you want to use the query to make a custom business object available in the enterprise search, do the following:
In the UI designer, assign the custom business object as an enterprise search object to the work center view. For
more information, see Model a Work Center View [page 612] under “Define the enterprise search objects”.
The custom business object is available in the enterprise search, once the target UI has been assigned to a user. For
information about assigning access rights, see the “Business Users Quick Guide” in the documentation of the SAP
cloud solution.

See Also
Define Access Control [page 365]

8.3.3.5 Define Access Control

Overview
In the studio, you can implement instance-based access control for a business object you created by referencing an
SAP business object for which an access context is defined.
Access rights in the cloud solution are based on work center and work center views. For each view, an access context
is predefined that defines for which business data administrators can restrict user access rights, for example, by
company, site, sales, or employee. For example, if business users have access rights for a work center view but

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 365
should only see company-specific data, you can define your business object so that it inherits the access control list
(ACL) from an SAP business object that is assigned the company access context.

Prerequisites
● An SAP access context exists that you can use for your use case.
For more information about access contexts and access restrictions, see the relevant documentation of the
cloud solution.
● An SAP business object exists with the necessary access context and an access control list (ACL) is directly
assigned to this business object.

Procedure
1. In the studio, define a business object with an association that is marked as relevant for access control by
doing the following:
a. Create a business object, for example, with the name AccessControlByCompany, and enter your
business object definition.
For information about creating and defining a business object, see Business Objects Quick Guide
[page 346].
b. Add an element to the business object root node that you use to find the relevant business object
instance.

You want the access context to be controlled by company, so you define a Company element
of type ID:
element Company : ID;

c. Add an association to the business object that is used for access control and mark the association with
the annotation [RelevantForAccessControl].

● For each business object, you can only use one association that is relevant for access
control.
● The source node of the association must be the root node.
● The target node of the association must be root node of the target business object, that
is, the controlling business object.
● The target business object must have an association that is relevant for access control.
● The target of this association must be the AccessControlList dependent object.

[RelevantForAccessControl] association For_Access_Control to

CompanyFinancialsProcessControl;

d. Add a status element to the business object root node to handle errors, typically
ConsistencyStatusCode:
element Consistent :ConsistencyStatusCode;
2. In the studio, create a query using the Query Wizard to include the query data in an object worklist (OWL).
For information about creating a query, see Create a Query [page 363].

For correct instance handling, a query based on Fast Search Infrastructure (FSI) is necessary. By
default, the query includes the ACL data even if you do not select this information.

SAP Cloud Applications Studio – Version May 2018 (1805)

366 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 3. Create an Event-BeforeSave.absl script file and define an association for access control.
For information about creating script files, see Define the Business Logic for a Business Object
[page 369].
a. In the Event-BeforeSave.absl script file, add the query you created to get the instance for access
control.

Query = CompanyFinancialsProcessControl.QueryByCompany;
Selection = QueryCreateselectionParams();
Selection.Add(Query.CompanyID, “I”, EQ”, this.Company.Content);
QueryResults = Query.Execute(Selection);
In this example, access is controlled by company and the query uses the company at the
root node as the basis for selection.

b. Find the relevant instance in the query and set the association to this instance.

foreach (companycontrol in QueryResults) {

this.For_Access_Control = companycontrol;
break;
}

c. For error handling, set a status on the business object root node.

if (this.For_Access_control.IsSet ()){
this.Consistent = “3”;
}
else{
this.Consistent = “2”;
}
In this example, the consistency status codes are “2” for consistent and “3” for
inconsistent.

4. Assign the access context to the work center view.

a. In the studio, generate the screens for your business object.
For information about generating screens, see Generate Screens for a Business Object [page 370].
b. Open the work center view for editing by right-clicking the *WCVIEW.uiwocview screen file in the
Solution Explorer and selecting Open in UI Designer.
The view opens in the UI designer.
c. In the Properties window, under RBAMData, select Access Context Code and assign the same access
context code that is assigned to the associated SAP business object.
d. Save and activate your changes.
e. Check that the correct screens are assigned: Under RBAM Data, select Assigned Objects.
The system displays the directly linked OWL and other linked screens that you can navigate to from
the OWL, for example, an object instance floorplan (OIF) or a quick activity floorplan (QAF).
5. Assign the business object that controls access to the linked screens by doing the following:
a. In the studio, double-click the screen file, for example, *QA.uicomponent or *OIF.uicomponent.
The screen opens in the UI designer.
b. In the Properties window, under RBAMData, check that the following entries exist:
● Access Check Mode is set to Privileged Except Access.
● Authorization Classification Code is set to Application.
c. Open the collection of the Access Controlled Business Object.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 367
 The Select Business Objects dialog box opens.
d. Check that the correct business object is selected and that the Unrestricted Access checkbox is not
selected.
e. Save and activate your changes; then close the UI designer.

Result
You have defined an association for access control, defined the access context for the work center view, and defined
access control for the screens for which you want to restrict access rights. You can now manage access rights for
business users in the cloud solution. For information, see Assign Access Rights [page 368].

8.3.3.6 Assign Access Rights

Overview
If you have implemented instance-based access control for a business object you created in the studio, you can
restrict read and write access in the SAP cloud solution on the basis of a work center view's access context.
In the SAP cloud solution, administrators can assign access rights to each employee who has a user in the system.
For example, if an employee should only see data for a specific company and the company access context is assigned
to a work center view, you can assign or restrict access to company-specific data for this view.

Prerequisites
You have defined associations that are relevant for access control in your business object and assigned the SAP
business object that controls access to the work center views. For information, see Define Access Control
[page 365].

Procedure
1. In the SAP cloud solution, disable the access rights of all users for the relevant work center views.
a. Open the Application and User Management work center User and Access Management Business
User subview.
b. Select the user whose access rights you want to assign using the access control settings you have
defined for your business object; then click Edit and choose the Access Rights option to open the
access rights editor.
c. On the Work Center and View Assignment tab, find your work center in the list of available work centers
and clear the Assigned to User checkbox.
d. Save your changes and log off from the system.
Your changes are applied the next time you log on.
2. In the studio, update the authorization and access rights by doing the following:
● In the Solution Explorer, right-click your solution and select Update Authorization and Access Rights.

You must disable the access rights of all users before you update authorization and access rights in
the studio.

SAP Cloud Applications Studio – Version May 2018 (1805)

368 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 3. Assign access rights to users for work centers views.
a. In the SAP cloud solution, open the Application and User Management work center User and Access
Management Business User subview.
b. Select the user whose access rights you want to edit; then click Edit and choose the Access Rights
option to open the access rights editor.
c. On the Work Center and View Assignment tab, in the list of available work centers, find your work center
and select the Assigned to User checkbox.
d. Save your changes.
If you do not want to restrict any access rights, you can log off from the system. Your changes are
applied the next time you log on.

For more information about assigning access rights to business users in the SAP cloud solution, see
Business Users Quick Guide under Assign Access Rights.

4. Restrict the access rights of users for work centers views.

a. On the Access Restrictions tab, in the list of available work centers, find your work center and select
the Read and Write Access checkbox.
b. On the Detailed Restrictions tab, restrict read and write access on the basis of the work center views's
access context, for example, based on the company.
c. Save your changes and log off from the system.
Your changes are applied the next time you log on to system.

For more information about access contexts and access restrictions in the SAP cloud solution, see
User and Access Management under Access Restrictions.

8.3.3.7 Define the Business Logic for a Business Object

Overview
To define the business logic for your business object in the studio, you use event, action and validation script files.
For more information, see Actions, Events, and Validations [page 349].

Prerequisites
● You have saved the relevant business object.
● In order to define actions, you must have added them to your business object definition before. For more
information, see the action [page 177] keyword in Syntax for Business Object Definitions [page 174].

Procedure
1. In the Solution Explorer, right-click your business object and select Create Script Files.
2. In the Create Script Files dialog box, for each of the business object nodes, select the events and validations
that you want to implement.
The system selects actions by default.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 369
 3. Optional: If you want script files to be mass-enabled, select the Mass Enable checkbox for the relevant actions,
events or validations.
4. Click OK.
The studio generates script files in the Solution Explorer with the file extension .absl . The script files appear
below the corresponding nodes of your business object. For example, Event-AfterModify.absl for an
event, Validation-OnSave.absl for a validation, or Action-Release.absl for an action. Each script file
opens in a separate document window.

5. In the code editor, select the script file you want to edit and enter the code for the event, validation, or action.
For more information about the methods and keywords you can use, see Syntax for Implementation of
Business Logic [page 210].
6. Save your script files.

8.3.3.8 Generate Screens for a Business Object

Overview
In the studio, you can generate screens in the SAP cloud solution based on your business object definitions, for
example, work centers, floorplans, and fact sheets.
In the studio, you can generate screens in the SAP cloud solution based on your business object definitions. For
example, you can generate work centers, floorplans, and fact sheets. These screens then automatically contain an
initial set of the fields that you have defined for your business object. The screens behave according to the business
logic that you have implemented for your actions and events. You use the user interface designer to enhance the
screens and adapt them to your needs.

You can also use your generated screens for mobile solutions. For more information, see step 3 of this
document and Mobile Solutions [page 670].

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Prerequisites
● If you generate screens based on an SAP business object, the business object must be released for the SAP
public solution model (PSM).
● If you generate screens based on your business object, the business object must be activated. For more
information, see Business Objects Quick Guide [page 346].

SAP Cloud Applications Studio – Version May 2018 (1805)

370 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Procedure
1. In the Solution Explorer, do one of the following:
● If you generate screens based on an SAP business object, proceed as follows:
1. Right-click the project in your solution and select Add New Item .
2. Select the Business Object template, enter a name and click Add.
● If you generate screens based on one of your business objects, right-click the business object and
select Create Screens.
2. In the Create Screens dialog box, enter a name for the new screen or set of screens.
The system uses this name together with the abbreviation of the screen type as a file name as follows:
[screen name]_OWL.OWL.uicomponent.
3. Under Devices Supported, you can select the devices on which a user can display the screens. The options
available are Desktop Only, Desktop and Tablet, and Mobile Only. The default option is Desktop Only.

You can change your selection in the Property Explorer of the UI designer. For more information, see
Mobile Solutions [page 670].

4. Select either the screen types you want to create or a whole screen scenario with navigation paths.
You can select the following screen types:
● Object Instance Floorplan (OIF)
● Quick Activity Floorplan (QAF)
● Fact Sheet (FS)
● Object Work List (OWL)
● Object Value Selector (OVS)
● Work Center View (WOCVIEW)
● Quick View (QV), not available for SAP Business ByDesign
● Quick Create (QC), not available for SAP Business ByDesign
● Thing Inspector (TI), not available for SAP Business ByDesign
● Thing Type (TT), not available for SAP Business ByDesign

For detailed information on the various screen types, see Screen Types [page 353].

Screen Scenario with Thing-based Navigation (not available for SAP Business ByDesign)
If you select Screen Scenario with Thing-based Navigation (not available for SAP Business ByDesign), the
system generates the following screens and the navigation paths that you need to be able to navigate from
one screen to the next:
Object Work List, Quick Create, Quick View, Thing Inspector, Thing Type, Work Center, and Work Center View.

Screen Scenario with Object-based Navigation

If you select Screen Scenario with Object-based Navigation (called "Screen Scenario with Navigation" for SAP
Business ByDesign), the system generates the following screens and the navigation paths that you need to
be able to navigate from one screen to the next:
Object Instance Floorplan, Object Work List, Quick Activity Floorplan, Work Center, and Work Center View.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 371
 Short ID
If you select Work Center View or a screen scenario containing a work center view, an additional field
appears where you must enter a Short ID of up to 13 characters. It is preceded by the technical name
of the solution and followed by _WCVIEW: [Technical name of solution]_[Short
ID]_WCVIEW. The short ID helps you identify the work center view in the UI designer and in the SAP
cloud solution. After you have entered the short ID, it is displayed in the following places:
● UI designer: in the Property Explorer under Component Info in the Short ID field
● SAP cloud solution: Application and User Management Work Center and View
Assignment

5. Click OK.

Result
In the Solution Explorer, the files for the screens are listed. The system also creates a port type package file (.ptp
file) that contains the navigation, for example, from the object work list to the quick activity floorplan.
To view a screen, right-click a screen file and select Preview Screen. To edit a screen, right-click a screen file and
select Open in UI Designer. For more information, see Introduction to the User Interface Designer [page 594].

8.3.3.9 Create an OWL Excel Export

Overview
Object Work Lists (OWL) generated for custom business objects allow you to export the OWL data to a Microsoft
Excel file. The file is based on a standard template, which you cannot change. However, you can format the generated
spreadsheet as required.

Prerequisites
● You have opened your solution containing an active custom business object.
● You have created a floorplan scenario with navigation.

Procedure
1. Log on to the SAP cloud solution and select Application and User Management Business Users .
2. Select you user and select Edit Access Rights .
3. In the Work Center and View Assignment view, select the work center you have created and assign it to your
user. Click Save and Close.
4. Log off from the SAP cloud solution. Log on again and navigate to the work center you have assigned to your
user.
The work center you have created is displayed. It contains an Export button.
5. Click New and create several instances of your business object. .
6. Complete the fields and select Save and then Close to get to the entry screen again.

SAP Cloud Applications Studio – Version May 2018 (1805)

372 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 7. On the OWL, click Go to view the data records you have created.
8. Click Export To Microsoft Excel .

Result
Microsoft Excel opens. The data records are displayed on a spreadsheet. You can save the data as it is or format it
to suit your requirements.

See Also
Example: Export OWL Data to Excel [page 373]

8.3.3.10 Example: Export OWL Data to Excel

Overview
In this example, you create a solution with a custom business object. You generate a screen scenario with object-
based navigation and test the work center in the SAP cloud solution. After that, you create data records, which you
export to Microsoft Excel.

Procedure
1. Create a solution and generate the floorplan scenario.
a. Log on to the studio and create a new solution.
b. In the Solution Explorer, click the Add New Item button.
The Add New Item dialog opens.
c. Select Business Object, enter a name (for example, OWL_EXPORT.bo) and click Add.
The Business Object Selection dialog opens.
d. Enter the following code:
import AP.Common.GDT;
businessobject OWL_EXPORT {
[Label("Identifier")] element ID:ID;
[Label("Name")] element name:LANGUAGEINDEPENDENT_MEDIUM_Name;
[Label("Description")] element
description:LANGUAGEINDEPENDENT_MEDIUM_Description;
[Label("Start Date")] element start_date:Date;
[Label("End Date")] element end_date:Date;
[Label("Amount")] element amount:Amount;
[Label("Title")] element title:AcademicTitleCode;
}
Save and activate the business object.
e. Right-click your solution and select Create Screens.
The Create Screens dialog opens.
f. Select a screen scenario, enter a Short ID, and click OK.
The screens are generated and the corresponding files are displayed in the Solution Explorer.
2. Assign the work center and perform a test.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 373
 a. Log on to the SAP cloud solution and select Application and User Management Business
Users .
b. Select you user and select Edit Access Rights .
c. In the Work Center and View Assignment view, select the work center you have created and assign it
to your user. Click Save and Close.

Work Center Assignment

d. Log off from the SAP cloud solution. Log on again and navigate to the work center you have assigned
to your user.
The work center is displayed. It contains an Export button.

Export Button

e. Click New.
f. Create several instances of your business object. Complete the fields and select Save and then
Close to get to the entry screen again.

Entry Screen

SAP Cloud Applications Studio – Version May 2018 (1805)

374 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 g. On the OWL, click Go to view the data records you have created.

Data Records

h. Click Export To Microsoft Excel .

Result
Microsoft Excel opens. The data records are displayed on a spreadsheet. You can save the data as it is or format it
to suit your requirements.

Download

8.3.3.11 Enable Change History

Overview
You can use an embedded component to ensure that a change history is written for all changes made to your custom
business object. After adding the embedded component to your business object, you can display the change history
in the SAP cloud solution on the Changes tab of your work center. All changes such as add, create, and delete are
displayed in a list.

Prerequisites
● You have created users with the Developer and Business User roles. For more information, see User Setup
Quick Guide [page 31].
● You have created and opened a solution in the studio. For more information, see Create a Customer-Specific
Solution [page 165].
● You have created a business object or business object extension in your solution and entered a business
object definition. At least one element/node/association in your business object is annotated with
ChangeHistory. For more information, see Business Objects Quick Guide [page 346].
● You have created an object instance floorplan (OIF) for your business object. For more information, see
Generate Screens for a Business Object [page 370].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 375
Procedure
1. Add an embedded component to the object instance floorplan (OIF) you created for your business object.
a. In the studio, in the Solution Explorer, double-click the object instance floorplan (OIF).
The UI designer opens.
b. On the Designer tab, click the Changes tab.
c. In the Configuration Explorer, navigate to the ChangeDocuments_EC reuse component in the
SAP_BYD_APPLICATION_UI/Reuse/ChangeHistory folder.
d. Drag the reuse component to the top left pane of the OIF as shown in the graphic and then save your
changes.

2. Create an outport using the ECORootNodeID parameter.

a. On the Controller tab, right-click Outports and select Add Outport.
The Outport Configuration: OutPort pane opens.
b. Click the Add Parameter button.
c. In the ParameterName field, enter ECORootNodeID and save your changes.
3. Create a binding for the embedded component by binding the outport parameter and the ChangeHistory
inport parameters.
a. Next to ParameterBinding, click ... .
The Parameter Binding dialog box opens.
b. Select NodeID and click OK.
c. On the Changes tab, click Bind.
The Embedded Component Binding dialog box opens.
d. Right-click Navigations and select Add Navigation.
The Navigation Details are displayed.
e. In the OutPort field, select OutPort and in the InPort field, select InECONodeID.
f. Under OutPort Parameters and InPort Parameters, select the parameters and then click Bind.
The outport and inport parameters are displayed under Bound Parameters.
g. Click OK and save your changes.
4. Create an event handler to fire the outport.
a. On the Controller tab, right-click Event Handlers and select Add EventHandler.
The new event handler is displayed under Event Handlers.
b. Right-click the new event handler and select Rename; then enter a new name for the event handler.
c. Under EventHandler Operations, click the Add Operation button.
d. Under Type, click in the field and then select FireOutport.
e. Under Configure the operation, select your outport and save your changes.

SAP Cloud Applications Studio – Version May 2018 (1805)

376 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 5. To ensure that the user can open the embedded component by clicking the Changes tab, associate the new
event handler with the OnClick event.
a. Click the Properties tab.
b. On the Designer tab, click the Changes tab and then click the Properties tab again.
c. On the Properties tab, under Events OnClick , select the event handler you created and then save
your changes.
6. Specify the configuration parameters in the ChangeDocuments embedded component properties.
a. Select the embedded component and click the Properties tab.
b. Under Parameters, specify the following parameters by clicking the arrow to the right of each field:

BOName <Name of your business object>

BONameSpace <Namespace of your business object>

ECOName <Name of your business object>

ECONameSpace <Namespace of your business object>

You can copy the name and namespace from the BO Browser/Data Model but copy and paste
does not work. You can also copy and paste the namespace from the Solution Properties in the
studio.

c. Deselect the IsAttributeSearchEnabled option.

d. Save and activate the floorplan.
7. Create a business configuration set in the studio.
a. Activate your business configuration, right-click the solution and select Deploy Business
Configuration.
The system deploys the business configuration content you created and makes the field values
available in the development environment.
8. Test the embedded component.
a. Log on to the cloud solution as a business user and assign the work center that has the same name as
your business object to your service agent.
b. Navigate to the work center you created and click Edit.
c. Enter data in one or more of the fields and save your changes.
d. On the right of the screen, click View All.
e. Select Close and Refresh.
Your changes are displayed on the Changes tab.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 377
 Example of a change history

The ChangeHistory annotation does not work for Dependent Objects.

See Also
Create a BC Set Using an SAP BCO [page 332]

8.4 Extensibility

8.4.1 Business Object Extensions

8.4.1.1 Business Object Extensions Quick Guide

Business object extensions enable you to enhance business objects that are provided by SAP by adding extension
fields to them.
After you create and activate a business object extension, you can add the extension field to the corresponding
forms, screens, reports, and search categories.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

SAP Cloud Applications Studio – Version May 2018 (1805)

378 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Business and Technical Background

Business Object Extensions

You can customize the business objects that are provided by SAP by creating business object extensions. When you
create a business object extension, you modify the extendable nodes of an existing business object to include
additional fields. Once the business object extension has been activated, you can include the extension fields in script
files, screens, reports, and search categories. Creating a business object extension does not create a copy of the
business object. Once you extend a business object, the original business object is no longer available and is replaced
by the extended business object.
Most business objects provided by SAP contain both extendable and non-extendable nodes. However, some
business objects do not contain any extendable nodes and cannot be used with business object extensions. You can
only create business object extensions for business objects that are provided by SAP. Other business objects cannot
be used with business object extensions.

SAP’s Cloud Solution Administrator Tool

To learn about the administrator tools that customers can also use to create extension fields for a screen that has
been enabled for extension fields, see Extension Fields Quick Guide.
For example, an administrator can add an extension field with the field type “Text” to the business context Account
- General Information and then add the extension field to the end-to-end sales process flow.

Enterprise Search in SAP’s Cloud Solution

The Enterprise Search capability in the SAP cloud solution allows customers to search the entire system efficiently.
For information about how customers use Enterprise Search, see Enterprise Search.

Tasks

Create a Business Object Extension

You can create an extension for an SAP business object (business object extension) and add new fields to the
extendable nodes of this business object. The extendable nodes are automatically provided in a template, to which
you can add additional fields.
For more information about this task, see here [page 381].

Define the Business Logic for a Business Object Extension

You use event script files and validation script files to define the business logic for your business object extension.
For more information about events and validations, see Actions, Events, and Validations [page 349].
For more information about this task, see here [page 382].

Add an Extension Field to a Screen

You can add an extension field to a business object’s corresponding screens.
For more information about this task, see here [page 383].

Add an Extension Field to a Form

You can add an extension field to the business object’s corresponding forms. You can either add the extension field
to an original form, or you can create a copy of a form and add the extension field to the copy.
For more information about this task, see here [page 384].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 379
Add an Extension Field to a Report
You can add an extension field to a data source that is based on the same business object as the extension field. You
can then add the field to any reports based on the data source.
For more information about this task, see here [page 386].

Add an Extension Field to the Enterprise Search

You can add an extension field to an enterprise search category. This allows users to search for the contents of an
extension field within a particular category, such as sales orders or suppliers.
For more information about this task, see here [page 388].

Define a Message for a Business Object Extension

You can define a message in a business object extension and raise the message in an event. Messages can only be
raised in the business object extension where they are defined.
For more information about this task, see here [page 389].

Add a Label and Tooltip to an Extension Field

You can define a label and a tooltip for an extension field. If you then add the extension field to a screen:
● the label is displayed on the screen instead of the extension field name
● the tooltip is displayed when you place the cursor on the extension field

For more information about this task, see here [page 387].

See Also
Process Extension Scenario Quick Guide [page 395]
Syntax for Business Object Extension Definitions [page 197]
Maintenance of Business Object Extensions [page 380]

8.4.1.2 Maintenance of Business Object Extensions

Overview
A customer-specific solution is in maintenance mode, if it has been assembled and downloaded; the solution status
then is Assembled. You can make changes to the solution in a patch; however, you can only make restricted changes
to certain content types. These change and delete restrictions ensure that you do not make changes to a solution
that could lead to loss of data or create inconsistencies or errors on a customer's production tenant.

Change and Delete Restrictions

The following table gives an overview of the change and delete restrictions for business object extensions in a solution
that is in maintenance mode. The system performs the change and delete restrictions checks when you save the
business object extension.

SAP Cloud Applications Studio – Version May 2018 (1805)

380 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Topic Adding Allowed Deletion Allowed Renaming Allowed Comments

Business object extension Yes No No

Business object node element Yes No No

Data type of element No No No

Label annotation Yes Yes Yes

Tooltip annotation Yes Yes Yes

Reference annotation Yes No No

Relation annotation Yes No — The target must not be changed.

Decimal annotation No No No

Scenario annotation Yes No No

Messages Yes Yes Yes

Process extension scenario Yes No No

Providing default values Yes Yes — Changes are allowed.

See Also
Business Object Extensions Quick Guide [page 378]

8.4.1.3 Tasks

8.4.1.3.1 Create a Business Object Extension

Overview
You can create an extension for an SAP business object (business object extension) and add new fields to the
extendable nodes of this business object. The extendable nodes are automatically provided in a template, to which
you can add additional fields.

Prerequisites
You know how to work with business objects and how to use the scripting language.

Procedure
1. In the Solution Explorer, expand your solution, right-click your project file, and select Add New Item .
The Add New Item dialog appears.
2. Select Business Object Extension.
3. Enter a Name for your business object extension and click Add.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 381
 You cannot use a name that is already used for a business object or business object extension in your
solution.

The Business Object Selection dialog appears.

4. Select the Namespace of the SAP business object that you want to extend.
5. Select the Business Object that you want to extend.
6. Click OK.
A business object extension item with the file extension .xbo is added to your project. This file contains a
template for the business object extension, including the extendable nodes.
7. In the Solution Explorer, double-click the business object extension to open the file in the editing pane.
8. To add extension fields, add elements to the extendable nodes with the scripting language.
9. Click the Save button.
10. Right-click the business object extension and select Activate.

Example
This example shows an extension of the Lead business object provided by SAP. Two text elements, Test_Text1
and Test_Text2 , have been added to the business object extension – one at the root level and one at the item level.
import AP.Common.GDT;
import AP.CRM.Global;
[Extension] businessobject AP.CRM.Global:Lead {
element Test_Text1:LANGUAGEINDEPENDENT_EXTENDED_Text;
node Item {
element Test_Text2:LANGUAGEINDEPENDENT_EXTENDED_Text;
}
}

See Also
Syntax for Business Object Extension Definitions [page 197]
Business Object Extensions Quick Guide [page 378]
Scripting Language [page 173]
Business Objects Quick Guide [page 346]

8.4.1.3.2 Define the Business Logic for a Business Object Extension

Overview
You use event script files and validation script files to define the business logic for your business object extension.
For more information about events and validations, see Actions, Events, and Validations [page 349].

Prerequisites
The extended business object must be activated if you want to access an extension field in your script file.

SAP Cloud Applications Studio – Version May 2018 (1805)

382 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Procedure
1. In the Solution Explorer, right-click your business object extension and select Create Script Files.
The Create Script Files dialog box is displayed, listing all the nodes of the business object. You can only select
nodes that are released as part of the public solution model (PSM).
To find out which nodes have been released for the PSM, select the Repository Explorer in the studio.
For more information, see Repository Explorer [page 50]
2. Select the script files that you want to create for each of the nodes of the business object.
Events, such as BeforeSave and AfterModify, can be created for each node. The validation OnSave can
only be created for the root node.
3. Select the Mass Enable checkbox if you want the script file to be mass enabled.
If mass enabled, the script file will be executed for multiple instances of the business object node. You cannot
clear this checkbox after a script file has been created. If you want to modify a script file afterwards so that it
will only be executed for a single instance of the business object node, you need to delete the script file first
and re-create it again.

If you use the this keyword in the coding of a mass enabled script file, this represents a collection
of business object node references.

4. Click OK.
In the Solution Explorer, script files with the file extension .absl appear below the corresponding nodes of
your business object. Each script file is opened on a tab page in the code editor.
5. In the code editor, select the script file you want to edit and enter the coding.
For more information about the methods and keywords you can use, see Syntax for Implementation of
Business Logic [page 210].
6. In the File menu, click Save.
7. In the Solution Explorer, right-click the script file and select Activate.

8.4.1.3.3 Add an Extension Field to a Screen

You can add an extension field to a business object’s corresponding screens.

This function is not available for solution templates. For more information, see Solution Templates
[page 162].

Prerequisite
You have created and activated a business object extension that contains at least one extension field.

Procedure
1. In the Solution Explorer, right-click the business object extension (.xbo file) and select Enhance Screen.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 383
 The Enhance Screen dialog appears and lists the screens that can be modified for this business object
extension.
2. Select the screen to add the extension field to, and click OK.
The UI designer opens.
3. In the Extensibility Explorer, select the Section Group or List to which you want to add the extension field.
4. Depending on the type of entity selected, click either the Add Extension Field to Section Group button or the
Add Extension Field to List button.
The Add Extension Field dialog appears and lists the available extension fields.
5. Select the extension fields to add to the screen by clicking the Add check box.

If you want the field to be read-only, select the Display Only check box.

6. Click Apply.
7. Click the Save button.
8. Click the Activate button.
The Activate Worklist dialog appears.
9. Select the screen you have modified and click OK.

See Also
Create a Business Object Extension [page 381]

8.4.1.3.4 Add an Extension Field to a Form

You can add an extension field to the business object’s corresponding forms. You can either add the extension field
to an original form, or you can create a copy of a form and add the extension field to the copy.

This function is not available for solution templates. For more information, see Solution Templates
[page 162].

Feature Matrix

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Prerequisites
● You have created a solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

384 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 ● You have created and activated a business object extension in that solution.

Procedure
1. Switch on admin mode
In the studio, right-click your solution and, in the Administration menu, select Switch On/Off Admin Mode.
2. Create a Copy of a Form (optional)
You can create a copy of a form and add the extension fields to the copy.

This option is useful if you want to be able to print different versions of a form. Example: Depending on
the selection by the business user, the preview is to show the standard print form or the extended print
form.

a. Right-click your business object extension (.xbo file) and click Enhance Form.
The Enhance Form dialog appears.
b. Click Copy Form.
The Form Template Maintenance screen appears.

If you are not already logged on to the SAP solution, you will be prompted to log on.

c. In the Show list, select Active Forms and click Go.

To speed up the search, click Advanced. Enter the template name or template group and click
Go.

The available forms are displayed.

d. Select the form template that you want to copy, and click Copy As New Template .
e. Enter a Template Name and Template Description for your new template.
f. Click OK.
g. Click the Refresh button to verify that your template has been added to the list of available templates.

Use a filter to find your template by name.

3. Edit the Form in the Easy Form Editor

a. Right-click your business object extension (.xbo file) and click Enhance Form.
The Enhance Form dialog appears.
b. Select the extension field you want to add to the form and click OK.
The Further Usage of Extension Field screen appears.

If you are not already logged on to the SAP solution, you will be prompted to log on.

c. Select the form template to which you would like to add the extension field and click Add Field and
Edit Easy Form Editor .
The Easy Form Editor screen appears.
d. In the Sections area, select the section to which you would like to add an extension field.
The Details area lists the fields that can be added to the section.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 385
 e. In the Details area, select the extension field to add to the form, and set the Show attribute to Show
always.
f. To preview the form with the extension field, in the Preview area, click the Refresh button.
g. To save your changes, click Save.
h. To make your change visible to other users, click Publish and Close.

Additional Activities
To view the form template in the SAP solution, business users must create a form template rule.
For more information, see “Create a Form Template Rule“ in the “Form Template Selection Quick Guide" in the
documentation of the SAP cloud solution.

See Also
Create a Business Object Extension [page 381]

8.4.1.3.5 Add an Extension Field to a Report

You can add an extension field to a data source that is based on the same business object as the extension field. You
can then add the field to any reports based on the data source.

This function is not available for solution templates. For more information, see Solution Templates
[page 162].

The following table shows whether an extension field can be used as a key figure or characteristic.

Extension Field Type Analytics Usage

Amount Key Figure

Date Characteristic

Decimal Number Key Figure

E-Mail Address Characteristic

Indicator Characteristic

List Characteristic

Text Characteristic

Time Characteristic

Quantity Key Figure

Web Address Characteristic

Prerequisite
The business object extension has been activated.

SAP Cloud Applications Studio – Version May 2018 (1805)

386 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Procedure
1. Open your solution and select Administration Switch On/Off Admin Mode in SAP Solution .
2. Right-click on your business object extension (.xbo file) and click Enhance Report.
The Enhance Report dialog box appears.
3. Select the extension field you want to add to the report and click OK.
The Further Usage of Extension Field screen appears.

If you are not already logged on to the SAP cloud solution, you will be prompted to log on.

4. On the Data Sources and Reports tab, you can view all data sources available for the business context in which
you created the field. When you select a data source, all reports based on that data source are displayed in
the lower table.
5. To add the field to a data source, select the data source and click Add Field.
6. To add the field to an existing report based on this data source, select the report from the lower table and
click Add Field.
The report opens in admin mode.
7. In the Add Fields dialog box, select the Display in Report checkbox next to the extension field.
Characteristics are added to the report under Not Currently Shown and key figures are available under
Columns.
8. Click OK and close the report without saving.
The field will be available to all business users when they next access the report.

See Also
Create a Business Object Extension [page 381]

8.4.1.3.6 Add a Label and Tooltip to an Extension Field

Overview
You can define a label and a tooltip for an extension field. If you then add the extension field to a screen:
● the label is displayed on the screen instead of the extension field name
● the tooltip is displayed when you place the cursor on the extension field

Procedure
1. Create an extension field with a label and a tooltip using the following syntax:
[Label ("<label name>")] [Tooltip ("<tooltip name>")] element <extension field
name> : <data type>;
For more information, see Create a Business Object Extension [page 381].
2. Add the extension field to a screen. For more information, see here [page 383].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 387
Result
In the Solution Explorer in the studio, right-click your extended screen (.xuicomponent) and select Preview.
The label is displayed for the extension field. The tooltip is displayed when you place the cursor on the field.

8.4.1.3.7 Add an Extension Field to the Enterprise Search

You can add an extension field to an enterprise search category. This allows users to search for the contents of an
extension field within a particular category, such as sales orders or suppliers.

This function is not available for solution templates. For more information, see Solution Templates
[page 162].

The following table shows which type of search can be used for each extension field type:

Search Type by Extension Field Type

Advanced Worklist Basic Enterprise Advanced Enterprise

Field Type Basic Worklist Search Search Search Search

Amount No Yes No Yes

Date No Yes No Yes

Decimal Number No Yes No Yes

E-Mail Address Yes Yes Yes Yes

Indicator No Yes No Yes

List Yes Yes Yes Yes

Text Yes Yes Yes Yes

Time No No No No

Quantity No Yes No Yes

Web Address Yes Yes Yes Yes

Prerequisite
The business object extension has been activated.

Procedure
1. Right-click your solution and select Administration Switch On/Off Admin Mode in SAP Solution .
2. Right-click your business object extension (.xbo file) and click Enhance Enterprise Search.
The Enhance Enterprise Search dialog box appears.
3. Select the extension field you want to add to the search and click OK.
The Further Usage of Extension Field screen appears.

SAP Cloud Applications Studio – Version May 2018 (1805)

388 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 If you are not already logged on to the SAP cloud solution, you will be prompted to log on.

4. On the Enterprise Search tab, you can view all enterprise search categories to which you can add the field.
This is determined by the business context in which you created the field.
5. To add a field to an enterprise search category, select it from the list and click Add Field.
The enterprise search category determines in which category users will be able to search for the contents of
this field using the basic enterprise search. They can then refine their search by clicking on Advanced and
using the extension field as a search parameter.

8.4.1.3.8 Define a Message for a Business Object Extension

Overview
You can define a message in a business object extension and raise the message in an event. Messages can only be
raised in the business object extension where they are defined.
The following message types are available:
● Information
● Warning
● Error
● Success

Prerequisites
● You have an open solution in the studio.
● You have created a business object extension (.xbo) as part of your solution. This extension contains at least
one element and is activated.

Procedure
1. In the Solution Explorer, double-click the business object extension to open the file in the editing pane.
2. Use the message and text keywords to specify the name and content of the message, respectively.
3. Use the raises keyword to specify which messages are raised for the individual nodes of the business object
extension.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 389
 import AP.Common.GDT;
import AP.CRM.Global;
[Extension] businessobject AP.CRM.Global:Opportunity raises
Information_Message, Error_Message, Warning_Message {
// You must activate this business object before you can access the
extension fields
// in script files and screens.
message Information_Message text "This is an Information message";
message Error_Message text "This is an Error message with one parameter
&1" : LANGUAGEINDEPENDENT_SHORT_Name;
message Warning_Message text "This is a Warning message with two
parameters &1 and &2" : LANGUAGEINDEPENDENT_SHORT_Name, IntegerValue;
message Success_Message text "This is a Success message with a variable
parameter &1" : Amount;
element Test_Extension_Field : Amount;
node Item raises Information_Message, Success_Message {
}
}

You can include up to four parameters. For each parameter, you must specify the data type.

4. In your action or event script file, raise the message using the raise keyword.

import ABSL;
raise Information_Message.Create("I");
raise Error_Message.Create("E", "Error");
raise Warning_Message.Create("W", "Warning", 25);
raise Success_Message.Create("S", this.Test_Extension_Field);

Code completion is available after you type the raise keyword.

Result
Messages appear on the user interface based on the actions or events that you defined.

See Also
Scripting Language [page 173]
Business Object Extensions Quick Guide [page 378]

SAP Cloud Applications Studio – Version May 2018 (1805)

390 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.4.1.3.9 Create References to Customer-Specific Fields

Customers can enhance their SAP cloud solution by creating extension fields in the adaptation mode. In the studio,
you can create references to these customer-specific fields. After that, you can implement the business logic for the
referenced fields in script files of your solution.

● You cannot reference a customer-specific field in a solution template.

● You cannot reference a calculated field.
● You can only reference a customer-specific field in the extension of a business object that has been
released in the public solution model (PSM).

What you need to know about the lifecycle management of field references
Uploading Field References
If you upload your solution with references to customer-specific fields, these fields must also exist in the SAP cloud
solution. If this is not the case, you need to create these fields manually in the cloud solution. The technical name
and the type of the fields must always be identical in your solution and in the SAP cloud solution.
Deleting Field References
As long as a customer-specific field is referenced by your solution, it cannot be deleted anymore. If you want to delete
a reference to a customer-specific field in your solution, make sure that you delete it in the script file in the studio
first.

Prerequisites
● In the SAP cloud solution, your customer has created extension fields for a business context.
● In the studio, you have created a solution containing a business object extension and at least one script file.
In the business object extension, make sure that you have extended the business object corresponding to
the business context of the extension field.

Procedure
1. In the Solution Explorer, right-click your solution and select Add New Item.
The Add New Item dialog opens.
2. Select SAP Extension References to Customer-Specific Fields , enter a name and click Add.
A .ref file ( ) appears in the Solution Explorer.
3. A document window opens that displays the References to Customer-Specific Fields table. In the table, select
the fields that you want to use in your solution by clicking the Used field. You can sort the table by clicking the
column titles.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 391
 The table shows the fields that are available for each business object or business object node. If a
field is used in several business contexts in the SAP cloud solution, the field is displayed several
times in the table with the same field name. The Business Object column helps you identify the
correct field.

4. Save and activate the .ref file.

You can only create one .ref file per solution. It contains the references to all customer-specific fields.
If you want to add further references, open the .ref file and select additional fields you want to
reference.

Result
You can now define the business logic for the referenced fields in the relevant script files of your solution. The
referenced fields are shown in the code completion.
You can delete references to customer-specific fields when your solution is in maintenance mode. For more
information, see Maintenance Mode [page 170].

See Also
Example: Calculate the Duration of a Campaign (References to Customer-Specific Fields) [page 392]

8.4.1.3.10 Example: Calculate the Duration of a Campaign

(References to Customer-Specific Fields)

Example
In SAP Cloud for Customer, your customer has created a Duration field in the Campaigns work center view. In the
studio, you create a reference to that field and use it in a script file to calculate the duration of a campaign.

Create an extension field in the cloud solution.

1. Log on to the cloud solution with a business user and choose Marketing Campaign Management
Campaigns .

2. Select a campaign and click Edit.

3. Choose Adapt Enter Adaptation Mode and then Adapt Edit Screen .
4. In the Adapt dialog, choose Extension Fields Add .
5. In the Add New Field dialog, in the Field Label field, enter Duration and click Save.
6. In the Adapt dialog, select the Visible and Display Only fields.

SAP Cloud Applications Studio – Version May 2018 (1805)

392 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Adapt Dialog

7. Click Save and Publish and confirm the Publish Changes for Screen dialog.
The adaptation mode closes and you can see the field you have added on the screen.

Duration Field on the Adapted Screen

8. Log off from the cloud solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 393
Create a reference to the customer-specific field in the studio.
1. Log on to the studio and create a new solution.
2. In the Solution Explorer, click Add New Item.
The Add New Item dialog opens
3. Select SAP Extension Business Object Extension .
4. Enter a name (Campaign.xbo) and click Add.
5. Right-click the .xbo file and click Save and Activate ( ).
6. In the Business Object Selection dialog, select a namespace (http://sap.com/xi/AP/CRM/Global) and
a business object (Campaign) and click OK.
In the Solution Explorer, an .xbo file ( ) appears.
7. Right-click the .xbo file and select Create Script Files.
The Create Script Files dialog opens.
8. Select Event: After Modify and click OK.

An .abslfile ( ) appears in the Solution Explorer.

9. Click Add New Item again.
The Add New Item dialog opens.
10. Select SAP Extension References to Customer-Specific Fields , enter a name and click Add.
A .ref file ( ) appears in the Solution Explorer.
11. In the table, select the Duration field and click Save and Activate.
12. Open the .absl file and enter the following code:
import ABSL;
this.Duration.content =
this.PlannedStartDate.Delta(this.PlannedEndDate).ConvertToDays();
this.Duration.unitCode = "DAY";
13. Save and activate the solution.

Test the referenced field in the cloud solution.

1. Log on to the cloud solution and choose Marketing Campaign Management Campaigns and click
Edit.
2. Change the Planned End Date.
The system calculates the duration of the campaign, and the result is displayed in the Duration field.

SAP Cloud Applications Studio – Version May 2018 (1805)

394 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Calculated Duration

See Also
Create References to Customer-Specific Fields [page 391]

8.4.2 Process Extension Scenarios

8.4.2.1 Process Extension Scenario Quick Guide

A process extension scenario links the data from one business context to other related business contexts.
You create a process extension scenario from a list of predefined extension scenarios. For example, you can create
a process extension scenario that links the following business contexts:
● Account - General Information to Lead - General Information
● Lead - General Information to Opportunity - General Information

Each process extension scenario contains one or more data flows. Each data flow consists of a source and target
business context. This reflects how the data is passed from one business context to the next as part of a business
process.
For a list of predefined extension scenarios, see Extension Scenarios [page 396].
If you now extend any of the business objects involved in the scenario, you can use the annotation [Scenario] to
declare that the element is available to all the business contexts specified in the scenario.
For example, if you add an element to the Lead business object, you can use an extension scenario to make this
element available if you extend the Opportunity. When an Opportunity is created from the Lead, the data for your
extension field will be passed to the Opportunity.

B2B Message Extension

You can also extend B2B messages in a process extension scenario. If a predefined extension scenario includes an
inbound or outbound B2B data flow, you can create a process extension scenario that includes this data flow. Once
an extension field is associated to a scenario that includes such a flow, the extension field value will be propagated
to the B2B message during runtime.
When selecting the data flows to include in a process extension scenario, you can identify outbound and inbound
B2B messages by their individual icons.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 395
Tasks

Create a Process Extension Scenario

For more information about creating a process extension scenario, see here [page 397].

Add an Extension Field to a Process Extension Scenario

For more information about adding an extension field to a process extension scenario, see here [page 398].

8.4.2.2 Extension Scenarios

Overview
Extension scenarios enable you to create an extension field in one business context and then add that extension field
to multiple other business contexts. The data stored in the extension field is then passed from one business context
to the next as part of a business process.
The following extension scenarios have been predefined by SAP:
● Account - General Information to Lead - General Information
● Account - General Information to Opportunity - General Information
● Lead - General Information to Opportunity - General Information

SAP Cloud Applications Studio – Version May 2018 (1805)

396 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.4.2.3 Create a Process Extension Scenario

Overview
You can create a process extension scenario to link the data from one business context to other related business
contexts.

Prerequisites
You have an open solution in the studio.

Procedure
1. In the Solution Explorer, right-click your project and select Add New Item .
The Add New Item dialog box is displayed.
2. Under Installed Templates, click SAP Extension .
3. Select the Process Extension Scenario template, enter a Name for the process extension scenario, then click
Add.
The Extension Scenario Creation dialog box is displayed.

If the Create Extension Scenario window does not open completely, you can choose one of the
following two options:
● Enlarge the window by clicking and dragging the window frame.
● Switch to the default screen resolution. For example, in Microsoft Windows 7, select Control
Panel Display Smaller – 100% (default) .

4. Select the Namespace, Business Object, and Node.

Based on your selection, a list of possible extension scenarios is displayed. The individual data flows are
displayed under each extension scenario.
5. Select one or more extension scenarios.
Based on your selection, additional extension scenarios may be displayed.
6. Select additional extension scenarios, as desired.
7. Click OK.
A process extension scenario item with the file extension .xs is added to your project.

See Also
Add an Extension Field to a Process Extension Scenario [page 398]

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 397
8.4.2.4 Add an Extension Field to a Process Extension Scenario

Overview
You can use the annotation [Scenario] to declare that an element should be available to all the business contexts
specified in a process extension scenario.
For example, if you have a process extension scenario that links the Lead, Opportunity and Sales Order business
contexts, you can add an element to the Lead business object, and this element will be available if you extended a
screen for an Opportunity, a Sales Quote, or a Sales Order.

Prerequisites
● You have an open solution in the studio.
● You have created a process extension scenario as part of your solution.

Procedure
1. In the Solution Explorer, right-click your project and select Add New Item .
The Add New Item dialog box is displayed.
2. Under Installed Templates, click SAP Extension .
3. Select the Business Object Extension template, enter a Name for your business object extension, then click
Add.
The Business Object Selection dialog box is displayed.
4. Select the Namespace of the business object that you want to extend.
5. Select the Business Object that you want to extend.
6. Click OK.
A business object extension item with the file extension .xbo is added to your project. This file contains a
template for the business object extension, including the extendable nodes.
7. In the Solution Explorer, double-click the business object extension to open the file in the editing pane.
8. To add extension fields, add elements to the extendable nodes with the scripting language.
9. To include an element in an extension scenario, use the following syntax:
[Scenario (Lead_to_Opportunity)] element ext_field_Opportunity_root:Text;

Process extension scenarios are specific to the node for which they were created. If an extension
scenario was created for the root node, then it can only be called at the root node within the .xbo.
Similarly, a process extension scenario created for the item node can only be called from the item
node within the .xbo.

10. Click the Save button.

11. Right-click the business object extension and select Activate.

See Also
Scripting Language [page 173]

SAP Cloud Applications Studio – Version May 2018 (1805)

398 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Business Object Extensions Quick Guide [page 378]
Create a Process Extension Scenario [page 397]

8.4.3 Create an ODATA Service Extension

Overview
You can enhance the existing standard PSM enabled ODATA services with extension fields. You can add the extension
fields to ODATA services that are based on the same business object.

Prerequisites
● You have an open In-Development solution in the studio
● The Business Object extension is already active

Process Flow
1. In the Solution Explorer, expand your solution, right-click your project file, and select Add New Item .
The Add New Item dialog box is displayed.
2. Under Installed Templates SAP , select OData Extension.
3. Enter a Name for the OData service extension, and then click Add.
The Select Standard OData Service dialog box is displayed.
4. Enter the OData Extension Name.

You cannot use a name that is already used for a business object or business object extension in your
solution.

5. In the OData Service dropdown, the system shows the standard OData services delivered by SAP. Select a
OData service for which you have enhanced the standard Business Object.
6. Click OK. The system opens the OData Editor in your default internet browser.

If you are not already logged on to the SAP Cloud Solution, you will be prompted to log on. Use your
Cloud Applications Studio user to login to the system.

The OData Editor has two parts. The right pane OData Service is a hierarchical tree that displays all the entity
types in the service, and the left pane displays the business object details.
7. Under OData Service , select the checkbox for the required entity type. The system displays the Business
Object details of the selected entity type on the left pane.
8. Expand the relevant node and select the extension fields that you want to add to the OData Service. The PDI
extension fields will be in edit mode and you can select or deselect them. Note that you cannot edit standard
SAP fields.
The selected fields will be added to the entity type.
9. On the right pane, expand the entity type to see the newly added custom field. Select this field to check its
properties. You have the option to change few properties, such as, Name and Default value. Note that property
names in an entity type should be unique.
10. Once you have added the fields, click Save and then click Activate.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 399
 You can also activate the OData service from the Cloud Applications Studio. To do this refresh your solution
to see a new item with .xodata extension. Right click on the newly added item, and select Activate.
You can also perform the clean, delete, and check operations from the studio.

The same OData service cannot be added more than once in a solution. For example, once you add the
Opportunity OData service to a solution, it is not possible to add the same OData service to the solution.

When you change the name or data type of extension fields in business object extension(.xbo), you must
adjust the OData service by removing and adding the property.

Maintenance Mode
You can perform the following actions in a OData Service in maintenance mode:
● Edit: Add and remove extension fields from the OData Editor
● Delete: Delete OData service extension from the solution

8.4.4 Enhancement Implementations

8.4.4.1 Enhancement Implementations Quick Guide

SAP provides enhancement options based on SAP technology that allow you to enhance the standard behavior of
specific applications of the SAP cloud solution without modifying the standard solution. In the studio, you can create
enhancement implementations of SAP enhancement options. For example, you can implement a custom variant of
a calculation or override the default filter values to meet country-specific, industry-specific, or customer-specific
requirements. You can define your own business logic, for example, for determining, validating or mapping data.

Business and Technical Background

SAP Enhancement Options

An enhancement option is a repository object provided by SAP for a specific application to allow the standard
behavior of the application to be enhanced without modifying the standard solution. Enhancement options are
defined with metadata and documentation. A distinction is made between single-use enhancement options and
multiple-use enhancement options. If an enhancement option is for single use, it can be implemented only once in
a solution. If an enhancement option is for multiple use, it can be implemented more than once in a solution.
The documentation of the enhancement options describes how you can use an enhancement option, when the
enhancement option is called, and what it does. Furthermore, it gives information about the business configuration
content you need to develop for an enhancement implementation, the scoping requirements in the customer system,
as well as information about the filters, the input parameters and output parameters, and testing activities.
You can explore SAP enhancement options and view the documentation of the enhancement options using the
Repository Explorer tool window. For more information, see Repository Explorer [page 50].

SAP Cloud Applications Studio – Version May 2018 (1805)

400 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Tasks

Create a Business Configuration Set

You can create a business configuration set (BC set) using an SAP business configuration object (BCO) to configure
the behavior of standard business processes in the SAP cloud solution. If you create an implementation of an
enhancement option which is for single use only, you can also define a BC set using an SAP BCO so that you can
enhance the filter values.
For more information, see Create a BC Set Using an SAP BCO [page 332].

Create an Enhancement Implementation

You can create an enhancement implementation of an SAP enhancement option to allow customers to apply
business rules that meet specific requirements, for example, country-specific requirements, without modifying the
standard functionality of the SAP cloud solution. An enhancement implementation consists of a message definition,
a filter, and a script file.
For more information, see Create an Enhancement Implementation [page 401].

Test an Enhancement Implementation

To check content in the business adaptation catalog, for example, for testing purposes, you must be assigned the
Business User role and have access rights for the Business Configuration work center. For more information, see
User Setup Quick Guide [page 31].

8.4.4.2 Create an Enhancement Implementation

Overview
You can create an enhancement implementation of an SAP enhancement option to allow customers to apply
business rules that meet specific requirements, for example, country-specific requirements, without modifying the
standard functionality of the SAP cloud solution. An enhancement implementation consists of a message definition,
a filter, and a script file.

Prerequisites
● You have created and opened a solution in the studio. For more information, see Create a Customer-Specific
Solution [page 165].
● If the enhancement option for which you created an implementation is for single use only, you have defined
a business configuration set (BC set) using an SAP business configuration object (BCO) so that you can
enhance the filter with the value that you want to use in your filter definition. You must also assign the BC set
to a business option.
For information about which SAP BCO is related to which filter, see the public solution model (PSM)
documentation for the enhancement option. For information about creating a BC set, see Create a BC Set
Using an SAP BCO [page 332].

Procedure
1. In the Solution Explorer, click the Add New Item button.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 401
 The Add New Item dialog box opens.
2. In the Add New Item dialog box, select the Enhancement Implementation template, enter a name for your
enhancement implementation, and then click Add.
The Create Enhancement Implementation dialog box opens.

You must specify a name that begins with an uppercase letter (A-Z) and only contains alphanumeric
characters (A-Z, a-z, 0–9) and underscore characters (_). The name must not exceed 120 characters.

3. In the Create Enhancement Implementation dialog box, select a namespace and an enhancement option.
Optionally, you can select a namespace and business object to filter the list of enhancement options.
A new item with the file extension .enht appears in the Solution Explorer. By default, the following items are
created under the .enht file:
● Filter
An item with the same name as the enhancement implementation and the file extension .fltr
● Script file
An item with the file extension .absl, for example, CONVERT.absl

The .enht file opens in a document window.

4. Under Message Definition, define messages for your enhancement implementation by doing the following:
a. Specify a message ID.
Each message you define must have a unique ID.
b. Define the messages parameters one-by-one, from left to right, by doing the following:
1. In the parameter cell, double-click ... .
The Parameter Selection dialog box opens. By default, the http://sap.com/xi/AP/Common/
GDT is displayed and the Data Type field is blank.
2. Select a namespace and a data type.
c. Specify one or more message texts.
You use ampersands (&) in the message text to represent placeholders. The number of placeholders
in the text must match the number of parameters. For information about defining message texts, see
General Standards and Guidelines for Writing System Message Texts [page 682].
d. Save your changes; then, in the Solution Explorer, right-click the .enht file and select Check In
Content.
The item is locked for editing.
5. In the Solution Explorer, double-click the .fltr file.
The filter editor opens in a document window.
6. Under Filters, specify a value for each filter.
● By default, all filters are disabled except for mandatory filters.
● To enable a filter, you must select the filter checkbox.
● If you do not specify a value for a mandatory filter, the system reads the value as blank.
● If a code list is available for a filter, you can select a value from a dropdown list.
● If you hover over the filter name, the data type of the filter is displayed as a tooltip.
7. Save your changes; then, in the Solution Explorer, right-click the .fltr file and select Check In Content.
The item is locked for editing.
8. In the Solution Explorer, double-click the .absl file.
The script file opens in a document window. By default, the following code is displayed:
import ABSL;

SAP Cloud Applications Studio – Version May 2018 (1805)

402 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 var result : AEString;
return result;
9. In the code editor, define the business logic for your enhancement implementation.
10. Save your changes; then, in the Solution Explorer, right-click the .absl file and select Check In Content.
The item is locked for editing.
11. In the Solution Explorer, right-click the .enht file and select Activate to activate the messages, the filters, and
the business logic you defined.

Result
You have created and defined messages, filters, and the business logic for your enhancement implementation. You
can now test your enhancement implementation in the SAP cloud solution.

8.5 Reuse Libraries

8.5.1 Reuse Library Quick Guide

There are two types of reuse libraries: custom reuse libraries that help you to organize the code in your solution or
to reuse code in your script files, and SAP reuse libraries, which offer a variety of predefined functions.

Business Background

Custom Reuse Libraries and Custom Reuse Functions

A reuse library is the container for reuse functions, whereas the reuse functions provide the code and specify the
parameters. You can define reuse functions, for example, to execute mathematical operations or to read or change
data of a business object. You can create and define your own reuse libraries and reuse functions to organize complex
code in your solution or to reuse your code in script files. Your reuse libraries are called “custom reuse libraries” to
differentiate from the SAP reuse libraries.

Basic SAP Reuse Libraries

These reuse libraries provide basic functions that are used often, for example, to retrieve context data, such as the
current date or time for the identity of the user currently logged in.
For more information, see Basic SAP Reuse Libraries Reference [page 238].

SAP Reuse Libraries for Business Areas

These reuse libraries provide additional, very specific functions that are relevant for business areas of SAP cloud
solutions, for example, in the Financial Management business area. These functions are based on entities provided
by SAP.
For more information, see SAP Reuse Libraries for Business Areas Reference [page 268].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 403
SAP Built-In Functions
The SAP built-in functions extend the scope of the syntax for the implementation of your business logic in a similar
way as the basic reuse libraries. However, in contrast to the reuse libraries, you do not need to import a namespace
to use built-in functions.
For more information, see SAP Built-In Functions Reference [page 276].

Tasks

Create Your Reuse Library

1. In the My Solutions tool window, open your solution.
2. In the Solution Explorer, right-click your solution and select Add New Item .
3. In the Add New Item dialog box, select Reuse Library and click Add.
A new item with the extension .library appears in the Solution Explorer.
A document window opens, in which you create new reuse functions.

Create Your Reuse Function

In the studio, you can create a reuse function by adding it to an existing or new custom reuse library in your solution.
A reuse function is created in two main steps: First, you define the signature of the function by specifying the
parameters; then you define the business logic in a separate script file that the system has automatically created
for your reuse function.
For more information, see Create Your Reuse Function [page 405].

Add Functions or Parameters to an Existing Reuse Library

1. In the Solution Explorer, double-click the reuse library.
A document window opens that displays the existing reuse functions and their parameters.
2. Select the reuse function that you want to change or create a new reuse function.
If you have selected a reuse function, you can change its parameters or add new parameters.
If you create a new reuse function, the Library Functions tool window opens and you proceed as described
under Create Your Reuse Function [page 405].
3. After you have made your changes, save the reuse library.

Call Your Reuse Function in a Script File

You call your reuse function in an action, an event, or a validation in the same way you call an SAP reuse function.

In this example, the SAP reuse function Date.ParseFromString and the custom reuse function
MyLibrary.CalculateAge are used. To call the SAP reuse function, you must import the ABSL
namespace.
import ABSL;
var birthday = Date.ParseFromString("1975-05-10");
var age = MyLib.CalculateAge( birthday );

Use Your Reuse Function in the UI Designer

If you have created a reuse function in the studio and have selected the Can Be Used in UI Designer checkbox, you
can use this reuse function to calculate the value of a dedicated field in the user interface designer (UI designer) .
For more information, see Configure a Dedicated Field [page 647].

SAP Cloud Applications Studio – Version May 2018 (1805)

404 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Reuse libraries are called transformations in the UI designer.

To be able to select your reuse function in the UI designer, you must know the namespace of your solution.
In the studio, you can find this information if you select your solution in the Solution Explorer and then check
the Properties window to see the namespace.

8.5.2 Create Your Reuse Function

In the studio, you can create a reuse function by adding it to an existing or new custom reuse library in your solution.
A reuse function is created in two main steps: First, you define the signature of the function by specifying the
parameters; then you define the business logic in a separate script file that the system has automatically created
for your reuse function.

Prerequisites
You have created a reuse library in your solution and you have opened this reuse library.

Procedure
1. In the document window of your reuse library, click Create Function.
The Library Functions tool window opens.
2. In the Create a Reuse Function step, enter a name for the reuse function. You can also select one of the
following options:
● Write-Enabled
The default setting for reuse functions is that they can be used only to read business object data.
However, you can change this setting and enable a reuse function to modify data of business objects
in a specific deployment unit.

Please note the following restrictions for the Write-Enabled option:

● You cannot call a write-enabled reuse function from a script file that is read-only, for
example, a validation.
● You cannot use a write-enabled reuse function in the user interface designer (UI
designer).

● Can Be Used in UI Designer

If you want to use your reuse function in the UI designer, you must select this option.

Please note the following restrictions for the Can Be Used in UI Designer option:
● If you select this option, you cannot use collections as a parameter type.
● You cannot select this option if the reuse function is write-enabled.

3. Click Next.
4. In the Define Parameters step, do the following to define an import parameter:

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 405
 a. In the first line of the table, enter a name for the import parameter.
b. In the same line, under Type, select a data type or a business object node.
If you have selected a business object node, the ElementsOf option is selected automatically, which
means that the data structure of this node will be passed on by the reuse function.
c. In addition, you can specify the following:
● You can make the parameter optional.
● You can specify that the data type or the business object type is a collection (collectionof).
5. Repeat the last step for each import parameter. You can also define one return parameter.
You can click Move Up and Move Down to change the order of the parameters.
6. Click Next.
If some of your import parameters are optional, the system changes the order of your parameters so that the
mandatory parameters come first. If you have added an output parameter, the system places this parameter
at the end of the list.
7. In the Review step, check that the information you have entered is correct and then click Finish.
8. Save your reuse function.
A new item with the file extension .absl appears in the Solution Explorer below the library file.
9. Open the .absl file in the code editor to define the business logic of your reuse function.

You cannot raise messages in a reuse function.

To hide or display the signature in the script file, press CTRL + E and then CTRL + S .

Result
You can call this reuse function in a script file. For more information, see Reuse Libraries Quick Guide [page 403].

8.6 Code List Data Type

8.6.1 Create a Code List Data Type

A static code list contains a list of values and descriptions and is used, for example, to provide dropdown lists on UIs.
In the studio, you can define a code list data type for your solution and use it when you create your custom business
object, a business object extension, or a business configuration object.
If a customer needs to be able to change the code list values, use configurable code list data types instead. For more
information, see Create a Business Configuration Object [page 334].
You can delete the code list data type when your solution is in maintenance mode. For more information, see
Maintenance Mode [page 170].

Prerequisite
You have created the solution for which you want to create a code list data type. For more information, see Create
a Customer-Specific Solution [page 165].

SAP Cloud Applications Studio – Version May 2018 (1805)

406 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Procedure
1. In the Solution Explorer, select your solution and click Add Item.

2. In the Add New Item dialog, select Code List Data Type.
3. Enter a name and click Add.
The Code List Data Type Wizard opens.
4. In the Create Code List Data step, proceed as follows:
a. Enter a name and a description.

The suffix Code is added automatically to the name you enter in the Name field.

b. Click Next.
5. In the Define the Code List Values step, proceed as follows:
a. For all the code list values you want to define, you must enter a value and a description.
The Constant field is filled automatically with a default value (CO_[YOUR VALUE]). You can adjust the
constant but it has to start with CO_. Constants can be used in script files to access code values:
<CodeListDataType>.<Constant>, for example, SeasonsCode.CO_FALL.

You can use the tab key to navigate between the fields and rows.

b. Click Next.
6. In the Review step, review your entries and click Finish.
In the Solution Explorer, a file is added to your solution. It is called [name of your code
list].codelist.
7. Right-click the .codelist file and select Activate.

Result
A new data type is generated. You can use it when you create business objects, business object extensions, or
business configuration objects. The code list values can be exported for translation. For more information, see
Translation Quick Guide [page 584].

See Also
Data Types [page 87]
Example: Create a Code List Data Type (Purchase Order Request) [page 408]

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 407
8.6.2 Example: Create a Code List Data Type (Purchase Order
Request)

Use Case
In a company, employees create purchase order requests to order goods and services. In the system, they need to
choose the purchase order type: standard purchase order or collective purchase order. If they choose a special offer
purchase order, they benefit from a price discount. For a special offer purchase order request, an additional field
needs to be maintained, which is checked in a script validation.

Prerequisites
● You have a studio developer user and a business user for the SAP cloud solution. For more information, see
User Setup Quick Guide [page 31].
● You have created a solution. For more information, see Create a Customer-Specific Solution [page 165].

In the studio, create the code list data type.

1. Log on to the studio and, in the Solution Explorer, select your solution and click Add Item.
2. In the Add New Item dialog, select Code List Data Type.
3. Enter a name (PurchaseOrderType) and click Add.
The Code List Data Type Wizard opens.
4. In the Create Code List Data step, proceed as follows:
a. Enter a name (PurchaseOrderType; the suffix Code is added automatically) and a description
(Purchase Order Type).
b. Click Next.
5. In the Define the Code List Values step, proceed as follows:
a. Enter the following values:

Value Description

STANDARD One-Time Purchase Order

COLLECTIVE Collective Purchase Order

SPECIALOFFER Special Offer Purchase Order

b. Click Next.
6. In the Review step, review your entries and click Finish.
7. In the Solution Explorer, a file is added to your solution. It is called PurchaseOrderType.codelist.
8. Right-click the PurchaseOrderType.codelist file and select Activate.

In the studio, create a business object.

1. In the Solution Explorer, right-click the project in your solution and select Add New Item.
2. In the Add New Item dialog box, select the Business Object template, enter a name for your business object
(PurchaseOrderRequest.bo), and click Add.

SAP Cloud Applications Studio – Version May 2018 (1805)

408 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 A new item (PurchaseOrderRequest.bo) appears in the Solution Explorer and the business object editor
opens.
3. In the editor, enter the following coding:
import AP.Common.GDT as apCommonGDT;

businessobject PurchaseOrderRequest raises SpecialOfferMessage {

[Label("Purchase Order Request ID")] [AlternativeKey]element

PurchaseOrderRequestID : ID;
[Label("Purchase Order Type")] element PurchaseOrderType : PurchaseOrderTypeCode;
[Label("Account ID")]element AccountID : BusinessPartnerInternalID;
[Label("Product ID")]element ProductID : ProductID;
[Label("Description")]element Description : MEDIUM_Description;
[Label("Price")]element Price : Amount;
[Label("Discount")]element Discount : Percent;
[Label("Requestor")]element Requestor : UUID;
[Label("Manager")]element Manager : UUID;
[Label("Account Manager")]element AccountManager : UUID;
[Label("Special Offer")]element SpecialOffer : UUID;

message SpecialOfferMessage text "Please add special offer";

4. Save and activate the business object.

In the studio, create a script file.

1. Right-click the business object and select Create Script Files.
The Create Script Files editor opens.
2. Select the Validation: On Save option and click OK.
3. In the editor, enter the following coding:
import ABSL;
if (this.PurchaseOrderType == PurchaseOrderTypeCode.CO_SPECIALOFFER &&
this.SpecialOffer.IsInitial())
{
raise SpecialOfferMessage.Create("E");
return false;
}
return true;
4. Save and activate the script file.

In the studio, create the screen.

1. Right-click the business object and select Create Screens.
2. In the Create Screens dialog, select Quick Activity Floorplan (QAF) and click OK.
In the Solution Explorer, a new file appears (PurchaseOrderRequest_QA.QA.uicomponent).

In the SAP cloud solution, test the code list data type.
1. Right-click the .uicomponent file and select Preview Screen.
2. Log on to the SAP cloud solution with the business user.
3. The PurchaseOrderRequest:<ID and/or Description> screen opens.
4. Under Purchase Order Type, check that a dropdown list box is available with the defined codes and
descriptions.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 409
 5. Test the Validation: On Save check you have defined:
a. Enter a Purchase Order Request ID.
b. Select the Purchase Order Type SPECIALOFFER.
c. Save your entries.
The error message Please add special offer should be displayed.

See Also
Create a Code List Data Type [page 406]

8.7 Data Protection and Privacy

8.7.1 Enable Data Disclosure

Custom BOs and BO extensions (XBOs) that may have personal data is available in the Data Protection and Privacy
work center. This section gives you a step-by-step guide as to how you can enable the data disclosure in the user
interface.

Prerequisites
You have access to the following work centers:
● Business Partner Data
● Account Management
● Data Protection and Privacy

Configure Business Object and UI

1. Log on to the SAP Cloud Applications Studio and choose your system.
2. Go to My Solutions and create a new solution.
3. Create a Business Object.
4. Create an association to the business partner object that you want to configure using the following sample
code:

In this sample, we will create an association to Employee.

import AP.Common.GDT as apCommonGDT;

import AP.FO.BusinessPartner.Global;
businessobject EmpAdditionalData {
[Label("Employee ID")] [AlternativeKey] element EmployeeID : EmployeeID;
node SocialData[θ,n]{
[Label("Social Media")] element socialmedia : SocialMediaCode;
[Label("Handler")] element handler : LANGUAGEINDEPENDENT_SHORT_Name;

SAP Cloud Applications Studio – Version May 2018 (1805)

410 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 }
node CommunicationData[θ,n]{
[Label("Comm. Media")] element commmedia : CommDataCode;
[Label("Detail")] element detail : LANGUAGEINDEPENDENT_SHORT_Name;
}
node AddhocData[θ,n]{
[Label("Name")] element namecode : AddhocCode;
[Label("Detail")] element detail : LANGUAGEINDEPENDENT_SHORT_Name;
}
association ToEmployee to Employee;
}
5. Create a Script file, for example, AfterModify to fill the data for this BO.
import ABSL;
import AP.FO.BusinessPartner.Global;
var emproot;
var empid;
var empquery;
var selparam;
var selresult;
var empUUID ;

import AP.FO.BusinessPartner.Global;
if (!this . EmployeeID.IsInitial()){
empid = this.EmployeeID.content;
empquery = Employee.QueryByIdentification;
selparam = empquery.CreateSelectionParams();
selparam.Add(empquery.InternalID,"I", "EQ",empid);
selresult = empquery.ExecuteDataOnly(selparam);
empuuid = selresult.GetFirst().UUID;
this.ToEmployee = Employee.Retrieve(empuuid);
}

Create Screens for the Business Object

1. Under Project Explorer, right-click your BO and select Create Screens.
2. In the Create Screens wizard, enter the Screen Name and Supported Devices.
3. Under Screen Creation, select the Screen Scenario with Thing-Based Navigation radio button provide a short
ID.
The Object worklist (OWL) would act as a navigation target for the corresponding disclosure entity of this BO.
4. Click OK. The generated screens are displayed in the solution explorer.
5. Open the OWL in the UI Designer.
6. Go to the DataModel tab and add data field to the search parameter.
7. Bind the datafield to the SAP_ToEmployee association.
8. Navigate to the Controller tab and select the OBN Inport checkbox.
9. Under OBN Configuration select the BO Based radio button.
10. Enter the following details in the available fields on the screen:

Field Name User Entry

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 411
 Select Namespace http://sap.com/xi/AP/FO/BusinessPartner/Global

Select BOmodel Employee

In this example, we have used Employee as the business partner, therefore Employee BO
is selected.

Select Operation ObligationToDisclose

Context Attribute Provide an OBN context that starts with the SolutionPrefix.

PortType Package /SAP_BYD_APPLICATION_UI/DataPrivacy/Reuse/

EE_OBLIGATION_TO_DISCLOSE_PTP.PTP.uicomponent

PortType Reference Obligation_to_disclose

11. Map the Employee UUID in the parameters to the data field which is supposed to receive the Employee UUID.
If you are using any other profiles, you need to use the particular combination for BO/PTP and operation.

Business ByDesign SAP Hybris Cloud for Customer

Employee ● BO – Employee ● BO – Employee

● PTP – / ● PTP – /
SAP_BYD_APPLICATION_UI/ SAP_BYD_APPLICATION_UI/
DataPrivacy/Reuse/ DataPrivacy/Reuse/
EE_Obligation_to_disclose_PTP. EE_Obligation_to_disclose_PTP.
PTP.uicomponent PTP.uicomponent
● Operation – ● Operation –
ObligationToDisclose ObligationToDisclose

Service Agent ● BO – Employee

● PTP – /
SAP_BYD_APPLICATION_UI/
DataPrivacy/Reuse/
SA_Obligation_to_disclose_PTP.
PTP.uicomponent
● Operation –
SAObligationToDisclose

Private Account ● BO – Business Partner ● BO – Business Partner

● PTP – / ● PTP – /
SAP_BYD_APPLICATION_UI/ SAP_BYD_APPLICATION_UI/
DataPrivacy/Reuse/ DataPrivacy/Reuse/
ObligationToDisclosureGenericP ObligationToDisclosureGenericP
TP.PTP.uicomponent TP.PTP.uicomponent
● Operation – ● Operation –
ObligationToDisclose ObligationToDisclose

SAP Cloud Applications Studio – Version May 2018 (1805)

412 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Contact Person ● BO – Business Partner
● PTP – /
SAP_BYD_APPLICATION_UI/
DataPrivacy/Reuse/
ObligationToDisclosureGenericP
TP.PTP.uicomponent
● Operation –
ObligationToDisclose

12. Configure the OWL query by including Employee UUID as a parameter. The query that you use should have
Employee UUID as a parameter. The generated BO should by default have query by elements.

Configure OWL in Personal Data Disclosure Work Center View

1. In the Configuration Explorer tab, open /SAP_BYD_APPLICATION_UI/DataPrivacy/Reuse/
PersonalDataDisclosure_WCVIEW.WCVIEW.uiwocview
2. In the Extensibility Explorer tab, click Assign Component to View
3. In the Add Assigned Object window, select the type as NavigationTarget , and under Component, select the
OWL you have created.
4. Save and activate the OWL.

Create New Content Type in the Studio

1. Right click the solution, click Add New Item and under Installed Templates, select Data Protection
and Privacy Personal Data Disclosure .
2. Click Add. The system opens the personal data disclosure wizard.
3. In the Data Disclosure Profile field, select the profile for which you want to create personal data disclosure. In
this example, choose Employee and click Next.
4. In the wizard that appears, enter the following details:
● Disclosure Name: This is the name that is displayed on the UI.
● Disclosure Description
● UI Screen: Select the OWL that you created in the previous step. This is the navigation target for this
disclosure entity.
● Inport: Select the OBN inport that you configured in the previous step.
● Determination Functions: Make sure that the Count checkbox is selected. This is used to show the number
of relevant records for the entity.
5. Click Add. The values are displayed in the table at the bottom of the screen.
6. Click Next and check for the information you just filled and click Finish.
The GET_RECORDS.absl file is generated.
7. Write the following logic to calculate the number of records:
import AP.PC.InformationLifeCycleManagement.Global;
import AP.FO.BusinessPartner.Global;
var result:DataDiscloseBAdIDestroyCustomDataChangingStructure;
var emproot;
var bpid;
var empquery;
var selparam;
var selresult;
var empUUID = InputData.EmployeeUUID;

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 413
 emproot = Employee.Retrieve(empUUID);
bpid = emproot.Identification.GetFirst().BusinessPartnerID;
empquery = EmpAdditionalData.QueryByElements;
selparam = empquery.CreateSelectionParams();
selparam.Add(empquery.EmployeeID.content, "I", "EQ",bpid);
selresult = empquery.ExecuteDataOnly(selparam);
result.RecordsCountValue = selresult.Count();
return result;
8. Under Project Explorer, select GET.RECORDS.absl Activate .
9. Similarly, select the .pdd file and click Activate.
The custom business object is available in the Data Protection and Privacy work center.

Verify Custom Business Objects Record on the UI

1. Log on to the SAP system as an administrator.
2. Navigate to Data Protection and Privacy Personal Data Disclosure .
3. Select an employee and click Disclose Data. The system opens the Disclose Employee Data window.
4. Under Records, the system displays the number of records for the custom business object.
5. Click the custom business object to navigate to a new window. The system displays all the relevant data for
the employee.

8.7.2 Enable Data Removal

Custom BOs and BO extensions ( XBOs ) that may have personal data must be removed or anonymized when the
person's details are removed using the data privacy tool. This section explains how you can remove or anonymize
such data using the SAP Cloud Applications Studio.
You can remove personal data for the following types of business partners:
● Employees
● Service Agents
● Individual Customers
● Contacts

Prerequisites
You have access to the following workcenters:
● Business Partner Data
● Account Management
● Data Protection and Privacy

Configure Business Object and UI

1. Log on to the SAP Cloud Applications Studio and choose your system.
2. Go to My Solutions and create a new solution.
3. Create a Business Object.
4. Create elements of the Business Object where you plan to store personal data. Here’s a sample code:

SAP Cloud Applications Studio – Version May 2018 (1805)

414 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 import AP.Common.GDT as apCommonGDT;
businessobject PrivateAccBank {
[Label("Account ID")][AlternativeKey] element AccountID :
BusinessPartnerInternalID;
[Label("Description")] element description :
LANGUAGEINDEPENDENT_MEDIUM_Description;
node BankDetail[θ,n]{
[Label ("Benefits Account No.")] element benefitsacc : IntegerValue;
[Label ("Bank Account No.")] element bankaccno : BankAccountID;
[Label ("Bank Name")] element bankname : LANGUAGEINDEPENDENT_Name;
[Label ("Bank Country")] element bankcountry : CountryCode;
}
}
5. Generate screens.

Create a Personal Data Destruction Enhancement Implementation

1. Right click the solution, click Add New Item and select Extension Enhancement
Implementation .
2. Enter a name and click Add. The Create Enhancement Implementation wizard opens.
3. In the Namespace field, select http://sap.com/xi/AP/PC/InformationLifecycleManagement/Global.
4. In the Enhancement Option field, select DataPrivacyDestructionofCustomPersonalData.
5. Click OK. The system creates three files with .enht, .absl. and .fltr extensions.
6. Double-click the .enht file and define the message you want to display on the UI. To do this, enter the ID and
Text under the Message Definition header. Do not define any personal data other than the Employee ID in the
message parameters.
7. Open the DESTROY.absl file and add a script to remove or anonymize personal data stored in PDI custom
BOs and PDI extension fields in XBOs.
Disclaimer:
The script is write-enabled. Therefore, it should be used for personal data
deletion and anonymization only.
Creating or modifying standard business object nodes and fields, and calling
actions and web services is strictly prohibited.
import AP.PC.InformationLifeCycleManagement.Global;
import AP.FO.BusinessPartner.Global;
import AP.PDI.ABSL;
var result : DataDestructionBAdIDestroyCustomDataResultDataStructure;
var custroot;
var CustomerID;
var PrivateAccBankbo;
var currenttime;
var timestr;
if(InputData.BusinessPartnerRole == "Private Account"){
custroot = Customer.Retrieve(InputData.BusinessPartnerUUID);
CustomerID = custroot.InternalID;
PrivateAccBankbo = PrivateAccBank.Retrieve(CustomerID);
currenttime = Context.GetCurrentSystemTime();
timestr = currenttime.ToString();
PrivateAccBankbo.AccountID = "XXXX".Concatenate(timestr);
foreach(var bankdetailnode in PrivateAccBankbo.BankDetail){

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 415
 bankdetailnode.bankaccno = "XXXX".Concatenate(timestr);;
bankdetailnode.benefitsacc = 9999999;
}

raise DataAnonymized.Create("I");
result.ErrorOccurredDuringDestroy = false;
}
return result;
8. Save and activate the enhancement file.

Execute Data Removal on the User Interface

1. Log on to the SAP system as an administrator.
2. Navigate to Data Protection and Privacy Personal Data Removal .
3. Select an employee, service agent, individual customer, or private account and click Remove Data. The
corresponding window opens. For example, if you select an employee, the Remove Employee Data window
opens.
4. Click Delete, and then click Close. A background job is created with a corresponding Run ID.

The system runs a check and gives you an error if the selected data is within the retention period.

5. Navigate to Data Protection and Privacy Common Tasks , and click Administer Data Removal Runs. The
system displays a list of all Data Removal Runs. The generated Run ID will be in Active status.
6. Continue refreshing your screen until the Removal Failed flag turns to No.
The custom BO instances are anonymized.

8.7.3 Enable Read Access Logging

Overview
You can log and monitor read access to sensitive personal data, such as bank data, using Read Access Logging
(RAL). You can define fields that contain sensitive personal data for business partners (such as, Employees, Service
Agents, Individual Customers, and Contacts), and custom BO fields.
Whenever these fields are viewed by an end user, a Read Access Log (RAL) entry is created. Fields can be defined
as sensitive personal data only if the BO or node is enabled for Change history.
A RAL field group is created that contains all the sensitive personal fields defined in the solution.
Read Access Logging is enabled for the following channel/medium of access:
● Query (Standard and Custom)
● Web service (Read and Query Operations)
● Analytics Datasource and Reports
● ABSL Scripts

SAP Cloud Applications Studio – Version May 2018 (1805)

416 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 You are not allowed to:
● Debug or trace the PDI solution in the production system, if RAL is scoped and any RAL field group is
active.
● Use sensitive personal data fields as placeholders in workflow rules.
● Use custom queries in enterprise search if they contain sensitive personal data fields.

Prerequisites
● You have created and opened a solution in the studio. For more information, see Create a Solution
[page 165].
● You have ensured that the solution contains Custom BO nodes are annotated with ChangeHistory. For more
information, see Change History (Business Object) [page 183]
● You have ensured that the solution contains Custom BO nodes that may have sensitive fields have association
to BusinessPartnerProjection BO (Customer, Employee or BusinessPartner). For more information, see
Association (Business Object) [page 180]

Process Flow

Create New Content Type in the Studio

1. Right click the solution, click Add New Item and under Installed Templates, select Data Protection and
Privacy Sensitive Personal Data .
2. Add a name for the file.
3. Click Add. The Sensitive Personal Data Wizard opens.
4. In the Select Data Protection and Privacy Level step, select Sensitive Personal Data and click Next.
In the Sensitive Personal Data Field Selection step, the Field Group Name is automatically filled as the solution
name.
5. On this screen, you have an option to add fields from Standard BOs and Custom BOs. Under Custom BO
Fields, click Add.
The Select Sensitive Personal Data Field popup opens.
6. Enter a unique Item Description.
7. Select a Business Object from the dropdown. Note that the dropdown shows only custom BOs created in the
solution.
8. Select a node. Note that the dropdown shows only nodes that have ChangeHistory annotation.
9. In the Select Field tab, choose a field that you want to mark as sensitive personal data.
10. In the Select ID tab, choose an association with the Business Partner from the available list.

● You can only select InternalID or EmployeeID field. These fields are meant to identify the
Business Partner whose data has been read.
● For extension BOs, this tab is not available.

11. Click OK. A row is added to the Custom BO Fields table.

Follow the steps above to add more fields.
12. Optional: Add a field under Extension Fields following the same steps as above.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 417
 The field you add will also be added for other projections of the Business Partner. For example, if you define
an extension field in a Contact BO, it will be available in Individual Customer BO also. The system displays it
on screen under the BO Name field.
13. Click Next.
14. In the Review step, check that the information you have entered is correct and then click Finish.
A new item with the file extension .psd appears in the Solution Explorer.
15. In the Solution Explorer, right-click the file and select Activate.
A Field Group with the same name as the solution is created. The field group is available in the Data Protection
and Privacy work center.

● Each solution can have only one Sensitive Personal Data file.
● You cannot select fields from Dependent Objects.
● If you have marked an extension field as sensitive personal data, you cannot mark it as personal data.
● You cannot delete sensitive personal data fields from a solution in maintenance mode.

Verify Field Group on the User Interface

1. Log on to the SAP system as an administrator.
2. Navigate to Data Protection and Privacy Read Access Logging Field Group Configuration .
3. Under Field Group, select the RAL field group you created. The corresponding sensitive personal data fields
will show up in the Details section.

8.7.4 Enable Personal Data for Extension Fields

Overview
You can define fields that contain personal data for business partners in extension BOs. The personal data fields
content is destroyed when the corresponding business object instance is removed using the data removal process.
Currently, the extension fields of only business partner, customer, employee, and service agent are allowed to be
defined as personal data.

Prerequisites
● You have created and opened a solution in the studio. For more information, see Create a Solution
[page 165].
● You have ensured that the solution contains a Business Partner BO and its projection (Employee, Customer
and BusinessPartner) with extended field which is ChangeHistory relevant. For more information, see Change
History (Business Object) [page 183]

Process Flow

Create New Content Type in the Studio

1. Right click the solution, click Add New Item and under Installed Templates, select Data Protection and
Privacy Sensitive Personal Data .

SAP Cloud Applications Studio – Version May 2018 (1805)

418 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 2. Add a name for the file.
3. Click Add. The Sensitive Personal Data Wizard opens.
4. In the Select Data Protection and Privacy Level step, select Personal Data and click Next.
In the Personal Data Field Selection step, you can select extended fields from standard Business Objects.
5. Under Extension Fields, click Add.
The Select Personal Data Field popup opens.
6. Select a Business Object from the dropdown. Note that the dropdown shows only extension BOs created in
the solution.
7. Select a node. Note that the dropdown shows only nodes that have ChangeHistory annotation.
8. In the Select Field tab, choose the fields that you want to mark as personal data.
9. Click OK. A row is added to the Extension Fields table.
Follow the steps above to add more fields.
10. Click Next.
11. In the Review step, check that the information you have entered is correct and then click Finish.
A new item with the file extension .psd appears in the Solution Explorer.
12. In the Solution Explorer, right-click the file and select Activate.

In the maintenance mode, you cannot perform the following tasks:

● Delete a personal data field from a solution.
● Remove an already existing personal data field.

8.8 Approval Process

8.8.1 Approval Process Quick Guide

You can use the Approval Wizard to create an approval process in the root node of your custom business object.
For more information, see Approval Process [page 425].

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Business and Technical Background

The approval process built-in functions are only used in action script files that are created when you define an
approval process for a business object. Each action script file initially contains the call of the relevant built-in function.
The built-in functions are used to set the status of the business object and to manage related approval tasks.
For more information, see Approval Process Built-In Functions [page 424].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 419
Tasks

Create an Approval Process

In the studio, you define one approval process per business object in the root node. An approval process contains
at least one approval task and can have notifications and a revision task. For each task type, you define the task
recipients by selecting elements from the custom business object. Further, you can select business object elements
that an administrator can use to define approval step conditions in the SAP cloud solution.
For more information, see Create an Approval Process [page 427].

Assign Approval Process Tasks to the UI

You assign the approval process tasks to the UI to make the tasks and notifications visible in a work center of the
SAP cloud solution.
For more information, see Assign Approval Process Tasks to the UI [page 429].

Test the Approval Process

After assigning the approval process tasks to the UI, you can test the approval process you have created in the SAP
cloud solution.
For more information, see Test the Approval Process [page 431].

Example: Create an Approval Process (Price Request)

This example shows how to define a multistep approval process for a custom business object created in the studio.
For more information, see Example: Create an Approval Process (Price Request) [page 420]

8.8.2 Example: Create an Approval Process (Price Request)

This example shows how to define a multistep approval process for a custom business object created in the studio.

Example
A sales representative creates a price request to negotiate the contract pricing for an account. On save,
the price request is automatically submitted for approval to the manager of the sales representative. If
the value of the price request is below 10,000 US$ or the discount is below 15%, the price request is
approved automatically. If the value of the price request is greater than 200,000 US$, there is an
additional approval step: The responsible account manager needs to approve the price request as well.
After the price request is approved, the sales representative receives a notification.

Prerequisites
● You have a developer user for the studio and a business user in the SAP cloud solution. The Approval
Processes work center view is assigned to your business user.
For more information, see the User Setup Quick Guide [page 31].
● You have created a solution.
For more information, see Create a Solution [page 165].

SAP Cloud Applications Studio – Version May 2018 (1805)

420 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Studio: Create a solution with a business object
1. In the Solution Explorer, click Add New Item ( ) and select the Business Object template.
2. In the Name field, enter PriceRequest.bo and click Add.
In the Solution Explorer, the PriceRequest.bo file is displayed.
3. In the editor, enter the following coding:
import AP.Common.GDT;
businessobject PriceRequest {
[Label("Price Request ID")] [AlternativeKey] element PriceRequestID : ID;
[Label("Account ID")] element AccountID : BusinessPartnerInternalID;
[Label("Product ID")] element ProductID : ProductID;
[Label("Description")] element Description : MEDIUM_Description;
[Label("Price")] element Price : Amount;
[Label("Discount")] element Discount : Percent;
[Label("Requestor")] element Requestor : EmployeeID;
[Label("Manager")] element Manager : EmployeeID;
[Label("Account Manager")] element AccountManager : EmployeeID;
}
4. Right-click the file and click Save and Activate ( ).

Studio: Create the approval process

1. Right-click the PriceRequest.bo file and click Create Approval Process.
The Approval Wizard opens.
2. In the Define Task Properties step, the name of the Approval Status Field is already entered and the
Approval checkbox is already selected. Select the Notification checkbox and click Next.
3. In the Define Task and Notification Texts step, enter the following texts and parameter and click Next.

Tab Page Approval Task Approval Notification Rejection Notification

Subject Field Please approve price request Your &PRICEREQUEST& has Your &PRICEREQUEST& has
&PRICEREQUEST& been approved been rejected

Description Field Dear colleague, Dear colleague, Dear colleague,

Please approve Your &PRICEREQUEST& has Your &PRICEREQUEST& has
&PRICEREQUEST&. been approved. been rejected.
Kind regards, Kind regards, Kind regards,

To enter the parameter, proceed as follows:

1. Place the cursor at the position you want the parameter to appear and click Add Parameter.
The Parameters dialog opens.
2. In the Parameter field, enter the name PRICEREQUEST and click the ... button in the same
row.
3. Select the business object element PriceRequestID and click OK twice.

4. In the Select Task and Notification Recipients step, enter the following values and click Next:

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 421
 Task Type Description Business Object Element Default

Approval Manager Approval Root.Manager

Notification Requestor Notification Root.Requestor

Approval Account Manager Approval Root.AccountManager

To select the business object element, click the ... button, select the business object element and
click OK.

5. In the Select Fields for Conditions step, select the business object elements Price:Amount and
Discount:Percent, then click Next.
6. In the Review step, click Finish.
7. In the Solution Explorer, right-click the ApprovalStatus.approvalprocess file and click Activate.
8. Right-click your solution and select Deploy Business Configuration.
Due to technical background processes, it takes some time until the default approval process appears in the
SAP cloud solution.

Studio and UI designer: Create the screens

1. In the Solution Explorer, right-click the business object PriceRequest.bo and select Create Screens and
then a screen scenario.
In the Short ID field, enter an ID, for example Approval, and click OK.
The .uicomponent files are generated and displayed in the Solution Explorer.
2. Right-click the PriceRequest_WCView.WCVIEW.uiwocview file and select Open in UI Designer.
The UI designer opens in edit mode.
3. In the Property Explorer, under RBAMData, select AssignedObjects and click the ... button.
In the Add AssignedObjects dialog, proceed as follows:
a. Click the Add Row button.
b. In the new row, under AssignedObject Type, click the down arrow button and select TaskListView.
c. In the same row, under ComponentID, click the ... button.
The Select Component dialog opens.
d. In the folder for your solution ( [solution name]_MAIN SRC ), select the PriceRequest—Root—
APP1–approval file and click OK.
Repeat steps a. to d. for the PriceRequest—Root—APP1–notification file.
e. Click the Add Row button again.
f. In the new row, under AssignedObject Type, do not change the Navigation Target option.
g. In the same row, under ComponentID, click the ... button.
The Select Component dialog opens.
h. In the folder for your solution ( [solution name]_MAIN SRC ), select the PriceRequest—Root—
APP1.QA file and click OK.
Repeat steps e) to h) for NotificationUI and RevisionUI files, if any.
4. Save and activate your changes and close the UI designer.

SAP Cloud Applications Studio – Version May 2018 (1805)

422 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
SAP cloud solution: Test the approval process
1. Log on to the SAP cloud solution using your business user and choose Application and User
Management Approval Processes .
2. In the Find field, enter PriceRequest, and select your Default approval process for
PriceRequest, and click Copy.
3. In the copied approval process, in the Process Name field, enter Approval Process for
PriceRequest.
4. To create the manager approval step, do the following:
a. In the Process Step Name, enter Manager Approval.
b. In the Work Distribution field, select Manager Approval.
c. Under Conditions, click Add Group.
The Edit Conditions dialog opens.
d. Enter the following values:

Field Compare Operator With

Price Greater than or equal to 10,000 USD - US Dollar

Discount Greater than or equal to 15%

Click Add Condition ( ) to add a new condition.

5. To create the account manager approval step, do the following:

a. Under Process Steps, click Add Row
b. In the Process Step Name, enter Account Manager Approval.
c. In the Work Distribution field, select Account Manager Approval.
d. Under Conditions, click Add Group.
The Edit Conditions dialog opens.
e. Enter the following values:

Field Compare Operator With

Price Greater than or equal to 200,000 USD - US Dollar

f. Click Save and Close.

6. Click Edit Validity to adjust the validity of the approval process and click Save and Close.

● The Valid To Date of the default approval process must be the same as the Valid From Date of
the copied approval process.
● The copied approval process must have an unlimited validity.

7. Refresh the Approval Processes view.

Once the validity of the copied approval process has started, its status should be Active while the status of
the default process should be Ended.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 423
8.8.3 Business and Technical Background

8.8.3.1 Approval Process Built-In Functions

The approval process built-in functions are only used in action script files that are created when you define an
approval process for a business object. Each action script file initially contains the call of the relevant built-in function.
The built-in functions are used to set the status of the business object and to manage related approval tasks.
Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

SendForApproval

Descriptio Requests an approval of a business object instance. If an approval is required, the system creates an approval
n task and sends it to the approver.

Example var result = this.Function::SendForApproval();

Result: Approval status “2” (Not Necessary) or approval status “3” (In Approval)

Approve

Descriptio Approves a business object instance and its related tasks.

n

Example var result = this.Function::Approve();

Result: If this approval task is the last step of an approval process, the result is approval status “4” (Approved),
otherwise the approval status is “3” (In Approval).

Reject

Descriptio Rejects a business object instance and its related tasks.

n

Example this.Function::Reject();
Result: Approval status “5” (Rejected).

SendBackForRevision

Descriptio Sends an approval task back to the requester to revise it.

n

Example this.Function::SendBackForRevision();
Result: Approval status “6” (In Revision).

SAP Cloud Applications Studio – Version May 2018 (1805)

424 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Withdraw

Descriptio Withdraws an approval request for a business object instance.

n

Example this.Function::Withdraw();
Result: Approval status “7” (Withdrawn).

8.8.3.2 Approval Process

Overview
The studio allows you to create a default approval process for a custom business object. You define at least one
approval step and, optionally, approval and rejection notifications as well as a revision task. Once the default approval
process has been activated, you assign the tasks to the UI. In the SAP cloud solution, an administrator can then add
multiple approval steps, define conditions, and change the validity of the approval process. The participants of the
process receive tasks and notifications informing them of required actions or the process status.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Features
You create the approval process in the studio. For more information, see Create an Approval Process [page 427].
When you activate the approval process, the following objects are created and added to the custom business object
in the Solution Explorer:
● Approval process definition including tasks
● Action script files
● Task execution UIs

Approval Task Types

When you define the approval process, you can create the following tasks:
● Approval (default — mandatory)
Informs the person responsible about a business document requiring approval.
● Notification (approval/rejection — optional)
Informs the employee who started the approval process that the business document has been approved or
rejected.
● Revision (optional)
Informs the employee who started the approval process that the person responsible for approval asks for
changes to the business document.

Action Script Files

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 425
When you activate the approval process, the following action script files are generated:
● SubmitForApproval
● Approve
● Reject
● SendBackForRevision
● WithdrawFromApproval

The following table shows the different status changes caused by the action script files listed above. The default
implementation of these actions uses built-in functions for changing the approval status and managing related
approval tasks. You can change the default implementation in the relevant script files, for example, by adding
messages or logic.

Approval Process Status Action New Approval Process Status

Not Started SubmitForApproval ● In Approval

● Approval not Necessary

In Approval WithdrawFromApproval Withdrawn

SendBackForRevision In Revision

Reject Rejected

Approve ● In Approval
● In Approval

Withdrawn SubmitForApproval ● In Approval

● Approval not Necessary

In Revision SubmitForApproval ● In Approval

● Approval not Necessary

Rejected — —

Approved — —

Built-In Functions
The approval process built-in functions are only used in action script files that are created when you define an
approval process for a business object.
For more information, see Approval Process Built-In Functions [page 424].
Task Execution UIs
These screens are generated automatically when you activate the approval process. They are used to display tasks
and allow the execution of task-related actions. In a manual step, you assign the approval tasks to the UI to see the
tasks and notifications in a work center of the cloud solution. For more information, see Assign Approval Process
Tasks to UI [page 429].
Approval Process in the Cloud Solution
The default approval processes you create in the studio always have one approval step, no conditions, and an
unlimited validity. In the SAP cloud solution, administrators can copy and adjust the default approval process to
meet their specific process requirements, for example:
● Create addition sequential or parallel approval steps
● Control the relevance of approval steps by adding conditions

SAP Cloud Applications Studio – Version May 2018 (1805)

426 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 A typical example is that an approval step is only required, if an amount defined in the custom business object
exceeds a certain value.
● Adjust the validity of an approval process

8.8.4 Tasks

8.8.4.1 Create an Approval Process

In the studio, you define one approval process per business object in the root node. An approval process contains
at least one approval task and can have notifications and a revision task. For each task type, you define the task
recipients by selecting elements from the custom business object. Further, you can select business object elements
that an administrator can use to define approval step conditions in the SAP cloud solution.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Prerequisites
● You have activated the business object for which you want to create the approval process. For more
information, see Business Objects Quick Guide [page 346].

● For SAP Cloud for Customer and SAP Cloud for Travel and Expense users, you have created an enterprise
query. For more information, see Step 3 under Procedure in Create a Query [page 363].

Procedure
1. In the Solution Explorer, right-click the business object and select Create Approval Process.

You can only create one approval process for a custom business object.

The Approval Wizard opens.

2. In the Define Task Properties step, do the following:
a. Enter a name in the Name of Approved Status Field field.
The field is added to the business object during activation and is used to store and display the approval
status.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 427
 Do not change the approval status field.

b. Under Task Types, the Approval checkbox is preselected.

If you select Notification, a notification is generated to inform the employee who started the approval
process (requestor) that the request has been approved or rejected.
If you select Revision, a revision task is generated to inform the requestor that the approver has
suggested changes to the request.
c. Click Next.
3. In the Define Task and Notification Texts step, proceed as follows:
Enter the Subject and Description texts for each task and notification to display to the recipients.
The description should contain instructions describing how to complete the task. It can contain parameters
that will be replaced by values from the business object at run time. Parameters are denoted by an ampersand
(&) before and after the parameter name. To include parameters in the text, do the following:
a. Enter a free text in the Subject and Description fields and then place the cursor at the position you want
the parameter to appear.
b. Click Add Parameter.
The Parameters dialog opens.
c. In the Parameter field, enter a name for the parameter, for example Approver.
d. In the same row, click the ... button.
The Select Business Object Element dialog opens.
e. Select a business object element that you want to include in the text and click OK.
f. Click OK to close the Parameters dialog.
If you have defined a parameter for one of the tabs, you can select it again for the other tabs in the
Parameters dialog and do not have to define it again.
g. Repeat the steps above on the other tabs and click Next.

The Approval Notifications, Rejection Notifications, and Revision tabs are only displayed, if you
have selected the Notification and Revision options in the previous step.

4. In the Select Task and Notification Recipients step, proceed as follows:

a. Enter a description of the person responsible and select a business object (BO) element by clicking
the ... button. Select one of the BO elements and click OK.
You can select the BO elements from the root node as well as from another node of the business object.
In the BO Element field, the complete path to the element is displayed.

● You can select BO elements of type UUID or EmployeeID, or fields generated by

associations.
● The elements must be taken from the business object for which the approval process is
defined. You cannot refer to elements in another business object using an association.

b. Repeat the steps for the other tasks you created.

You can define various approval tasks for a multistep approval process but only one approval
notification, one rejection notification, and one revision task. If you define several approval steps, one
of the approval tasks has to be defined as default.
c. Click Next.
5. In the Select Fields for Conditions step, proceed as follows:

SAP Cloud Applications Studio – Version May 2018 (1805)

428 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 a. Select the business object elements that can later be used by the customer's administrator to define
conditions.
b. Click Next.
6. Check the Review screen and click Finish.
In the Solution Explorer, a process definition with the file extension .approvalprocess appears. The system
also creates action script files (.absl) and .uicomponent files.

The system creates one .uicomponent file per task type. If, by accident, one or
various .uicomponent files are deleted, you can recreate them. To do this, right-click
the .approvalprocess file and select Create Task Execution UIs.

7. To activate the approval process, right-click the .approvalprocess file and select Activate.
8. Right-click your solution and select Deploy Business Configuration.

Result
The default approval process is created. Due to technical background processes, it takes some time until the default
approval process appears in the SAP cloud solution. In the UI designer, you assign the approval process tasks to the
UI. This ensures that the tasks are displayed in the cloud solution and that an administrator can use them to define
an approval process. For more information, see Assign Approval Process Tasks to UI [page 429].

8.8.4.2 Assign Approval Process Tasks to UI

You assign the approval process tasks to the UI to make the tasks and notifications visible in a work center of the
SAP cloud solution.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Prerequisites
You have created an approval process in the studio for the SAP cloud solutions. For more information, see Create
an Approval Process [page 427].

Procedure
1. In the Solution Explorer, do the following:
The .uicomponent files are generated and displayed in the Solution Explorer.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 429
 a. Right-click the business object, select Create Screens and choose to create a screen scenario.
b. Enter a Short ID to identify your screen in the UI designer and in the SAP cloud solution.
The Short ID is generated as follows: [Technical name of solution]_[Short ID]_WCVIEW. If you have
also created a thing type floorplan, an additional Short ID is generated: [Technical name of
solution]_[Short ID]_TT.

Right-click the solution and, in the Property Explorer in the Project File field, look up the name of the
solution and note it down.

2. Right-click the work center view file (.uiwocview) and select Open in UI Designer.
3. In the Property Explorer, under RBAMData, select AssignedObjects.
4. Click the ... button.
The Add AssignedObjects dialog opens, where you proceed as follows:
a. Click the Add Row button.
b. In the new row, under AssignedObject Type, click the down arrow button and select TaskListView.
c. In the same row, under ComponentID, click the ... button.
The Select Component dialog opens.
d. In the folder for your solution ( [solution name]_MAIN SRC ), select the .approval file and click
OK.
Repeat steps a) to d) for the .notification and .revision files, if there are any.
e. If you have created a notification and/or revision task, click the Add Row button again.
f. In the new row, under AssignedObject Type, do not change the Navigation Target option.
g. In the same row, under ComponentID, click the ... button.
The Select Component dialog opens.
h. In the folder for your solution ( [solution name]_MAIN SRC ), select the ApprovalUI
(APP1.QA.uicomponent) file and click OK.
Repeat steps e) to h) for the NotificationUI and RevisionUI file and close the UI designer.

Result
You can now log on to the SAP cloud solution and see the default approval process you created in the Approval
Processes view.

For any user to be able to view the approval process tasks in the UI, you must give the user access rights to
the relevant work center to which the tasks are assigned. Once this is done, select Administration in the
Solution Explorer, and click on Update Authorizations and Access Rights to refresh the access right permissions.

See Also
Test the Approval Process [page 431]

SAP Cloud Applications Studio – Version May 2018 (1805)

430 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.8.4.3 Test the Approval Process

After assigning the approval process tasks to the UI, you can test the approval process you have created in the SAP
cloud solution.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Prerequisites
● You have added the approval tasks to the UI. For more information, see Assign Approval Process Tasks to UI
[page 429].
● You have a business user in the SAP cloud solution with access rights for the Application and User
Management work center.

Procedure
1. Log on to the SAP cloud solution using your business user and choose Application and User
Management Approval Processes .
2. Select your default approval process, which has the same name as your custom business object, and click
Copy.
3. In the copied approval process, adjust the name in the Process Name field.
4. Enter a number in the Step field and a name in the Process Step Name field.
5. In the Work Distribution field, select the person responsible for this task.
6. Repeat the steps to create further approval steps. Click New and select Task, Notification, Alert, or Clarification
Request, as required.

The clarification request corresponds to the revision task selected in the studio.

7. Under Conditions, click Add Group, and in the Edit Conditions dialog, add one or more conditions.
8. Click Edit Validity to adjust the validity of the approval process and click Save and Close.

● The Valid To Date of the default approval process must be the same as the Valid From Date of
the copied approval process.
● The copied approval process must have an unlimited validity.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 431
Example

Field Entry

Process Name Approval Process

Step 1

Process Step Name Manager Approval (Approval Step 1)

Work Distribution Manager (Approver 1)

Step 2

Process Step Name Account Manager Approval (Approval Step 2)

Work Distribution Account Manager (Approver 2)

For more information, see the approval process documentation in the SAP cloud solution.

8.9 Notification Rules

8.9.1 Enable Notification Rules

In SAP’s cloud solutions, notification rules can be defined by customers to receive a notification in case a certain
situation occurs for a business object. Typical examples are status changes of business objects or the exceeding of
threshold values. The notifications only serve as information and do not trigger automatic actions or tasks.
If a customer wants to use notification rules with a custom business object, you as a partner need to enable the
business object for notification rules in the studio: In the Notification Rules Wizard, you select business object fields
that can be used as placeholders, conditions, and recipients.
After you have enabled the custom business object for notification rules, your customer can create notification rules
for the business object in the cloud solution.
For more information, see the "Notification Rules Quick Guide" in the documentation of the SAP cloud solution.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Prerequisites
● You have activated the custom business object for which you want to enable notification rules. For more
information, see Business Objects Quick Guide [page 346].

SAP Cloud Applications Studio – Version May 2018 (1805)

432 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
If you want to use thing-based navigation with your solution, the following prerequisites apply:
● You have created a thing-based screen scenario. For more information, see Generate Screens for a Business
Object [page 370].
● You have created a query. In the Query Wizard, in the Create a Query step, you have selected the Include in
Enterprise Search option. For more information, see Create a Query [page 363].

To be able to select the Include in Enterprise Search option, you need to define a Date/Date Time
field in your custom business object.

Procedure
1. In the studio, in the Solution Explorer, right-click the custom business object and select Enable Notification
Rules.
The Notification Rules Wizard opens.

You can use this process only once per custom business object.

2. In the wizard, in the Define Fields for Placeholders and Conditions step, do the following:
a. Select the business object elements to be used as fields for placeholders and conditions in notification
rules.

● For the placeholders, you can use business object elements defined in the root node or
in [1,1] associated nodes.
● For the conditions, you can use business object elements from the root node and from
[1,n] associated nodes.
● You can only use data types with the following representation terms:

amount description measure quantity

code duration name text

date identifier numeric time

date/time indicator percent value

To find out the representation term of a data type, call up the relevant data type in the
Repository Explorer. For more information, see Look Up the Representation Term of a
Data Type [page 91].

b. Click Next.
3. In the Define Labels for Placeholders and Condition Fields step, you can adapt the field labels. Click OK.

Do not leave the field label blank or use identical labels for different fields; field labels must be unique.

4. In the Define Recipients step, select the recipients to be used in notifications:

a. In the Description field, enter a description for the recipient, for example, Manager or Requestor.
b. In the Business Object Element field, click the ... button.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 433
 c. Select a business object element that you want to use as recipient and click OK.

● You can select business object elements of type UUID or EmployeeID, or fields generated
by associations.
● The elements must be taken from the business object for which the approval process is
defined. You cannot refer to elements in another business object using an association.

d. Click Next.
5. In the Review step, review your entries and click Finish.
6. In the Solution Explorer, a [business object name].notification file ( ) is created. Right-click the
file and select Activate.
7. Right-click your solution and click Deploy Business Configuration.

Result
You have enabled the custom business object for notification rules. Your customer can now define a notification rule
in the cloud solution. For more information, see the “Notification Rules Quick Guide” in the documentation of the
SAP cloud solution.
In maintenance mode, the following restrictions apply:
● Delivered fields cannot be deselected as they may have been used in notification rules by customers.
● Delivered fields cannot be renamed.

See Also
Example: Enable Notification Rules (Price Request) [page 434]

8.9.2 Example: Enable Notification Rules (Price Request)

Use Case
A sales representative creates a price request to negotiate the contract pricing for an account. If the price request
amount exceeds USD 50,000, the responsible manager and account manager want to receive a notification.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

SAP Cloud Applications Studio – Version May 2018 (1805)

434 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Prerequisites
● You have a studio developer user and a business user for the SAP cloud solution. For more information, see
User Setup Quick Guide [page 31].
● In the SAP cloud solution, the Notification Rules work center view is assigned to your business user.
● You have created a solution. For more information, see Create a Customer-Specific Solution [page 165].

In the studio, create a business object and enable it for notification rules.
1. To create a business object in the studio, in the My Solutions window, open your solution.
2. In the Solution Explorer, right-click your solution and select Add New Item.
3. In the Add New Item dialog box, select the Business Object template, enter a name for your business object
(for example, PriceRequest.bo), and click Add.
A new item with the file extension .bo appears in the Solution Explorer and the business object editor opens.
4. In the editor, enter the following coding:
import AP.Common.GDT as apCommonGDT;
businessobject PriceRequest {
[Label("Price Request ID")] [AlternativeKey]element PriceRequestID : ID;
[Label("Account ID")]element AccountID : BusinessPartnerInternalID;
[Label("Product ID")]element ProductID : ProductID;
[Label("Description")]element Description : MEDIUM_Description;
[Label("Price")]element Price : Amount;
[Label("Discount")]element Discount : Percent;
[Label("Requestor")]element Requestor : ID;
[Label("Manager")]element Manager : EmployeeID;
[Label("Account Manager")]element AccountManager : ID;
node Documentation [0,n] {
[Label("Price Type")]element PriceType:PriceDetailLevelCode;
[Label("Price Description")]element Description :MEDIUM_Description;
}
}
5. Save and activate the business object.
6. In the Solution Explorer, right-click your business object and select Enable Notification Rules.
The Notification Rules Wizard opens.
7. In the wizard, in the Define Fields for Placeholders and Conditions step, select the following business object
elements: Price Request, Product ID, Price Amount, and the Documentation node and click Next.
8. In the Define Labels for Placeholders and Condition Fields step, you can adapt the field labels. Click OK.
9. In the Define Recipients step, select the recipients to be used in the notification (Account Manager and
Manager):
a. In the Description field, enter a description for the recipients.
b. In the Business Object Element field, click the ... button.
c. Select the business object elements and click OK, then click Next.
10. In the Review step, review your entries and click Finish.
11. In the Solution Explorer, a [business object name].notification file ( ) is created. Right-click the
file and select Activate.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 435
 12. Right-click your solution and select Deploy Business Configuration.
You have enabled the custom business object for notification rules. Now, you can define a notification rule in
the SAP cloud solution.

In the SAP cloud solution, define a notification rule for the business object.
1. Log on to the SAP cloud solution with a business user. In the Application and User Management work center,
choose Notification Rules and then New
The Notification Rules guided activity opens.
2. In the Enter Basic Data step, proceed as follows:
a. Enter a description (for example, Price Request) and select the business object you created.
b. Enter a subject for the notification (for example, Price Request &1 for Product &2 with Price
&3).
c. Define your business object elements as placeholders (&1 = Price Request ID, &2 = Product
ID, &3 = Price) and click Next.
3. In the Define Conditions step, proceed as follows:
a. Click Add Row.
b. In the Edit Condition dialog, make the following entries:

Field Price

Compare Operator Greater than

With Value 50,000 USD — US Dollar

c. Click OK and Next.

4. In the Define Recipients step, proceed as follows:
a. You can define an employee as recipient of the notification by clicking Add Employee.
b. To select the recipients you defined in the studio (Manager, Account Manager), click Add
Determination and Next.
5. In the Review step, review your entries and click Activate, and then Finish.
6. In the Confirmation step, you can create a new notification rule or click Close.

Result
You have now created a notification rule including conditions and recipients. When the conditions are met, a
notification is sent to the recipients.

See Also
Enable Notification Rules [page 432]

SAP Cloud Applications Studio – Version May 2018 (1805)

436 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.10 Print Forms

8.10.1 Print Forms Quick Guide

You can create a print form to output the data from a business object that you created in your solution. You can
define the data to include on the form, design the layout of the form, and select a floorplan to link to the form. Print
forms are read-only portable document format (PDF) documents that are generated from data stored in the system.
In the SAP cloud solution, print forms can be printed, sent as an e-mail attachment, or faxed to business partners.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Business and Technical Background

Business Objects
As part of your solution, you can create new business objects. For more information, see Business Objects Quick
Guide [page 346].

Tools for Form Templates

In the SAP cloud solution, customers use form templates to define the content and layout of documents that can be
output from the system. For information about how customers work with the tools for form templates, see the
following quick guides in the relevant SAP cloud solution:
● Form Template Maintenance Quick Guide
● Form Template Selection Quick Guide

Tasks

Create a Print Form

You can create a print form to output the data from a business object. You use Adobe LiveCycle Designer to define
the data you want to include on the form and design the layout of the form.
For more information about creating a print form, see Create a Print Form [page 438].

Create a Preview Button for a Print Form

You can create a Preview button and link it to a print form. Clicking the Preview button allows you to preview the form
as a PDF file and provides options to either save or print the form.
For more information about creating a preview button, see Create a Preview Button for a Print Form [page 632].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 437
Test a Print Form
You can test the print form in the preview after deploying the business configuration content of your solution.
For more information about testing a form, see Test a Print Form [page 439].

8.10.2 Associating an .xdp File with Adobe LiveCycle Designer

Procedure
1. In Windows, select Control Panel All Control Panel Items Default Programs .
2. Select Associate a file type or protocol with a program.
3. In the list, select the .xdp file type and select Change program....
4. Select Browse and then the FormDesigner.exe file in the folder where you installed the Adobe LiveCycle
Designer program files. Click Open.
5. Make sure that the Adobe LiveCycle Designer ES entry and the Always use the selected program to open
this kind of file checkbox are selected. Click OK.
When you now double-click an .xdp file to open it, the file opens in Adobe LiveCycle Designer.

8.10.3 Create a Print Form

You can create a print form to output the data from a business object. You use Adobe LiveCycle Designer to define
the data you want to include on the form and design the layout of the form.

Prerequisites
● Your solution contains an activated business object with at least one element.
● You have installed Adobe LiveCycle Designer.
● You have associated the .xdp file type with Adobe LiveCycle Designer.
For more information, see Associating an .xdp File with Adobe LiveCycle Designer [page 438].

Procedure
1. In the Solution Explorer, right-click the business object and select Create Print Forms.
The Form Wizard opens.
2. In the Define Form Properties step, under Basic Information, you can select a different business object.
3. Under Form Template Header, do the following:
● Optional: Change the name of the form template header.
● Enter a description for the form template header.
4. Under Form Template Group, select a form template group (if available) or click New to create a new group.
5. If you selected New, in the Form Template Editor window, accept the default name or change the name of the
group in the Name field, click Save, and then click Next.

SAP Cloud Applications Studio – Version May 2018 (1805)

438 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 6. In the Define Form Data Structure step, the data structure of the business object is displayed. Select the data
elements you want to include on the form, and then click Next.
7. In the Define Properties of Default Variant step, enter a Comment to describe this form and select a
Language.
You can select one of the languages in which the SAP cloud solution is available.
8. Click Next.
A summary of the settings you entered for the form is displayed.
9. In the Review Form Settings step, click Finish.
The form is opened in Adobe LiveCycle Designer.

If Adobe LiveCycle Designer does not open and an error message is displayed instead, make sure
that you have associated the .xdp file type with Adobe LiveCycle Designer. For more information,
see Associating an .xdp File with Adobe LiveCycle Designer [page 438].

10. To create your form, drag data elements from the Data View on the left to the Design View on the right.

You may need to enlarge the left pane to see the Data View tab.

11. Once you have designed the form, save your work and close Adobe LiveCycle Designer.
For more information about using Adobe LiveCycle Designer, see the Adobe product documentation.
12. In the Solution Explorer, right-click the form group file (.ftgd, ) and select Check In Content. Once the
check-in is complete, right-click the file and select Activate.

Results
● A print form is associated with the business object. You now need to make the form accessible to users from
a floorplan. For more information about how to enable a preview function that allows users to preview the
form as a PDF and provides options to save or print the form, see Create a Preview Button for a Print Form
[page 632].
● You can now test your print form. For more information, see Test a Print Form [page 439].

See Also
Print Forms Quick Guide [page 437]

8.10.4 Test a Print Form

You can test the print form in the preview after deploying the business configuration content of your solution.

Prerequisites
You must be assigned the Business User role and have access rights for the Business Configuration work center.
For more information, see User Setup Quick Guide [page 31].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 439
Procedure
1. Perform Business Configuration Deployment
There are two ways to deploy your business configuration content: Either you scope the BAC elements defined
in your solution in the Business Configuration work center of the SAP cloud solution or you select the Deploy
Business Configuration function in the context menu of the your solution.
● If you have created BAC elements in your solution and assigned your solution content to a business
option, you can perform scoping manually in the Business Configuration work center of the SAP cloud
solution.
For more information, see "Configuring your SAP Solution" in the documentation in your SAP cloud
solution.
● Alternatively, you can trigger the deployment of business configuration in the Solution Explorer by
right-clicking the solution and selecting Deploy Business Configuration.

When you use the Deploy Business Configuration function, the studio deploys all business
configuration content of your solution. However, you cannot test partial activation of business
configuration content in the development environment because the Deploy Business
Configuration function deploys all business configuration content independently of any
business options you have created.

2. Test the Print Form

a. In the Solution Explorer, right-click the floorplan and click Preview Screen.

If this is the first time you have selected this option, you may be prompted to enter a user name
and password.

A preview of the screen is displayed.

b. On the screen, enter some values in the fields and click Save.
c. Click Preview.

If more than one template exists, a list of available templates is displayed in the Preview window.
Select a template and click Open.

A preview of the selected print form is displayed as a PDF.

8.11 Analytics

8.11.1 Analytics Quick Guide

Analytics in the cloud solution allows customers to support and monitor business processes and thus enables them
to make informed decisions. The standard system provides predefined analytics content that is presented in reports.
The data from key figures and characteristics in a data source or a key figure group serves as the basis of these
reports. Administrators can design reports that they can make available to other users. Users can then access these
reports from the Reports work center view of the corresponding work centers or from the Overview work center
views.

SAP Cloud Applications Studio – Version May 2018 (1805)

440 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
In the studio, you can add data sources to a solution that administrators for Analytics can use for reporting in the
cloud solution. You can also create browser-based reports in the studio and use the administrator tools for Analytics
in the cloud solution to define the report layout and content.

Business and Technical Background

Defining Analytics Content

In the studio, you can define analytics content for custom business objects, for SAP business objects, or for a
combination of both. In the SAP cloud solution, customers use this content for reporting. Reports show the data and
values derived from key figures and characteristics in data sources, key figure structures, and key figure grids.
For more information, see here [page 444].

Data Sources
A data source is an object that provides a multidimensional, analytical view of business data. Data sources are the
basis of analytical report content and are associated with a specific access context or can be unrestricted.
For more information, see here [page 445].

Combined Data Sources

A combined data source combines data from two or more data sources that share common or similar characteristics.
For more information, see here [page 447].

Joined Data Sources

A joined data source joins data from two or more data sources that share common characteristics.
For more information, see here [page 448].

Key Figures
Fields according to which values are selected. Key figures are numeric values that have a unit of measure or currency
assigned. Examples include Invoice Net Value and Purchase Order Quantity.

Transformation Rules
You can use transformation rules to calculate fields from business object fields, for example, for date and date/time
conversions. The transformed (calculated) fields are added to the data source and can be used in reports.
For more information, see here [page 451].

Aggregation
To enable the calculation of key figures, the system can aggregate key figure values from a data source based on
defined aggregation behavior. The system aggregates key figure values for multiple characteristics. The system can
also aggregate key figure values for a specified characteristic; this is referred to as exception aggregation.
For more information, see here [page 452].

Maintenance of Analytics Content

A customer-specific solution is in maintenance mode, if it has been assembled and downloaded; the solution status
then is Assembled. You can make changes to the solution in a patch; however, you can only make restricted changes
to certain content types. These change and delete restrictions ensure that you do not make changes to a solution
that could lead to loss of data or create inconsistencies or errors on a customer's production tenant.
For information about creating a patch, see Patches [page 166].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 441
For information about the change and delete restrictions for data sources in a solution that is in maintenance mode,
see Maintenance of Analytics Content [page 453].

Business Analytics
To learn about how analytics functions are integrated in the cloud solution, see Overview of Analytics.

Tasks

Create a Data Source

In the studio, you can create a data source based on an SAP business object or a custom business object. A data
source includes specific data such as key figures and characteristics that administrators for Analytics can use for
reporting in the SAP cloud solution.
For more information, see here [page 455].

Change a Data Source

1. In the studio, open the solution that contains the data source you want to change.
2. In the Solution Explorer, double-click your data source.
The data source opens in a document window and the information you defined using the Data Source
Wizard is displayed on different tabs.
3. Make your changes and then click Save.
You cannot change the entries in the mandatory fields (Namespace, Business Object, Anchor Node, and Data
Source Name) on the Header Information tab.
The system saves your changes.

For information about the change and delete restrictions for data sources in a solution that is in maintenance
mode, see Maintenance of Analytics Content [page 453].

Delete a Data Source

1. In the studio, open the solution that contains the data source you want to delete.
2. In the Solution Explorer, right-click the data source and select Delete.
If other project items depend on a data source, for example, if a data source is used in a report or a joined
data source, you cannot delete this data source. To delete the data source, you must first delete any
dependent project items.

For information about the change and delete restrictions for data sources in a solution that is in maintenance
mode, see Maintenance of Analytics Content [page 453].

Create a Combined Data Source

In the SAP cloud solution, you can use the administrator tools for Analytics to create a combined data source that
combines data from multiple data sources.
For more information, see here [page 457].

Create a Joined Data Source

In the SAP cloud solution, you can use the administrator tools for Analytics to create a joined data source that joins
data from multiple data sources that share common characteristics.

SAP Cloud Applications Studio – Version May 2018 (1805)

442 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
For more information, see here [page 459].

Create a Key Figure

In the SAP cloud solution, you can use the administrator tools for Analytics to create a key figure based on an SAP
data source or based on a data source you have created (custom data source). This key figure can then be used in
a report. There are two types of key figures: A calculated key figure is determined using calculation rules or formulas
and a restricted key figure is restricted to a specified characteristic value.
For more information, see here [page 462].

Create a Report
In the studio, you can create reports by using data sources that you have created. You can then define the report
and the report layout in the SAP cloud solution by using the administrator tools for Analytics.
For more information, see here [page 460].

Manage Reports
1. In the Solution Explorer, right-click your data source and select Manage Reports.
The logon screen of the cloud solution opens in your browser.
2. Enter the user name and password that you entered when logging on to the repository.
A report list opens and displays the reports assigned to your data source.
3. Optional: Change the content and layout of a report by doing the following:
● To change the report definition, click Edit With and then select Report Wizard.
● To change the report layout, click Edit With and then select Web Browser.

Change a Report Created in an Earlier Release

When you maintain a report that you created in an earlier release of your solution, you must ensure that the report
has the same technical ID in all later releases to ensure that multiple versions of the report do no exist with different
IDs and that all analytics content created by customers, for example, the field names of a data source, still has valid
references. To change the technical ID, you must find out the technical ID that the system assigned to the initial
version of your report and manually assign this ID to the report in the current release. To do this, do the following:
1. Open the initial version of your report in the development environment of the cloud solution and find the
technical ID of the report by doing the following:
a. In the Solution Explorer, right-click the data source on which your report is based and select Manage
Reports.
The logon screen of the cloud solution opens in your browser.
b. Enter the user name and password that you entered when logging on to the repository with your
Developer user role.
The Design Reports view opens and displays the reports assigned to the data source including your
report.
c. Select your report, click Edit With and then select Report Wizard.
The Report Wizard opens and displays the Define Report and Select Data Source step.
d. At the top right of the screen, click Personalize and select This Screen.
The Personalize panel opens.
e. Under Sections, select Report and make sure that the Visible option is selected.
f. Under Fields, find the Technical ID field and select the Visible option.
g. Save your changes and close the Personalize panel.
The screen now displays the technical ID of the report. Make a note of the ID.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 443
 2. Open your report in the current release of your solution and repeat the steps described above to personalize
the screen of the Define Report and Select Data Source step.
3. Overwrite the ID displayed in the Technical ID field with the ID of the initial version of your report and save
your changes by clicking Finish .
The technical ID of the report is now the same in the initial release and in the current release of your solution.

8.11.2 Business and Technical Background

8.11.2.1 Defining Analytics Content

Overview
In the studio, you can define analytics content for custom business objects, for SAP business objects, or for a
combination of both. In the SAP cloud solution, customers use this content for reporting. Reports show the data and
values derived from key figures and characteristics in data sources, key figure structures, and key figure grids.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Prerequisites
● You have created and opened a solution in the studio. For more information, see Create a Customer-Specific
Solution [page 165].
● You understand how administrators design reports in the SAP cloud solution. For more information, see
Overview of Analytics.
● You are assigned the Developer user role and have access rights for the Business Analytics work center. For
more information, see User Setup Quick Guide [page 31].

Process Flow
1. You create a data source.
● In the studio, you add a data source to your solution and define the data source. For more information,
see Create a Data Source [page 455].
You must activate the data source to make it available in the SAP cloud solution so that you can use it
for your report content.
● You use the administrator tools for Analytics in the SAP cloud solution to create a combined data source
or a joined data source.

SAP Cloud Applications Studio – Version May 2018 (1805)

444 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 For more information, see Create a Combined Data Source [page 457] and Create a Joined Data Source
[page 459].
2. In the studio, you add a report to your solution.
You must enable the admin mode in the studio so that the system saves all reports and report views you
create in your solution.
For more information, see Create a Report [page 460].
3. in the SAP cloud solution, you define your report and the report layout in the Design Reports view of the
Business Analytics work center.
For more information, see the relevant documentation of the SAP cloud solution.
4. Optional: In the studio, you create a work center and a work center view to which you want your report to be
assigned; then, in the UI designer, you:
a. Add the work center view to the work center.
b. Assign a stable anchor to the work center view to which you want your report to be assigned.
For more information, see Define an Anchor for a Floorplan [page 650] and Anchors [page 654].
You must assign this anchor so that administrators can assign reports to this work center view in the
SAP cloud solution.
c. Add the List and Gallery standard reports list views to your work center. These views list all reports that
are assigned to the views of the work center.
For more information, see Add a Report List View to a Work Center [page 648].
5. In a customer's production system, an Analytics administrator assigns the report to the work center view to
make it available for business users.

Only administrators for the SAP cloud solution working in a customer's production system can assign
a report that you have created to a work center view. To assign a report to a work center view, the
solution that contains the report must therefore be implemented in the customer's production system.
We recommend that you provide information about the work center views to which customers need
to assign reports in your Solution Documentation. For more information, see Documentation Types in
Cloud Solutions from SAP [page 709].

See Also
Analytics Quick Guide [page 440]

8.11.2.2 Data Sources

Overview
A data source is an object that provides a multidimensional, analytical view of business data. Data sources are the
basis of analytical report content and are associated with a specific access context or can be unrestricted.
For information about access contexts, see User and Access Management under Access Restrictions.
Data sources contain the following objects:
● Key figures
Fields according to which values are selected. Key figures are numeric values that have a unit of measure or
currency assigned. Examples include Invoice Net Value and Purchase Order Quantity.
● Characteristics

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 445
 Fields according to which values are selected. Characteristics are alphanumeric, numeric, or text values.
Examples include Product ID, Supplier, and Purchase Order Status. Variables are often associated with
specified characteristics. Variables restrict characteristics to one or more specified value selections.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Working with Data Sources in the Studio

In the studio, you can create a data source based on an SAP business object or a custom business object. A data
source includes specific data such as key figures and characteristics that administrators for Analytics can use for
reporting in the SAP cloud solution.
When you define a data source, you select the relevant fields from your business objects, from SAP business objects,
or from a combination of both. You can join the fields of multiple business objects by using associations. The system
supports [1..1] associations with a foreign-key relationship.
Optionally, you can:
● Define transformation rules.
For more information, see Transformation Rules [page 451].
● Reference other data sources.
● Define aggregation rules to summarize key figures (Summation, Minimum, Maximum, Count) in a report using
characteristics.
For more information, see Aggregation [page 452].

The studio supports read access across deployment units in data sources. You can use cross-deployment-unit
associations to access the data in business objects that are not assigned to the default deployment unit of your
solution. For more information, see Syntax for Business Object Definitions [page 174] under Deployment Unit.

Working with Data Sources Using the Administrator Tools of the SAP Solution
You can join or combine data from different data sources that share common characteristics and contain
semantically different key figures. For more information, see Combined Data Sources [page 447] and Joined Data
Sources [page 448].

Overview of SAP Data Sources

For information about the SAP data sources available in the different application areas, see Data Sources. In addition
to the available data sources, this information also gives an overview of the available key figure groups and common
characteristics and key figures for data sources by area.

See Also
Analytics Quick Guide [page 440]

SAP Cloud Applications Studio – Version May 2018 (1805)

446 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Create a Data Source [page 455]
Create a Combined Data Source [page 457]
Create a Joined Data Source [page 459]

8.11.2.3 Combined Data Sources

Overview
A data source is an object that provides a multidimensional, analytical view of business data. Data sources are the
basis of analytical report content and are associated with a specific access context or can be unrestricted.
A combined data source combines data from two or more data sources that share common or similar characteristics.

Depiction of a Combined Data Source

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Use
In the SAP cloud solution, you can use the administrator tools for Analytics to create a combined data source that
combines data from multiple data sources.
When you build a report using a combined data source, all characteristic values are displayed along with any key
figure values.
You usually combine data sources that have the semantically similar characteristics. However, you can also combine
data sources when the characteristics you require for a report are not available in one data source.
The following example shows a result set of a combined data source.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 447
Example of a Result Set of a Combined Data Source

See Also
Analytics Quick Guide [page 440]
Create a Combined Data Source [page 457]

8.11.2.4 Joined Data Sources

Overview
A data source is an object that provides a multidimensional, analytical view of business data. Data sources are the
basis of analytical report content and are associated with a specific access context or can be unrestricted.
A joined data source joins data from two or more data sources that share common characteristics.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

SAP Cloud Applications Studio – Version May 2018 (1805)

448 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Use
In the SAP cloud solution, you can use the administrator tools for Analytics to create a joined data source that joins
data from multiple data sources that share common characteristics.
When you build a report using a joined data source, the characteristic values that match in the joined characteristics
in the data sources are displayed along with the values that are in the same row.
Joined data sources can have more than one join. A join is created when a characteristic is available in a data source
that is an anchor. By default, the first data source you select is the anchor. The more joins there are in a joined data
source, the more restricted the data is that is available for reports.

Join Types
There are different types of joins between data sources. You select a join type depending on your business
requirements.

The anchor is displayed for both join types in the system but only affects the data in a joined data source that
uses a left outer join.

Inner Join
An inner join selects only those characteristic values from the data sources to be joined that match in the joined data
source field along with any key figure values. Characteristic values in the joined data source fields that do not appear
in both data sources are excluded from the joined result set.

Depiction of an Inner Join

The following example shows a result set of a joined data source that uses an inner join.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 449
Example of a Result Set of a Joined Data Source That Uses an Inner Join

Left Outer Join

A left outer join selects all characteristics values from the data source that is selected as the anchor and those
characteristic values that match in the data sources that are added along with any key figure values. By default, the
first data source that you select is the anchor.

Depiction of a Left Outer Join

Setting the anchor to a different data source affects the values available because the joined data source fields
may also change.

Depiction of an Anchor Change

The following example shows a result set of a joined data source that uses a left outer join.

SAP Cloud Applications Studio – Version May 2018 (1805)

450 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Example of a Result Set of a Joined Data Source That Uses a Left Outer Join

See Also
Analytics Quick Guide [page 440]
Create a Joined Data Source [page 459]

8.11.2.5 Transformation Rules

Overview
You can use transformation rules to calculate fields from business object fields, for example, for date and date/time
conversions. The transformed (calculated) fields are added to the data source and can be used in reports.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Use
Business objects often contain date and date/time information, for example, for the release of an order. In reports,
you normally want to aggregate data in time buckets, for example, to view the orders per month. For this purpose,
you could define a DateToMonth or DatetimeToMonth transformation rule. As a result, the system adds a new field
to the data source that contains only the month of the release datetime field. In a report, you can then easily
aggregate the order data by using the month field.
You select transformation rules in the Data Source Wizard. For information about how to create a data source using
the Data Source Wizard, see Create a Data Source [page 455].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 451
Available Transformation Rules
Transformation rules are only available for fields of the data types GLOBAL_DateTime, Date, and the Name,
Description, and Text data types, which represent character strings.

Transformation Rules for Date/Time Fields (GLOBAL_DateTime Data Type)

Rule Description

DatetimeToTime Selects and retrieves only the time from a datetime field.

DatetimeToDay Selects and retrieves only the day from a datetime field.

DatetimeToDate Selects and retrieves only the date from a datetime field.

DatetimeToCalendarweek Calculates the calendar week of a datetime field.

DatetimeToMonth Selects and retrieves only the month from a datetime field.

DatetimeToQuarter Calculates the quarter of a datetime field.

DatetimeToYear Selects and retrieves only the year from a datetime field.

DatetimeToYearmonth Selects and retrieves only the year and month from a datetime field.

DatetimeToYearquarter Calculates the year and quarter of a datetime field.

DatetimesToDuration Calculates the number of days between two datetime fields. *

Transformation Rules for Date fields

Rule Description

DateToMonth Selects and retrieves only the month from a date field.

DateToYearmonth Selects and retrieves only the year and month from a date field.

DatesToDuration Calculates the number of days between two date fields. *

Transformation Rules for String Fields

Rule Description

Concatenate Concatenates two string fields. *

* To use this transformation rule, you must select a second field.

8.11.2.6 Aggregation

Overview
To enable the calculation of key figures, the system can aggregate key figure values from a data source based on
defined aggregation behavior. The system aggregates key figure values for multiple characteristics. The system can
also aggregate key figure values for a specified characteristic; this is referred to as exception aggregation.

SAP Cloud Applications Studio – Version May 2018 (1805)

452 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Features
The studio supports the definition of standard aggregation. You can define exception aggregation behavior in the
SAP cloud solution using the administrator tools for Analytics.

Standard Aggregation
The standard aggregation behaviors you can define in the studio are summation, minimum, maximum, and count.
For example, you can define minimum and maximum aggregation for date key figures. You define aggregation
behavior in the studio using the Data Source Wizard. For information, see Create a Data Source [page 455].

Exception Aggregation
You define exception aggregation behavior for values of a calculated key figure. The deviation to the standard
aggregation behavior is only valid in combination with a specified characteristic. You define exception aggregation
behavior in the SAP cloud solution using the Report Wizard. For information about different types of exception
aggregation behavior in the SAP cloud solution, see Exception Aggregation. For information about how to define
exception aggregation behavior for a key figure using the Report Wizard, see Create and Edit a Key Figure.

See Also
Data Sources [page 445]

8.11.2.7 Maintenance of Analytics Content

Overview
A customer-specific solution is in maintenance mode, if it has been assembled and downloaded; the solution status
then is Assembled. You can make changes to the solution in a patch; however, you can only make restricted changes
to certain content types. These change and delete restrictions ensure that you do not make changes to a solution
that could lead to loss of data or create inconsistencies or errors on a customer's production tenant.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 453
Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Change and Delete Restrictions

The following table gives an overview of the change and delete restrictions for analytics content in a solution that is
in maintenance mode. The system performs the change and delete restrictions checks when you save the data
source.

Maintenance of Data Sources

Action Allowed

Delete a data source No

Delete data source fields No

Add or delete new data source fields Yes

Change or delete transformations No

Add or delete new transformations Yes

Change the Display Name and Referenced Data Source fields of data source fields No

Change or delete aggregations No

Add or delete new aggregations Yes

Create (and delete) a new data source Yes

Delete a reference to a joined data source created by an administrator in the cloud solution Yes

Delete a reference to a combined data source created by an administrator in the cloud solution Yes

Delete a reference to a key figure created by an administrator in the cloud solution Yes

Maintenance of Reports

Action Allowed

Delete a report Yes

See Also
Analytics Quick Guide [page 440]
Lifecycle Management of Customer-Specific Solutions [page 138]
Maintenance Mode [page 170]

SAP Cloud Applications Studio – Version May 2018 (1805)

454 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.11.3 Tasks

8.11.3.1 Create a Data Source

In the studio, you can create a data source based on an SAP business object or a custom business object. A data
source includes specific data such as key figures and characteristics that administrators for Analytics can use for
reporting in the SAP cloud solution.

Prerequisites
● You have created and opened a solution in the studio. For more information, see Create a Customer-Specific
Solution [page 165].
● To create a data source based on a custom business object, you must create and activate your custom
business object.
For more information, see Business Objects Quick Guide [page 346].
● If you want to allow referencing of your data source by another data source and enable navigation from a
report to another floorplan that is not a standard UI, you must define this UI. For information, see Generate
Screens for a Business Object [page 370].

Procedure
1. In the Solution Explorer, do the following:

Custom Business Object SAP Business Object

Right-click your business object and select a. Right-click your solution and select Add New Item
Create Data Source.
The Add New Item dialog opens.
The Data Source Wizard opens.
b. Select SAP Analytics Data Source and click Add.
The Data Source Wizard opens.

2. In the Create a Data Source step, define your data source by doing the following:
a. Select a namespace.
By default, the namespace for your solution is selected; however, to create a data source based on an
SAP business object, you can select an SAP namespace.
b. Select a business object.
c. Select an anchor node to link to the data source.

● If a [1,n] association is defined for a field, the field is not displayed in the business object
hierarchy. Therefore, we recommend that you select the most detailed node as the
anchor node. For more information about associations, see Syntax for Business
Object Definitions [page 174] under Association.
● You can also select nodes of dependent objects, for example,
TextCollection.Root.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 455
 d. Enter the data source name.
e. Optional: Enter a description of the data source.
f. Optional: To allow access restrictions for data in reports based on this data source, select Enable
Access Control.
The access restrictions of the anchor business object are inherited; therefore customers can only
assign reports based on this data source to work center views with the same access control.
g. Optional: To allow referencing by another data source and allow the fields of your data source to be
used in reports based on the referencing data source, select Allow Referencing.
● If you want to allow referencing, under Reference Details, select the key field.
● Optional: Under Object Based Navigation, specify a target UI.
Users will be able to navigate from the report to this floorplan.
h. Optional: To enable read access logging for sensitive personal data, select the Log Sensitive Personal
Data checkbox.
i. Click Next.
3. In the Select Data Source Fields step, select the fields you want to include in the data source.
You can include fields from other business objects by using associations. The studio supports read access
across deployment units in data sources. You can use cross-deployment-unit associations to access the data
in business objects that are not assigned to the default deployment unit of your solution. For more information,
see Deployment (Business Object) [page 187].

Not all fields and associations modeled in the business object are supported. Only supported fields and
associations are displayed.

Click Next.
4. Optional: In the Define Transformation Rules step, define transformation rules for fields of data type text (such
as name and description), date, or GLOBAL_DataTime by doing the following:
a. In the Business Object Element area, select a field and on the Transformation tab, select a
transformation rule.
b. Define a field name for the transformation field and then press ENTER .
c. If the transformation rule allows the selection of a second parameter, next to the Parameter field,
click ... .
The Select Additional Transformation Rule Parameter dialog box opens.
d. In the Select Additional Transformation Rule Parameter dialog box, select a second parameter by
selecting a row and clicking the first cell in the row.
For information about the available transformation rules, see Transformation Rules [page 451].
e. Click Next.
5. Optional: In the Define Referenced Data Sources step, modify the parameters by doing the following:
a. Display and define the names for the selected fields that are characteristics.
b. Assign an existing data source to each parameter.

If necessary, you can change the display name for each parameter.
You can assign an existing data source if the fields of an SAP business object are already included
in an SAP data source.

c. Click Next.
6. Optional: In the Define Aggregation Behavior step, define the aggregation behavior for business object
elements that are key figures.
For more information about aggregation behavior, see Aggregation [page 452].

SAP Cloud Applications Studio – Version May 2018 (1805)

456 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 The default aggregation of every key figure is Summation. You can change the default or add new
aggregations.

7. Optional: In the Select Sensitive Personal Data Fields step include sensitive personal data fields for read access
logging by selecting the Create Log checkbox against the field. You must then include a reference for the
sensitive personal data field.

If you select a field that has transformation rules, you can include only the parent field as the reference.

8. In the Review step, check that the information you have entered is correct and then click Finish.

If you have defined aggregations, check that the selected aggregations are displayed correctly.

A new item with the file extension .ds ( ) appears in the Solution Explorer.
9. In the Solution Explorer, right-click the data source you have created and select Activate.

Result
The data source is available in SAP's cloud solution. You can check the result by logging on to SAP's cloud solution.
In the Business Analytics work center, navigate to the Design Data Source view and search for your data source.
In the studio, you can now create a report that uses your data source. For more information, see Create a Report
[page 460].
You define the report and the report layout in SAP's cloud solution in the Design Reports view of the Business
Analytics work center. For more information, see the relevant documentation of SAP's cloud solution.

8.11.3.2 Create a Combined Data Source

In the SAP cloud solution, you can use the administrator tools for Analytics to create a combined data source that
combines data from multiple data sources.
You start the process in the studio and then create the combined data source on the New Combined Data Source
screen of the Business Analytics work center. For information about combined data sources, see Combined Data
Sources [page 447] and the relevant documentation of the cloud solution.

Prerequisites
● You are assigned the Developer user role and have access rights for the Business Analytics work center. For
more information, see User Setup Quick Guide [page 31].
● You have switched on the admin mode so that the system saves the analytics content you create in your
solution. To do this, select Administration Switch On/Off Admin Mode in SAP Solution .

Procedure
1. In the Solution Explorer, right-click your solution and select Add New Item

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 457
 The Add New Item dialog opens.
2. Select SAP Analytics Combined Data Source .
3. Enter a name and click Add.
4. The SAP cloud solution opens. If you are not logged in already, the logon screen opens. Log on with your
developer user.
5. The New Combined Data Source screen opens. By default, the combined data source contains the Counter
key figure. The Counter key figure counts the number of instances of a specified object.
6. On the screen, click Add Data Source .
7. On the Add Data Source dialog screen, select a data source from the dropdown list.
The screen displays the characteristics and key figures available in the selected data source. The initial
selections serve as a basis for the combined data source. The characteristics and key figures are then
displayed in the Combined Data Source Fields column.

You can only combine data sources that have compatible access contexts. For example, you can add
a data source if the data source and the combined data source have a common access context. You
can add any data source that has an unrestricted access context to a combined data source.

8. Select one or more additional data sources and add the data sources to the combined data source.
The system checks whether the characteristics and key figures in the additional data sources are also available
in the data source that you selected as a basis for the combined data source.

If a characteristic or key figure is available in the combined data source, the system positions the
characteristic or key figure in the same row of each data source.
If a characteristic or key figure is not available in the combined data source, the system adds the
characteristic or key figure to the combined data source.

Other Functions
● Remove Data Source
The Remove Data Source dialog screen opens and displays the data sources you have added. To
remove data sources, click the relevant checkboxes.
● Add Row
Adds a row to which you can add a characteristic or key figure. The system then adds the characteristic
or key figure to the relevant field type group.
● Remove Row
Deletes the selected row.

The selected characteristic or key figure is only removed from the combined data source.

9. Save your entries.

10. In the studio, in the Solution Explorer, update your solution by clicking Refresh Solution ( ).
A .cds file ( ) appears under your solution.

Result
The combined data source is available for reporting. You can create reports using data from the combined data
source. For information about creating reports, see Create a Report [page 460].
You can delete the combined data source when your solution is in maintenance mode. For more information, see
Maintenance Mode [page 170].

SAP Cloud Applications Studio – Version May 2018 (1805)

458 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.11.3.3 Create a Joined Data Source

In the SAP cloud solution, you can use the administrator tools for Analytics to create a joined data source that joins
data from multiple data sources that share common characteristics.
You start the process in the studio and then create a joined data source on the New Joined Data Source screen of
the Business Analytics work center. For information about joined data sources, see Joined Data Sources
[page 448] and the relevant documentation of the cloud solution.

Prerequisites
● You are assigned the Developer user role and have access rights for the Business Analytics work center. For
more information, see User Setup Quick Guide [page 31].
● You have switched on the admin mode so that the system saves the analytics content you create in your
solution. To do this, select Administration Switch On/Off Admin Mode in SAP Solution .

Procedure
1. In the Solution Explorer, right-click your solution and select Add New Item
The Add New Item dialog opens.
2. Select SAP Analytics Joined Data Source .
3. Enter a name and click Add.
4. The SAP cloud solution opens. If you are not logged in already, the logon screen opens. Log on with your
developer user.
5. The New Joined Data Source screen opens.
In the Join Type field, the Inner Join option is preselected. You can also select the Outer Left Join option.
For more information, see Joined Data Sources [page 448]

By default, the joined data source contains the Counter key figure. The Counter key figure counts the
number of instances of a specified object.

6. On the New Joined Data Source screen, click Add Data Source .

You cannot join more than five data sources.

7. On the Add Data Source dialog screen, select a data source from the dropdown list.
The screen displays the characteristics and key figures available in the selected data source. The initial
selections serve as a basis for the joined data source. The characteristics and key figures are then displayed
in the Joined Data Source Fields column.
By default, the first data source you select is the anchor.
8. Select one or more additional data sources and add the data sources to the joined data source.
The system checks whether the characteristics and key figures in the additional data sources are also available
in the data source that you selected as a basis for the joined data source.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 459
 If a characteristic or key figure is available in the joined data source, the system positions the
characteristic or key figure in the same row of each data source.
If a characteristic or key figure is not available in the joined data source, the system adds the
characteristic or key figure to the joined data source.
If a characteristic is available in a data source that is an anchor, the system creates a join. The more
joins there are in a joined data source, the more restricted the data is that is available for reports.

Other Functions
● Remove Data Source
The Remove Data Source dialog screen opens and displays the data sources you have added. To
remove data sources, click the relevant checkboxes.
● Add Row
Adds a row to which you can add a characteristic or key figure. The system then adds the characteristic
or key figure to the relevant field type group.
● Remove Row
Deletes the selected row.

The selected characteristic or key figure is only removed from the joined data source.

● Check
Checks whether the joined data source is consistent.
● Set Anchor
Sets the anchor to the selected data source.
The data source that is the anchor is the basis for any joins. Depending on the type of join, changing
the anchor to a different data source can change the joined data source fields.
● Set Access Context
Sets the access context to the access context of the selected data source.
9. Save your entries.
10. In the studio, in the Solution Explorer, update your solution by clicking Refresh Solution ( ).
A .jds file ( ) appears under your solution.

Result
The joined data source is available for reporting. You can create reports using data from the joined data source. For
information about creating reports, see Create a Report [page 460].
You can delete the joined data source when your solution is in maintenance mode. For more information, see
Maintenance Mode [page 170].

8.11.3.4 Create a Report

In the studio, you can create reports by using data sources that you have created. You can then define the report
and the report layout in the SAP cloud solution by using the administrator tools for Analytics.
You can open a report that you created in the studio in the Design Reports view in the development environment with
the Developer user role. You cannot open reports in the development environment with the Business User role.

SAP Cloud Applications Studio – Version May 2018 (1805)

460 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Prerequisites
● You have switched on the admin mode so that the system saves the analytics content you create in your
solution. To do this, select Administration Switch On/Off Admin Mode in SAP Solution .
● You are assigned the Developer user role and have access rights for the Business Analytics work center. For
more information, see User Setup Quick Guide [page 31].
● You have created and activated a data source. For more information, see:
○ Create a Data Source [page 455]
○ Create a Combined Data Source [page 457]
○ Create a Joined Data Source [page 459]

Procedure
1. In the Solution Explorer, right-click your data source and select Create Report.
The logon screen of the cloud solution opens in your browser.
2. Enter the user name and password that you entered when logging on to the repository.
The Report Wizard opens.
3. Use the Report Wizard to define the report characteristics, key figures, variables, and properties; then define
the report layout.
For more information, see "Working with Reports Using the Report Wizard" in the documentation of the SAP
cloud solution.
The system displays the name of your solution. The report ID starts with the default namespace.
4. In the studio, in the Solution Explorer, update your solution by clicking Refresh Solution ( ).
A .report file ( ) appears under your solution.

Result
You have created a report in your solution and defined the report content using the data defined in your data source.
You can check which reports are defined for a particular data source. For more information, see Analytics Quick
Guide [page 440] under Manage Reports.
You can create a work center and a work center view to which you want your report to be assigned; then, in the UI
designer, you can:
1. Add the work center view to the work center.
2. Assign a stable anchor to the work center view to which you want your report to be assigned.
For more information, see Define an Anchor for a Floorplan [page 650] and Anchors [page 654].
You must assign this anchor so that administrators of the SAP cloud solution can assign reports to this work
center view.
3. Add the List and Gallery standard reports list views to your work center. These views list all reports that are
assigned to the views of the work center.
For more information, see Add a Report List View to a Work Center [page 648].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 461
 Only administrators for the SAP cloud solution working in a customer's production system can assign a report
that you have created to a work center view. To assign a report to a work center view, the solution that contains
the report must therefore be implemented in the customer's production system.
We recommend that you provide information about the work center views to which customers need to assign
reports in your Solution Documentation. For more information, see Documentation Types in Cloud Solutions
from SAP [page 709].

8.11.3.5 Create a Key Figure

In the SAP cloud solution, you can use the administrator tools for Analytics to create a key figure based on an SAP
data source or based on a data source you have created (custom data source). This key figure can then be used in
a report. There are two types of key figures: A calculated key figure is determined using calculation rules or formulas
and a restricted key figure is restricted to a specified characteristic value.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Prerequisites
● You are assigned the Developer user role and have access rights for the Business Analytics work center. For
more information, see User Setup Quick Guide [page 31].
● You have switched on the admin mode so that the system saves the analytics content you create in your
solution. To do this, select Administration Switch On/Off Admin Mode in SAP Solution .
● You have created a data source, if you want to base your key figure on a custom data source. For more
information, see Create a Data Source [page 455].

Procedure
1. In the studio, open your solution and, in the Solution Explorer, click Add New Item .
The Add New Item dialog opens.
2. Select SAP Analytics Key Figure .
3. Enter a name and click Add.
The logon screen of the SAP cloud solution opens. Log on to the system.
4. In the New Key Figure view, in the Define Key Figure and Select Data Source step, if you want, change the
default name of your key figure (AnalyticalKeyFigure1) and enter a description.
5. Choose an SAP data source or a data source you have created for your solution.
6. Choose which type of key figure you want to create: Calculated Key Figure or Restricted Key Figure.

SAP Cloud Applications Studio – Version May 2018 (1805)

462 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 For the following steps, see Create and Edit a Key Figure in the documentation of the cloud solution.
7. When you are done, close the SAP cloud solution and go back to the studio.
8. In the studio, in the Solution Explorer, update your solution by clicking Refresh Solution ( ).
A .kf file ( ) appears under your solution.

Result
You have created a key figure that you can now use in a report. For more information, see Create a Report
[page 460].
You can delete the key figure when your solution is in maintenance mode. For more information, see Maintenance
Mode [page 170].

8.12 Mass Data Run

8.12.1 Mass Data Run Quick Guide

In the studio, you can create a mass data run (MDR) for your custom business object, define selection parameters
for the mass data run, and create the relevant screens. In the SAP cloud solution, your customer uses the mass data
run to schedule an action for many instances of a custom business object.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Business and Technical Background

A mass data run is the automatic mass processing of a task or a business transaction. Mass data runs enable mass
processing of business data and are used in business processes, for example, invoice runs, payment authorization
runs, or balance confirmation runs. When a user schedules a mass data run, the system executes it as a background
job.
For more information, see Mass Data Run [page 464].

Tasks

Create a Mass Data Run

In the Solution Explorer, you can create a mass data run and generate the relevant screens.
For more information, see Create a Mass Data Run [page 467].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 463
Assign MDR Work Center View to UI
In the user interface designer, you can assign the mass data run work center view to the UI.
For more information, see Assign MDR Work Center View to UI [page 469].

Test the Mass Data Run

In the cloud solution, your customer can create and activate mass data run instances and schedule the mass data
run.
For more information, see Test the Mass Data Run [page 469].

See Also
Example: Changing the Status of a Price Request (Mass Data Run) [page 470]

8.12.2 Mass Data Run

With a mass data run (MDR), you can execute an action for many instances of a custom business object without
user interaction. You can schedule the mass data run to be executed immediately, on a specific date and at a specific
time, or periodically. The node of the custom business object needs to have an action and a query.

● You cannot use QueryByElement queries. These are generated automatically for every node of a
custom business object.
● You cannot create a mass data run for the action of an SAP business object.

For more information, see the mass data run documentation in the SAP cloud solution.

Features
In the studio, you can create a mass data run for a custom business object, which your customer can then use in the
SAP cloud solution.
Process Overview
Process steps for you in the studio:
1. In the Mass Data Run Wizard: Define the mass data run
a. Select the custom business object, the node, and the action
b. Select the query and the selection parameters
c. Select the control parameters
2. In the Solution Explorer: Generate the mass data run screens
3. In the UI designer: Assign the mass data run work center view to the UI

Process steps for a business user in the SAP cloud solution:

1. Create and activate the mass data run instances
2. Schedule the execution of the mass data run

SAP Cloud Applications Studio – Version May 2018 (1805)

464 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Mass Data Run Wizard
Selection Criteria
In the Mass Data Run Wizard, you can use the selection parameters of the query to restrict the business object
instances to be processed by the mass data run. You can either select User Selection or Fixed Value. If you want the
business user to be able to restrict the query results by entering values, select User Selection. Otherwise select Fixed
Value; fixed values cannot be changed by the business user.
The following table shows how you define the fixed values for specific data types:

Greater
Than/
Less Than/ Greater
Multiple Contains Less Than Than Or
Data Type Values Equal To Between Pattern Or Equal To Equal To Format Example

Amount Yes Yes Yes No Yes Yes Maximum 777.95

of 22
integer and
6 decimals
places

Date Yes Yes Yes No Yes Yes yyyy-mm- 2013–04–

dd 19

Code No Yes No No No No String

Duration Yes Yes Yes No Yes Yes PnYnMnDT P12Y12M2D

nHnMnS T4H12M40
(see below) S

Identifier Yes Yes Yes Yes Yes Yes String

Indicator No Yes No No No No True/False

Measure, Yes Yes Yes Yes Yes Yes Positive and 420.5
Quantity negative
entries are
possible

Name, Yes Yes Yes Yes Yes Yes String

Description
, Text

Numeric, Yes Yes Yes No Yes Yes 12.345

Percent,
Ratio

Time Yes Yes Yes No Yes Yes hh:mm:ss 15:30:00

Value Yes Yes Yes No Yes Yes Integer 5

values

The Duration format PnYnMnDTnHnMnS means:

● P: denotes the duration and precedes every duration value
● nY: the number prefix (n) is the duration in years
● nM: the number prefix (n) is the duration in months

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 465
 ● nD: the number prefix (n) is the duration in days
● t: the prefix for the time period in hours, minutes, and seconds. This is not required if no times are represented.
● nH: the number prefix (n) is the duration in hours
● nM: the number prefix (n) is the duration in minutes
● nS: the number prefix (n) is the duration in seconds

Parallel Processing
Parallel processing can shorten the processing time of a mass data run. If you select parallel processing, blocks of
50 business object instances are processed in parallel. The number of processes being executed in parallel depends
on the current system activities and cannot be influenced. If parallel processing of the business object instances
changes the same instance of another business object, locking problems can occur.

Only use parallel processing if you are sure that the business object instances are processed
independently of each other.

Application Log
For each execution of a mass data run, the system creates an application log. This shows the selection criteria used
for the mass data run and the messages that the system generated during the execution. In addition, the application
log details the number of instances processed and the number of instances changed. When you define the mass
data run, you can specify which messages (error, warning, or success) you want the application log to display.
Application logs are stored for the retention time you define (one day, one week, or one month). The next time the
mass data run is executed, the system deletes application logs for which the retention time has expired.
For more information, see the application log documentation in the SAP cloud solution.
Scheduling of Mass Data Runs in the SAP Cloud Solution
To execute a mass data run, business users have to create a new instance in the MDR work center view. They can
also add further selection criteria. After setting the mass data run instance to Active, the new mass data run can be
scheduled. Business users can choose from the following scheduling options:
● Start Immediately
Immediate execution of the mass data run. Depending on the current system activities, it may take some time
until the process starts.
● Run After Job
Execution once another mass data run is completed. This option can be used if there are dependencies
between the mass data runs.
● Single Run
Single execution on a specific date or at a specific time.
● Recurrence
Recurring execution of the mass data run (daily, weekly, or monthly).

For more information, see the "Background Jobs Quick Guide" in the SAP cloud solution.
Changing Mass Data Runs
If you change and activate a mass data run during development, the system deletes all existing instances and all
scheduled executions runs of that mass data run. This is not the case if a solution with a changed mass data run is
uploaded (for example, to a customer system). However, if you change delivered mass data runs, the runtime
behavior of scheduled mass data runs may be affected. For example, if you change one of the selection criteria, the
list of instances found by the query changes.
You can delete a mass data run when your solution is in maintenance mode. For more information, see Maintenance
Mode [page 170].
Mass Data Run in Solution Templates

SAP Cloud Applications Studio – Version May 2018 (1805)

466 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
If you have created a solution template that contains an object work list (OWL) for a mass data run object, you need
to do the following: After importing the solution templates into a customer-specific solution, you need to save and
activate the OWL again in the UI designer. Otherwise, the system will dump when you create a mass data run instance.
For more information on solution templates, see Solution Templates Quick Guide [page 160].

8.12.3 Create a Mass Data Run

In the studio, you define one or more mass data runs (MDR) for your custom business object. First, in the Mass Data
Run Wizard, you select the relevant business object, node, and action. Then, you select the query and define the
selection parameters for the query. After that, you define the control parameters for the execution of the mass data
run. Finally, you generate the screens for the mass data run.

Prerequisites
● You have created a solution.
● The solution contains a custom business object with an action. For more information, see the Business Objects
Quick Guide [page 346] under Create a Business Object and Action (Business Object) [page 177].
● You have created a query for the business object in the node containing the action. For more information, see
Create a Query [page 363].
● You have created a screen scenario. For more information, see Generate Screens for a Business Object
[page 370].

Procedure
1. In the studio, in the Solution Explorer, right-click the custom business object and select Create Mass Data
Run.
The Mass Data Run Wizard opens.

If the Create Mass Data Run option is disabled (grayed out) in the context menu of the custom business
object, the prerequisites for creating a mass data run are not met. This is the case, for example, when
the business object does not contain an action or a query.

2. In the Create a Mass Data Run step, enter a name, select a business object, a node, and an action, and click
Next.

The name of the mass data run can have up to 18 characters.

3. In the Define Selection Criteria for Mass Data Run step, do the following:
a. Select a query and then the restrictions None, User Selection, or Fixed Value for the query fields.

You must select User Selection or enter fixed values for at least one field.

If you select Fixed Value, proceed as follows:

1. Under Fixed Value, enter a value or click ... .

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 467
 The Selection of Fixed Values dialog opens.

Depending on the data type of the field, the ... button may not be available.

2. Click the Equal to button on the left and select one of the options.
3. Click Add to further restrict the values.

For more information on how to restrict the values, see Mass Data Run [page 464]
under Selection Criteria.

You can also exclude values by selecting But Exclude.

4. Click OK.
b. Click Next.
4. In the Select Control Parameters for Mass Data Run step, do the following:
a. Optional: Select Parallel Processing, if you want to reduce the processing time. However, you cannot
use this option, if there are dependencies among the mass data run instances.
b. Select the retention time of the application log: Short (1 Day), Medium (1 Week), or Long (1 Month).
If the retention time is expired, the application log is deleted during the next execution of the mass
data run.
c. Select the level of detail of the application log. You can choose to have errors, errors and warnings, or
all details displayed.
d. Click Next.
5. In the Review step, review your entries and click Finish.
In the Solution Explorer, a .run file ( ) appears.
6. To activate the mass data run, right-click the .run file and select Activate.
7. Right-click the mass data run and select Create Screens.
Three files (.OWL.uicomponent, and .QA.uicomponent, .WCVIEW.uiwocview) are displayed in the
Solution Explorer under the .run file.

If you delete an element (field) with a label from your business object that is used in the mass data
run and query, you must do the following to be able to activate the business object again:
1. Open the query, deselect the field and save the query.
2. Then you can activate the business object.

Result
You have defined one or more mass data runs for your custom business object and created the relevant screens. In
the UI designer, you can now assign the MDR work center view to the UI.
For more information, see Assign MDR Work Center View to UI [page 469].

SAP Cloud Applications Studio – Version May 2018 (1805)

468 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.12.4 Assign MDR Work Center View to UI

Overview
You have created a mass data run and its screens. Now you want to assign the mass data run work center view to
the work center of your custom business object.

Procedure
1. In the Solution Explorer, open the _WCF.WCF.uiwoc file of the custom business object. Right-click the file and
select Open UI Designer.
The UI designer opens.
2. On the Designer tab, select the TestView work center view.
3. In the Configuration Explorer, select [Your Solution]_MAIN SRC [your mass data run work center
view]_WCView and drag and drop it onto the empty space in the middle of the screen.
A warning message appears.
4. Click Yes and then Save and Activate and close the UI designer.
5. Reopen the UI designer by right-clicking the _WCF.WCF.uiwoc file of the custom business object.
On the Designer tab, the TestView work center view should now have changed its name to the name of your
mass data run.

If you want to change the texts on the screens, open the relevant screen in the UI designer and enter
a new text in the Property Explorer. For more information, see Change the Title of a Component
[page 637].

Result
You have assigned the mass data run screens to the work center of the custom business object. Your customer can
now define and schedule mass data runs in the cloud solution.
For more information, see Test the Mass Data Run [page 469].

8.12.5 Test the Mass Data Run

Overview
You have assigned the mass data run work center view to the UI. Now you can test the mass data run in the SAP
cloud solution.

Prerequisites
In the UI designer, you have assigned the mass data run screens to the work center of the custom business object.
For more information, see Assign MDR Work Center View to UI [page 469].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 469
In the SAP cloud solution, you have assigned the work center of your custom business object to your business user.
For information on how to assign a work center view to a business user, see the User Setup Quick Guide
[page 31].

Procedure
1. In the SAP cloud solution, choose the work center view of the custom business object and create some
instances of the business object.
2. Choose the work center view of the mass data run and click New.
3. Enter a Run ID and a Run Description.
4. To define selection criteria, proceed as follows:
a. Click one of the Selection Criteria tabs and click Add Row.
b. Click Inclusion/Exclusion to include or exclude values.
c. Select a search pattern and enter a range.
d. Save your entries and click Set to Active.
5. Click Schedule.
The Schedule Job view opens.
6. The following scheduling options are available:
● To start the mass data run immediately, select Start Immediately and enter a data and time.
● To start the mass data run after another job, select a job in the Scheduled Job Selection dialog or enter
a data and time.
● To schedule the mass data run as a single run, select Single Run and enter a date and time.
● To schedule a recurring mass data run, select Recurrence, enter date and time and the type of
recurrence.
7. Click Save and Close.

Result
You have scheduled the mass data run, which will be processed according to the selections you have made. In the
Mass Data Run OWL, under Execution Details, the status of your mass data run is displayed.
Once the mass data run has been completed, the process status changes. You can then access the application log
by clicking Application Log ID for more detailed information.

8.12.6 Example: Changing the Status of a Price Request (Mass Data

Run)

This example illustrates a use case for mass data runs for custom business objects. Assume the custom business
object PriceRequest has a validity period. Once the validity of the price request has expired, we want to change its
status to obsolete. This status change can be performed using a periodically scheduled mass data run.

Prerequisites
● You have installed the studio on your PC or laptop. For more information, see Installing SAP Cloud Applications
Studio [page 28].

SAP Cloud Applications Studio – Version May 2018 (1805)

470 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 ● You have a studio developer user and a business user for the cloud solution. For more information, see User
Setup Quick Guide [page 31].
● You have created a solution.

Tasks

Create a Code List Data Type

1. Log on to the studio and, in the Solution Explorer, select your solution and click Add Item.
2. In the Add New Item dialog, select Code List Data Type.
3. Enter a name (PriceRequestStatus) and click Add.
The Code List Data Type Wizard opens.
4. In the Create Code List Data step, proceed as follows:
Enter a name (PriceRequestStatus; the suffix Code is added automatically) and a description (Price
Request Status) and click Next.
5. In the Define the Code List Values step, proceed as follows:
Enter the following values and then click Next:

Value Description Constant

NEW New CO_NEW

ACTIVE Active CO_ ACTIVE

OBSOLETE Obsolete CO_OBSOLETE

6. In the Review step, review your entries and click Finish.

In the Solution Explorer, a file is added to your solution. It is called PriceRequestStatus.codelist.
7. Right-click the PriceRequestStatus.codelist file and select Activate.

Create a Custom Business Object With an Action

1. In the Solution Explorer, right-click the project in your solution and select Add New Item.
2. In the Add New Item dialog box, select the Business Object template, enter a name for your business object
(PriceRequest.bo), and click Add.
A new item (PriceRequest.bo) appears in the Solution Explorer and the business object editor opens.
3. In the editor, enter the following code:
import AP.Common.GDT as apCommonGDT;

businessobject PriceRequest raises PriceRequestSetToObsolete {

[Label("Price Request ID")] [AlternativeKey]element PriceRequestID : ID;

[Label("Product ID")]element ProductID : ProductID;
[Label("Description")]element Description : MEDIUM_Description;
[Label("Status")]element Status : PriceRequestStatusCode;
[Label("Start Date")] element ValidtyStartDate : Date;
[Label("End Date")] element ValidtyEndDate : Date;
[Label("Price")]element Price : Amount;
[Label("Discount")]element Discount : Percent;

message PriceRequestSetToObsolete text "Price Request &1 set to obsolete" : ID;

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 471
 action SetToObsolete raises PriceRequestSetToObsolete;
4. Save and activate the business object.
5. Right-click the business object and select Create Script Files.
The Create Script Files dialog opens: The SetToObsolete action is already selected.
6. Click OK.
The script file editor opens.
7. Enter the following code:
import ABSL;

var today = Context.GetCurrentSystemDate();

if (this.ValidityEndDate < Context.GetCurrentSystemDate() && this.Status !=

PriceRequestStatusCode.CO_OBSOLETE )
{
this.Status = PriceRequestStatusCode.CO_OBSOLETE;
raise PriceRequestSetToObsolete.Create("S", this.PriceRequestID);
}
8. Save and activate the script file.

Create a Business Object Query

1. In the Solution Explorer, right-click your business object and select Create Query.
The Query Wizard opens.
2. In the Create a Query step, enter a Query Description and click Next.
3. In the Select Query Fields step, select all fields and click Next.
4. In the Define Query Parameters step, click Next.
5. In the Review step, review your entries and click Finish.
In the Solution Explorer, a .qry file appears under your business object.
6. Activate the business object.

Create a Screen Scenario for the Business Object

1. In the Solution Explorer, right-click the business object and select Create Screens.
2. In the Create Screens dialog, select a screen scenario option, enter a Short ID and click OK.
In the Solution Explorer, six new files appear.

Make a note of the name of your solution (for example, YOS451VHY).

SAP Cloud Applications Studio – Version May 2018 (1805)

472 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Solution Explorer

Assign the Work Center to a Business User

1. Log on to the cloud solution with an admin user and choose Application and User
Management Business Users .
2. In the Find field, enter the business user and click Go.
The business user is displayed.
3. Select the business user and choose Edit Access Rights Work Center and View Assignments .
4. Select the work center you have created ([your solution name]...WCF.WCF) and click Save.
5. Log off from the cloud solution.

Test the Business Object Action

1. Log on to the cloud solution with the business user and choose the PriceRequest work center you have created
and assigned to the business user.
2. Create several price requests with different validities:
a. Click New, enter values in all fields and click Save.

New Price Request

b. Click Close and repeat step 1.

3. Test the SetToObsolete action:
a. Click Go to display all price requests.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 473
 All Price Requests

b. Select one of the entries and click Edit.

c. Change the validity end date to a date before the current date, click Save and then SetToObsolete.
The status of the price request is changed to Obsolete.

Create a Mass Data Run

1. In the studio, in the Solution Explorer, right-click your business object and select Create Mass Data Run.
The Mass Data Run Wizard opens.
2. In the Create a Mass Data Run step, enter a name (for example, SetToObsolete), check the other values
and click Next.
3. In the Define Selection Criteria for Mass Data Run step, for the Status: PriceRequestStatusCode query
field, set the restriction to User Selection and click Next.
4. In the Select Control Parameters for Mass Data Run step, leave the settings as they are (Parallel Processing:
not selected, Application Log Retention Time: Short (1 Day), Application Log Detail Level: Errors) and
click Next.
5. In the Review step, review your entries and click Finish.
In the Solution Explorer, a .run file ( ) appears.
6. To activate the mass data run, right-click the .run file and select Activate.

Create the Screens and Assign Them to the Work Center

1. In the Solution Explorer, right-click the .mdr file and select Create Screens.
The system generates three screen files (QA, OWL, WCVIEW).
2. To open the PriceRequest_WCF.WCF.uiwoc file, right-click it and select Open UI Designer.
The UI designer opens.
3. On the Designer tab, select the TestView.
4. In the Configuration Explorer, select [Your Solution]_MAIN SRC SetToObsolete_WCView and drag it
onto the empty space in the middle of the screen.
A warning appears.
5. Click Yes and then Save and Activate and close the UI designer.
6. In the cloud solution, assign the SetToObsolete work center view to your business user.

Create and Schedule Mass Data Run Instances

1. In the cloud solution, go to the object work list (OWL) of your mass data run and click New.
2. Enter a run ID and a run description.
3. To add selection criterion, click Add Row.
4. Enter the following data:

SAP Cloud Applications Studio – Version May 2018 (1805)

474 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Inclusion/Exclusion Search Pattern From

Exclusion EQ — Equal to OBSOLETE — Obsolete

5. Click Save and Set to Active.

6. Click Schedule.
The Schedule Job view opens.
7. Select Start Immediately and click Save and Close.
You have started a mass data run. As soon as the mass data run has finished, you can see the result in the
SetToObsolete work center view.
You can call up further details by clicking the Application Log ID.

Mass Data Run: Application Log

See Also
Mass Data Run [page 464]
Mass Data Run Quick Guide [page 463]

8.13 Mashups

8.13.1 Mashups Quick Guide

Using the studio, you can create mashups for an SAP cloud solution, and add them to an SAP floorplan or a floorplan
that you have designed.

Business and Technical Background

Creating Mashups
Using the studio, you can create mashups for an SAP cloud solution, and add them to an SAP floorplan or a floorplan
that you have designed.
For more information, see here [page 477].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 475
Mashup Categories
When you create a new mashup, you need to select a mashup category. Mashup categories are used to group
together mashups by the type of service or information that they provide. Depending on the mashup category
selected, you can then select a port binding. This defines the screen out-port parameters that can be used in a
mashup and the screens on which the mashup can then be made visible.
For more information, see here [page 479].

Mashups and Web Services

Mashups are used to integrate data from SAP's cloud solution with data provided by an online Web service or
application. Users can access the content provided by these Web services and applications, and use it in their daily
work. Mashups can include Web searches, company or industry business information, or online map searches.
For more information, see here [page 488].

Tasks

Create a Port Binding for a Mashup

For information about this task, see here [page 491].

Create a URL Mashup

For information about this task, see here [page 492].

Create an HTML Mashup

For information about this task, see here [page 497].

Create a Data Mashup

For information about this task, see here [page 494].

Add a Mashup to an SAP Floorplan

For information about this task, see here [page 504].

Add a Mashup to Your Floorplan

For information about this task, see here [page 513].

Save and Activate your Changes

After you have made any of the changes listed above, you need to save and activate the changes.
1. From the File menu, choose Save.
2. From the File menu, choose Activate.
3. In the Activate Worklist dialog box, select the check boxes beside the relevant components and click OK.

SAP Cloud Applications Studio – Version May 2018 (1805)

476 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.13.2 Business and Technical Background

8.13.2.1 Creating Mashups

Overview
Mashups are used to integrate data from SAP's cloud solution with data provided by an online Web service or
application. Users can access the content provided by these Web services and applications, and use it in their daily
work. Mashups can include Web searches, company or industry business information, or online map searches.
Using the studio, you can create mashups for an SAP cloud solution, and add them to an SAP floorplan or a floorplan
that you have designed.

Prerequisites
The following prerequisites apply:
● You must enable the admin mode for the solution in which you create the mashup to ensure that the system
saves your content and any changes you make in the solution. To do this, open your solution and select
Administration Switch On/Off Admin Mode in SAP Solution . For more information about the admin
mode, see Working in the Integrated Development Environment [page 37].

If you create a Web service for a mashup, the following prerequisites apply concerning API keys and authentication:
● API Keys
Some Web services require a unique API key to allow you to access their services. You can generate a
company-specific API key on the service provider's Web site and then use this key to authenticate access to
the service from SAP's cloud solution.
You can identify which mashups require an API key by the icon displayed in the API Keys column. The Enter
API Keys dialog box displays the API keys that are required by the selected mashup.
● Basic Authentication
Basic authentication allows you to enter a user name and password for authenticating access to a Web service.
This user name and password is then used to automatically authenticate all other users accessing the service.
● Secure Authentication
For Web services that support the OAuth authentication protocol, you can set up secure authentication. The
OAuth protocol enables secure, user-based access to Web services from SAP's cloud solution. Unlike other
authentication methods, OAuth gives the user full control of his or her own authentication details. To use a
mashup based on an OAuth authenticated Web service, users need to authenticate themselves on the service
provider's web site, where they are given a unique PIN code. This PIN code is then used to authenticate access
to the service from SAP's cloud solution.

Features
The following mashup types are available:
There are four different mashup types:
● URL Mashups

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 477
 A mashup that sends data from SAP's cloud solution to the URL of an online service provider. The service
provider uses the data, for example, to perform a search, and the results are displayed in a new browser
window.
● HTML Mashups
A mashup that embeds an HTML or JavaScript based Web page directly on a screen.
● Data Mashups
A mashup combines and displays data from both internal and external sources. To create a data mashup, an
integrated authoring tool is used to transform or merge external Web services with internal business data
using industry-standard Web service protocols.
● Custom Mashups
A mashup that has been created as an add-on solution by SAP.

You can create new data, URL, and HTML mashups. Custom mashups can be created only by SAP.
In particular, mashups are distinguished by the following characteristics:
● Mashup Categories
Mashups are grouped together into categories according to the type of service or information that they
provide.
● Port Binding
Certain fields on screens are predefined as screen out-ports and in-ports. These screen out-ports and in-
ports are grouped together as a port binding.
The port binding defines the type of information that can be used in the mashup and defines on which screens
you can use the mashup. The mashup category specifies which port bindings are available.

For more information, see Mashup Categories.

For more information, see Mashup Categories [page 479].

Process Flow
The following process steps apply:
1. Create a Mashup
You can create the following mashup types:
● Create a URL Mashup [page 492]
● Create an HTML Mashup [page 497]
● Create a Data Mashup [page 494]
2. Add the Mashup to a Floorplan
After that, you can add the mashup to an SAP floorplan or a floorplan that you have designed. For more
information, see:
● Add a Mashup to an SAP Floorplan [page 504]
● Add a Mashup to Your Floorplan [page 513]

If you want to integrate a mashup into a floorplan provided by SAP, this floorplan must have an existing
outport with a stable anchor and a referenced anchor. You cannot create your own outports for SAP
floorplans.

See Also
Mashups Quick Guide [page 475]

SAP Cloud Applications Studio – Version May 2018 (1805)

478 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.13.2.2 Mashup Categories

Overview
When you create a new mashup, you need to select a mashup category. Mashup categories are used to group
together mashups by the type of service or information that they provide. Depending on the mashup category
selected, you can then select a port binding. This defines the screen out-port parameters that can be used in a
mashup and the screens on which the mashup can then be made visible.

Features
The following table gives an overview of the different mashup categories available in SAP's cloud solutions, and the
type of information available for use in each mashup category. The out-port type corresponds to one or more
parameters that can be used when creating a mashup.

The mashup categories and port bindings that are available depend on the cloud solution that you have. When
you create a new mashup, you can see which mashup categories and port bindings are available in the
dropdown list.

Mashup Categories and Port Bindings

Mashup Category Port Binding Description Out-Port Type

Business & Finance Additional Account Show additional information Account name information
Information for a dedicated account

Company Financial and Search for business-related D-U-N-S number and name of
Business Information by information based on a company
Company Name or DUNS company name or D-U-N-S
number

Company Financial and Search for business-related Name of company

Business Information by information based on a
Company Name company name

Company Financial and Search for business-related Name of industry

Business Information by information based on an
Industry industry

Company Financial and Search for business-related Nielsen code

Business Information by information based on a
Nielsen Code Nielsen code

Point-of-Sale Transaction Look up a point-of-sale Point-of-sale transaction

Lookup transaction in a third-party information
point-of-sale system

Web Feed by Company Name Display web feeds filtered by a Name of company
company name

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 479
Mashup Category Port Binding Description Out-Port Type

Location & Travel Business Locator Search for a local business Industry and address
address by address or information
industry

Route Planner Plan a business route based Start address, end address,
on a list of addresses and additional destinations

Weather Display weather information Address information

based on an address

Web Map Display a business address on Address information

a map or get directions based
on an address

News & Reference Business Partner Web Search Search for a business partner Search term
by name

Product Web Search Search for product Product search term

information by name

Search Provider Search for a search term Search term

Productivity & Tools Reverse Lookup Look up a business address Name and address
using partial address information
information

Reverse Lookup by Phone Look up a business address Phone number

using a phone number

Shipping Service Integrate shipping services Shipping information

(limited)

Sourcing Search for sourcing Search term

information based on a
product description

URL Navigation Navigate to an internal or URL navigation information

external resource URL

Social & Communication Social Network Display people or business People or business partner
partner profiles that are listed profile information
in a social network

The following table shows on which screens a mashup can be made visible for each port binding.

Port Binding by Screen

Port Binding Work Center Screen

Account Additional Information Business Partners Account Overview fact sheet

SAP Cloud Applications Studio – Version May 2018 (1805)

480 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Port Binding Work Center Screen

Business Locator Business Partners Partner Overview fact sheet

Private Account editor

Contact Overview fact sheet

Liquidity Management My Bank Overview fact sheet

Marketing Competitor Overview fact sheet

Business Partners Suppliers view

Supplier editor

Supplier Overview fact sheet

New Supplier activity

Service Agent Overview fact sheet

Tax Management Tax Authority Overview fact sheet

Business Partner Web Search Business Partners Partner Overview fact sheet
and
Contact Overview fact sheet
Search Provider
Contact editor

New Contact activity

Account Overview fact sheet

Accounts view

Corporate Account editor

New Corporate Account activity

Private Account editor

Business Partners Business Partner Organization editor

Business Partner Person editor

Liquidity Management My Bank Overview fact sheet

Marketing Competitor Overview fact sheet

Personnel Administration New Social Insurance Fund activity

Social Insurance Fund Overview fact

sheet

Business Partners Suppliers view

Supplier editor

New Supplier activity

Service Agent Overview fact sheet

Tax Management Tax Authority Overview fact sheet

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 481
Port Binding Work Center Screen

Company Financial and Business Business Partners Account Overview fact sheet
Information by Company Name
Accounts view
and
Web Feed by Company Name Contact editor

Corporate Account editor

New Contact activity

New Corporate Account activity

New Partner activity

Private Account editor

Partner Overview fact sheet

Partner editor

Partners view

Business Partners Business Partner Organization editor

Business Partners view

Liquidity Management Clearing Houses view

Clearing House editor

My Bank Overview fact sheet

My Bank editor

My Banks view

Marketing Competitors view

Competitor editor

Competitor Overview fact sheet

Personnel Administration Social Insurance Fund editor

Social Insurance Fund Overview fact

sheet

New Social Insurance Fund activity

Business Partners Suppliers view

Supplier editor

New Supplier activity

Supplier Overview fact sheet

Tax Management Tax Authority Overview fact sheet

Tax Authority editor

Tax Authorities view

SAP Cloud Applications Studio – Version May 2018 (1805)

482 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Port Binding Work Center Screen

Company Financial and Business Business Partners Account Overview fact sheet
Information by DUNS Number
Accounts view

Corporate Account editor

Business Partners Supplier editor

Suppliers view

Company Financial and Business Business Partners Account Overview fact sheet
Information by Industry
Accounts view

Corporate Account editor

New Corporate Account activity

Business Partners Business Partner Organization editor

Business Partners view

Business Partners New Supplier activity

Supplier editor

Suppliers view

Company Financial and Business Business Partners Corporate Account editor

Information by Nielson Code
New Corporate Account activity

Account Overview fact sheet

Point-of-Sale Transaction Lookup Business Partners Account Overview fact sheet

Customer Invoicing Point-of-Sale Transaction editor

Point-of-Sale Transaction Overview fact

sheet

Point-of-Sale Transactions view

Product Web Search Sales Orders Sales Order editor

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 483
Port Binding Work Center Screen

Reverse Lookup Business Partners New Partner activity

Contact editor

Corporate Account editor

New Corporate Account activity

Private Account editor

New Private Account activity

Business Partners New Business Partner Organization

activity

New Business Partner Person activity

Liquidity Management New Bank activity

New Clearing House activity

Marketing New Competitor activity

Personnel Administration New Social Insurance Fund activity

Business Partners Supplier editor

New Supplier activity

Tax Management New Tax Authority activity

Reverse Lookup by Phone Business Partners New Partner activity

Contact editor

New Contact activity

Corporate Account editor

New Corporate Account activity

Private Account editor

New Private Account activity

Business Partners New Business Partner Organization

activity

New Business Partner Person activity

Liquidity Management New Bank activity

Personnel Administration Social Insurance Fund editor

Business Partners Supplier editor

New Supplier activity

Tax Management New Tax Authority activity

Route Planner Field Service and Repair Order Pipeline view

Shipping Service Outbound Logistics Outbound Deliveries view

Outbound Delivery editor

SAP Cloud Applications Studio – Version May 2018 (1805)

484 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Port Binding Work Center Screen

Social Network Business Partners Account Overview fact sheet

Contact editor

Contact Overview fact sheet

Contacts view

New Contact activity

New Private Account activity

Private Account editor

Business Partners Business Partner Contact editor

Business Partner Contact Overview fact

sheet

Business Partner Contacts view

Business Partner Organization editor

Business Partner Overview fact sheet

Business Partner Person editor

Employees view

New Business Partner Contact activity

New Business Partner Organization

activity

New Business Partner Person activity

New Employee activity

Resource Management Resource Profile editor

Resource Profile Overview fact sheet

Resource Profiles view

Business Partners New Service Agent activity

New Supplier activity

Service Agent editor

Service Agent Overview fact sheet

Service Agents view

Supplier editor

Supplier Overview fact sheet

Suppliers view

Managing My Area Employee Profile editor

Employee Profile Overview fact sheet

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 485
Port Binding Work Center Screen

Sourcing Purchase Requests and Orders Purchase Request Assign Source of

Supply

Purchase Requests view

Business Partners Supplier editor

URL Navigation Business Partners Accounts view

SAP Cloud Applications Studio – Version May 2018 (1805)

486 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Port Binding Work Center Screen

Weather Business Partners Partner Overview fact sheet

and
New Partner activity
Web Map
Partner editor

Partners view

Contacts view

Contact Overview fact sheet

Contact editor

New Contact activity

Account Overview fact sheet

Accounts view

Corporate Account editor

New Corporate Account activity

Private Account editor

New Private Account activity

Business Partners Business Partner Contact Overview fact

sheet

Business Partner Contact editor

Business Partner Organization editor

Business Partner Person editor

Business Partner Overview fact sheet

Business Partners view

Employee Contact Data fact sheet

New Business Partner Organization

activity

New Business Partner Person activity

New Business Partner Contact activity

New Registered Product activity

Registered Product editor

Registered Product Overview fact sheet

Inbound Logistics Inbound Delivery Notification editor

New Inbound Delivery Notification

activity

Liquidity Management My Bank Overview fact sheet

My Banks view

My Bank editor

New Bank activity

Clearing Houses view

SAP Cloud Applications Studio – Version May 2018 (1805)
Developer Desktop Clearing
PUBLIC • © House
2018 SAP editor
SE. All rights reserved. 487

New Clearing House activity

Port Binding Work Center Screen

Web Widget Web widgets can be added to any screens including the Home work center Overview
view as well as all other Overviews.

See Also
Creating Mashups [page 477]

8.13.2.3 Mashups and Web Services

Overview
Mashups are used to integrate data from SAP's cloud solution with data provided by an online Web service or
application. Users can access the content provided by these Web services and applications, and use it in their daily
work. Mashups can include Web searches, company or industry business information, or online map searches.

Prerequisites

Configuration settings are usually performed by an administrator. If you do not have the required
authorization, contact your administrator.

You have enabled Communities, Document Management and External Services in your system configuration. To find
this business option, go to the Business Configuration work center and choose the Implementation Projects view.
Select your implementation project and click Edit Project Scope . In the Scoping step of the project, ensure that
People Collaboration, Intranet and External Services is selected within Communication and Information Exchange.
In the Questions step, expand the Communication and Information Exchange scoping element and select People
Collaboration, Intranet and External Services. Select Communities, Document Management and External Services
and answer the question related to Mashups, Web Services, and External Search Providers Integration.
Before a mashup can be used, it must be activated by an administrator. This administrator must have authorization
for the Mashup Authoring and Mashup Web Services work center views.

Note that some mashups may not be applicable to your country. Your administrator should ensure that the
mashup is valid for your country before activating it for company-wide usage.

How to Get Mashups

Mashups can be provided in the following ways:
● Depending on your solution, a few preconfigured mashups are provided.
● The administrator can create mashups for your organization.

The administrator can create new URL, HTML, or data mashups based on a mashup category provided by SAP.
Depending on your solution, preconfigured mashup Web services are provided, which the administrator can use to
create mashups.

SAP Cloud Applications Studio – Version May 2018 (1805)

488 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
How to Use Mashups
After a mashup has been activated, it can be made visible on the screens for which it is configured. There are two
ways this can be done:
● The administrator does this centrally for all users in the Adapt menu. For more information, see Make a
Mashup Visible on a Screen.
● The user does this for himself or herself in the Personalize menu. For more information, see Personalize a
Mashup.

If a mashup has not yet been activated, the administrator can edit and activate it at a later date from
the Mashup Authoring view.

How to Access Mashups

Once a mashup has been activated and made visible on screens, you can access it in the following ways:
● A mashup can be displayed as an embedded screen.
● You can click a link on the screen.
● You can click Web Services and choose the mashup.
● You can use Enterprise Search and access external search providers that are integrated there.

Features
There are four different mashup types:
● URL Mashups
A mashup that sends data from SAP's cloud solution to the URL of an online service provider. The service
provider uses the data, for example, to perform a search, and the results are displayed in a new browser
window.
● HTML Mashups
A mashup that embeds an HTML or JavaScript based Web page directly on a screen.
● Data Mashups
A mashup combines and displays data from both internal and external sources. To create a data mashup, an
integrated authoring tool is used to transform or merge external Web services with internal business data
using industry-standard Web service protocols.
● Custom Mashups
A mashup that has been created as an add-on solution by SAP.

Administrators can create new data, URL, and HTML mashups. Custom mashups can be created only by SAP.
In particular, mashups are distinguished by the following characteristics:
● Mashup Categories
Mashups are grouped together into categories according to the type of service or information that they
provide.
● Port Binding
Certain fields on screens are predefined as screen out-ports and in-ports. These screen out-ports and in-
ports are grouped together as a port binding.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 489
 The port binding defines the type of information that can be used in the mashup and defines on which screens
you can use the mashup. The mashup category specifies which port bindings are available.

For more information, see Mashup Categories.

API Keys and Authentication

● API Keys
Some Web services require a unique API key to allow you to access their services. You can generate a
company-specific API key on the service provider's Web site and then use this key to authenticate access to
the service from SAP's cloud solution.
You can identify which mashups require an API key by the icon displayed in the API Keys column. The Enter
API Keys dialog box displays the API keys that are required by the selected mashup.
● Basic Authentication
Basic authentication allows you to enter a user name and password for authenticating access to a Web service.
This user name and password is then used to automatically authenticate all other users accessing the service.
● Secure Authentication
For Web services that support the OAuth authentication protocol, you can set up secure authentication. The
OAuth protocol enables secure, user-based access to Web services from SAP's cloud solution. Unlike other
authentication methods, OAuth gives the user full control of his or her own authentication details. To use a
mashup based on an OAuth authenticated Web service, users need to authenticate themselves on the service
provider's web site, where they are given a unique PIN code. This PIN code is then used to authenticate access
to the service from SAP's cloud solution.

Configuring Mashups
Administrators can configure mashups in the following ways:
● Centrally
Depending on your solution, go to Application and User Management Business Flexibility Mashup
Authoring or Administrator Business Flexibility Mashup Authoring
● On a particular screen
Use the Adapt function on any screen enabled for mashups to access the adaptation sidecar.

Administrators can configure mashups as follows:

● Activate mashups for use by all users or deactivate unwanted mashups
● Activate mashup partner solutions from the SAP Store
● Change the way in which mashups are displayed, and test and publish the changes to all users
● Create new mashups by copying an existing mashup and adapting the settings in the copied mashup
● Add new Web services for use in data mashups
● Create new URL, HTML, or data mashups based on a mashup category provided by SAP

See Also
Mashup Authoring Quick Guide
Mashup Web Services Quick Guide

SAP Cloud Applications Studio – Version May 2018 (1805)

490 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.13.3 Tasks

8.13.3.1 Create a Port Binding for a Mashup

Overview
The SAP cloud solution provides port bindings that specify on which screens mashups can be used. However, you
can also create your own port bindings for your solutions, if required.

Prerequisites
You must have created a solution. The following prerequisites for creating solutions that use mashups apply:
● You must enable the admin mode for the solution in which you create the mashup to ensure that the system
saves your content and any changes you make in the solution. To do this, open your solution and select
Administration Switch On/Off Admin Mode in SAP Solution . For more information about the admin
mode, see Working in the Integrated Development Environment [page 37].

Before you can create a port binding, you need to create a port type package for the mashup inport. If the mashup
is going to return data that is entered automatically into the cloud solution, then you need to create a port type
package for the mashup outport as well. For information on creating port type packages, see Create a Port Type
Package [page 615].

Procedure
1. Open your solution.
2. In the Solution Explorer, under Mashup Configuration, right-click Port Binding and select Create Port
Binding.
3. Select the Mashup Port Binding template.
4. Enter a name for the port binding and click Add.
5. Right-click the port binding, and choose Open.
The UI designer opens, displaying a dialog box that contains the name of the port binding in the title.
6. In the Display Name field, enter the name of the port binding. In the Description field, enter a text that describes
what the port binding is used for.
This information is displayed in the dropdown list when you create a mashup and select a port binding.
7. In the Category field, select the mashup category to which the port binding should be assigned.
8. Select an inport type package from the dropdown list.

Only your own inport type packages are displayed in the dropdown list.

9. Select an inport type reference.

Only inport type references that have been defined for the port type package that you have selected
are displayed.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 491
 10. If the mashup is going to return data to the cloud solution, select also an outport type package and an outport
type reference.
11. Save and activate.

Result
You can now use the port binding when you create a mashup. For more information on creating mashups, see
Creating Mashups [page 477].

See Also
Mashups Quick Guide [page 475]

8.13.3.2 Create a URL Mashup

In the studio, you can create URL mashups to send data from the SAP cloud solution to a URL of a Web service
provider. The results are displayed on the Web service provider’s Web site, which is opened in a new browser window.

Some Web services may pass your business data to a third-party organization, for example, account data is
passed to a search engine when performing a reverse lookup in an online address book. We recommend that
you check whether the mashup conforms to your company’s data privacy policies before activating the
mashup.

Prerequisites
You know the end-point URL of the Web site providing the service. This could be, for example, the search results
page of an online search provider.
● You must enable the admin mode for the solution in which you create the mashup to ensure that the system
saves your content and any changes you make in the solution. To do this, open your solution and select
Administration Switch On/Off Admin Mode in SAP Solution . For more information about the admin
mode, see Working in the Integrated Development Environment [page 37].

Procedure
Open your solution. In the Solution Explorer, do one of the following steps:
● If you are creating a mashup for the first time for this solution, right-click Add-on Solution (In Development),
then select Add New Item Create URL Mashup .
● If you have already created a mashup for this solution, you can simply right-click MashupAuthoring and select
Create URL Mashup.

The SAP cloud solution opens. If required, enter your user and password, then do the following steps:
1. Select a mashup category.
The mashup category is used to group mashups by the type of information they provide. It is shown to business
users when they personalize mashups in the side panel.

SAP Cloud Applications Studio – Version May 2018 (1805)

492 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 2. For the mashup category, you then select the port binding that you want to use in the mashup. This information
is not shown to business users.
The port binding defines which screen out-ports or in-ports can be used in the mashup and on which screens
the mashup can be used.
3. Enter a name and a description for the mashup.
The mashup name will be displayed to business users when using the mashup.

By default, the mashup has the status Active. This means it will be available for use when saved. If you
want to prevent users from accessing the mashup immediately, change the status to Inactive.

4. Under URL Information, enter the URL of the Web service and click Extract Parameters .
The URL can be taken directly, for example, from the search results Web page of an online search provider.
Copy and paste this URL directly into the field. The system then extracts all parameters from the URL and
displays them in the table.

Note that for URLs that do not use queries you can manually add curly brackets around terms that
should act as placeholders. For example, in the URL https://mail.google.com/mail/#search/
SAP, you can replace the word SAP with a search term in curly brackets, for example, {term}.
If you then enter https://mail.google.com/mail/#search/{term} in the URL field and click
Extract Parameters , the word in brackets is extracted as a parameter.

5. For any parameters that require a fixed value, check and adjust the value in the Constant column.
6. For dynamic parameters, in the Parameter Binding column, map the dynamic parameters to screen out-ports
by selecting an out-port from the value help.
The Parameter Binding dialog box displays a list of screen out-ports that have been configured for the selected
mashup category and screen. Select the parameter you want to bind to the URL parameter.
Note that If you are creating a mashup for the category route planner, you can also define the following optional
settings:
● Code Format Conversion: For parameters that contain a code, you can change how code formats are
converted.
● Start Index for List: You can define whether the array parameter starts with 0 or 1.
● Prefix for First Value/Prefix for Next Value: You can only define prefixes for URLs that have the index
pattern $I and for which the start index has been set to zero.
7. Click the Preview link to display the end result of the mashup.
8. Save your changes.

Result
When you return to the studio, click Refresh to display the mashup in the Solution Explorer.
You can now do the following tasks:
● Add a Mashup to an SAP Floorplan [page 504]
● Add a Mashup to Your Floorplan [page 513]

The document Add a URL Mashup [page 109] provides an example of how you can add a URL mashup to a quick
activity floorplan.

See Also
Mashups Quick Guide [page 475]

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 493
8.13.3.3 Create a Data Mashup

In the studio, you can create data mashups for integrating data provided by third-party Web services with business
data from the SAP cloud solution.

Note that some Web services may pass your business data to a third-party organization, for example, account
data is passed to a search engine when performing a reverse lookup in an online address book. It is
recommended that you check whether the mashup conforms to your company’s data privacy policies before
activating the mashup.

Prerequisites
You have either integrated a new Web service or have decided to base your mashup on one or more of the
preconfigured Web services provided by SAP or partners.

Web services that you have integrated for use in data mashups must use the XML service protocol.

For more information about adding a new RSS/Atom, REST, or SOAP Web service, see Create a Mashup Web Service
[page 501].
● You must enable the admin mode for the solution in which you create the mashup to ensure that the system
saves your content and any changes you make in the solution. To do this, open your solution and select
Administration Switch On/Off Admin Mode in SAP Solution . For more information about the admin
mode, see Working in the Integrated Development Environment [page 37].

Procedure
Open your solution. In the Solution Explorer, do one of the following steps:
● If you are creating a mashup for the first time for this solution, right-click Add-on Solution (In Development),
then select Add New Item Create Data Mashup .
● If you have already created a mashup for this solution, you can simply right-click MashupAuthoring and select
Create Data Mashup.

The SAP cloud solution opens. If required, enter your user and password, then do the following steps:
1. Select a mashup category.
The mashup category is used to group mashups by the type of information they provide. It is shown to business
users when they personalize mashups in the side panel.
2. For the mashup category, you then select the port binding that you want to use in the mashup. This information
is not shown to business users.
The port binding defines which screen out-ports or in-ports can be used in the mashup and on which screens
the mashup can be used.
3. Enter a name and a description for the mashup.
The mashup name will be displayed to business users when using the mashup.

SAP Cloud Applications Studio – Version May 2018 (1805)

494 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 By default, the mashup has the status Active. This means it will be available for use when saved. If you
want to prevent users from accessing the mashup immediately, change the status to Inactive.

4. On the Define Mashup Details step, create the mashup by adding building blocks to the authoring canvas and
adjusting the properties. First of all, define the source of input for the mashup. You have the following options:
Mashup In-Ports
If mashup in-ports exist for the selected mashup category, the Mashup In-Port building block is added
automatically to the authoring canvas. Click on the Mashup In-Port building block to view and adjust its
parameters.
User Inputs
User inputs allow you to define a field in which a user can enter or select a value. This value is then used as
input for the mashup. To add a user input to the mashup, select it from the pane on the left of the screen and
drag and drop it onto the authoring canvas.

User Inputs

Text Input Allows users to enter a string of characters as input for the mashup.

Number Input Allows users to enter a number as input for the mashup.

Select Option Input Allows users to select an option from a dropdown list as input for the mashup.

After adding a building block to the authoring canvas, click on the building block to view and adjust its
properties. You can enter a name in the Input Name field. This can then be mapped to an input parameter,
for example, in a search service. In the Input Label field, enter the field label that should be shown to users for
this input field. For text and number inputs you can also define a default value, which can then be overwritten
by other users. If you have selected a Selection Option Input building block, click the button next to Options
to define the list of options that the user can choose from.
Data Sources
Data sources allow you to use data stored in a separate file as input for the mashup. This could be, for example,
an XML file provided by an online service provider.

Data Sources

CSV Data Source Use a CSV file as input for the mashup. You can choose to either upload a file or reference an
online CSV file.

XML Data Source Use an XML file as input for the mashup.

5. Select the services you want to integrate into the mashup.

All Web services that have been configured and activated in the Mashup Web Services view are listed in the
pane on the left of the screen and can be integrated into the mashup. These Web services are either SAP
partner Web services or additional services you have created.
Drag and drop an existing service onto the authoring canvas, or use the New menu to create a new Web
service.
6. Using the mouse cursor, draw a connecting line between any mashup in-ports, user inputs, or data sources
and the Web service.
This establishes the logical order of the mashup. It is possible to connect one mashup in-port with multiple
services. After connecting the service to a user input or in-port, you can then edit the service parameters, if
applicable.
7. Add actions to the mashup by dragging and dropping them onto the authoring canvas and drawing a
connecting line between them and the service. Actions allow you to transform the content retrieved by the
Web services. You have the following options:

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 495
 Actions

Filter Data Filter the items returned by the service. You can create rules based on the parameters provided
by the service.

Sort Data Sort the display order of items in the results based on the parameters provided by the service.

Truncate Data Truncate the number of items displayed in a feed after a given number.

Merge Data Merge multiple feeds to display in a common results list. You can use this action to combine
data from two sources that have the same format into a single results list.

Join Data Join two data sources based on conditional rules to form a new data source. You can use this
action to combine data from two sources that do not have the same format.

Add Field Add one or more fields available in the parameters returned by the service to the results.

Rename Field Rename one or more fields in the results.

Delete Field Delete one or more fields from the results.

Extract Field Extract a specific piece of information from the results, for example to use as input for another
service within the same mashup.

Replace Text Replace a specific piece of text in the results with a different text.

Convert Text Convert text based on conditional rules. For example, by applying formatting to the text.

Concatenate Text Concatenate text in the results. For example, you can use this action to concatenate two
parameters in the search results to display in the same field.

Replace Value Replace a value in the results based on conditional rules.

Arithmetic Operation Perform an arithmetic operation with the results based on operation rules.

8. For mashup categories that allow the results data returned by the service to be integrated back into the screen,
you can add a Mashup Out-Port building block to the mashup using drag and drop.
9. Click Preview Result .
To preview the mashup results you may have to manually add a value to the input field of the mashup in-port
or user input. To do this select the building block and under properties, enter a value. In the runtime version,
these values will be replaced automatically by either the parameter taken from the screen out-port or by the
user entering their own value.

If you are using a service that uses the authentication method OAuth, then you will need to log on to
the service and generate a PIN code in order to preview the service results. Afterwards when users are
accessing the mashup, they will be prompted to create their own PIN code.

10. Adjust the display settings of the mashup results.

By default, the results are displayed in a table format. Click Edit Display Settings and select one or more
formats in which the mashup will be made available to all users. You must specify a default display option.
For each display option you can also configure additional display properties, such as the maximum number
of items that should be displayed. Note that the XML view is provided for your information while creating the
mashup but will not be shown to other users.
11. If required, you can also change the default refresh settings that are used to determine when the Web service
used in the mashup is called. You have the following options:
● Refresh on Mashup Loaded: Deselect this checkbox if you do not want the Web service to be called when
the mashup is loaded for the first time.
● Refresh on In-Port Data Changed: Deselect this checkbox if you do not want the Web service to be called
when the user changes the in-port value.

SAP Cloud Applications Studio – Version May 2018 (1805)

496 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 These options can be used if, for example, your mashup involves complex services such as calculations or
uses a paid service such as an SMS sending service that should only be triggered manually.
12. On the Review step, you can view how the mashup will be displayed to users. Review your settings and click
Finish to create the mashup.

Result
When you return to the studio, click Refresh to display the mashup in the Solution Explorer.
You can now do the following tasks:
● Add a Mashup to an SAP Floorplan [page 504]
● Add a Mashup to Your Floorplan [page 513]

See Also
Mashups Quick Guide [page 475]

8.13.3.4 Create an HTML Mashup

Overview
In the studio, you can create HTML mashups to embed an HTML or JavaScript based Web page into a screen.

Some Web services may pass your business data to a third-party organization, for example, account data is
passed to a search engine when performing a reverse lookup in an online address book. We recommend that
you check whether the mashup conforms to your company’s data privacy policies before activating the
mashup.

Prerequisites
You know the URL of the Web site that you want to embed.
● You must enable the admin mode for the solution in which you create the mashup to ensure that the system
saves your content and any changes you make in the solution. To do this, open your solution and select
Administration Switch On/Off Admin Mode in SAP Solution . For more information about the admin
mode, see Working in the Integrated Development Environment [page 37].

Procedure
Open your solution. In the Solution Explorer, do one of the following steps:
● If you are creating a mashup for the first time for this solution, right-click Add-on Solution (In Development),
then select Add New Item Create HTML Mashup .
● If you have already created a mashup for this solution, you can simply right-click MashupAuthoring and select
Create HTML Mashup.

The SAP cloud solution opens. If required, enter your user and password, then do the following steps:
1. Select a mashup category.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 497
 The mashup category is used to group mashups by the type of information they provide. It is shown to business
users when they personalize mashups in the side panel.
2. For the mashup category, you then select the port binding that you want to use in the mashup. This information
is not shown to business users.
The port binding defines which screen out-ports or in-ports can be used in the mashup and on which screens
the mashup can be used.
3. Enter a name and a description for the mashup.
The mashup name will be displayed to business users when using the mashup.

By default, the mashup has the status Active. This means it will be available for use when saved. If you
want to prevent users from accessing the mashup immediately, change the status to Inactive.

4. Under Configuration Information, adjust the display height, as required. The default height is 327 pixels.
5. Specify the type of mashup you want to create. That is, select whether you want to enter HTML code or a
URL.
6. Depending on what you have selected, do one of the following:
● Enter a URL
1. Enter a URL in the URL field and click Extract Parameters .
The system extracts the parameters from the URL and adds them to the table below, where you
can edit constants and bind parameters to the screen out-ports available for the selected port
binding.

For URLs that do not use queries you can manually add curly brackets around terms that
should act as placeholders. For example, in the URL https://mail.google.com/mail/
#search/SAP, you can replace the word SAP with a search term in curly brackets, for
example, {term}. If you then enter https://mail.google.com/mail/#search/
{term} in the URL field and click Extract Parameters , the word in brackets is extracted as a
parameter.

2. Click Preview to display the end result of the mashup.

● Enter HTML Code
1. In the HTML Code Editor you can copy or enter your own HTML code.
In addition, you can use a third-party REST service or create your own REST service. We recommend
that you use JSON service protocol for your REST service.
To add the Web service to the HTML mashup, click Add REST Service and select a Web service from
the REST Services dialog box. The code template of the API is inserted automatically in the HTML
code editor.

To assist you in coding HTML Mashups, some example APIs are documented here: Example
APIs for HTML Mashups [page 499].

2. Under Input Parameters and Output Parameters, the parameters are listed depending on the port
binding that you have chosen. If required, you can copy the string code for a parameter to the HTML
code editor by selecting the parameter and clicking Copy . The string code of the parameter is
copied to the first row of the editor. You can then move this code string to the required location in
the code.
3. Click Preview to display the end result of the mashup.
4. To test the mashup, you can enter sample values for the parameters, and click
Update Parameter Values to the right of the HTML code editor.

SAP Cloud Applications Studio – Version May 2018 (1805)

498 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 If you change the code, you need to click Preview again to display the updated result of the
mashup.

7. Save your changes.

Result
When you return to the studio, click Refresh to display the mashup in the Solution Explorer.
You can now do the following tasks:
● Add a Mashup to an SAP Floorplan [page 504]
● Add a Mashup to Your Floorplan [page 513]

See Also
Mashups Quick Guide [page 475]

8.13.3.5 Example APIs for HTML Mashups

Overview
This document provides some example APIs to help you to code HTML mashups.

Any software coding or code lines/strings (“Code”) provided in this documentation are only examples
and are not intended for use in a productive system environment. The Code is only intended to better
explain and visualize the syntax and phrasing rules for certain SAP coding. SAP does not warrant the
correctness or completeness of the Code provided herein and SAP shall not be liable for errors or damages
cause by use of the Code, except where such damages were caused by SAP with intent or with gross
negligence.

External REST Service Call

Method
sap.byd.ui.mashup.callService(serviceOptions)
Usage
When you click Add REST Service in the toolbar of the editor, the code template of this API is inserted automatically.
Parameters
serviceOptions is a JSON object with the following parameters:

Parameter Description Mandatory/Optional

serviceID The ID of the REST service called Mandatory

parameter A JSON object that parameterizes the service Optional

onComplete Callback method name if the service call succeeds Optional

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 499
Parameter Description Mandatory/Optional

onError Callback method name if the service call fails Optional

Example
sap.byd.ui.mashup.callService({
serviceId: 'CW00001'
parameter: {'query': 'SAP',},
onComplete: 'serviceCallback_CW00001',
onError: 'exceptionHandler_CW00001'
});

Responding to Application Context Update

Method
sap.byd.ui.mashup.onContextUpdate()
Usage
If a port binding is assigned in the mashup, all the context parameters from out-port of the application and the pre-
defined system parameters are displayed in the Input Parameters table. If you select an input parameter and click
Copy , the system automatically copies the parameter in the selected row as a code string to the first line of the
editor. You can then move this code string to the required location in the code.
After you have finished entering the code and clicked Preview to preview the results of the mashup, you can test
the onContextUpdate API. Enter sample values for the input parameters and then click Update Parameter Values .
Parameters
The context can be accessed via sap.byd.ui.mashup.context, which is a JSON object with the following objects:
● In-port
if the mashup defines port binding, the values from the corresponding application out-port can be accessed
by using inport.ParameterName.
● System
Mashup system parameters

Parameter Description

system.LogonLanguage Current display language in your SAP solution

system.ProductVersion Current version of your SAP solution

system.ShortHostname Short host name of your SAP solution

Example
sap.byd.ui.mashup.onContextUpdate = function() {
var ctx = sap.byd.ui.mashup.context;
// context parameters
console.log('Logon language:' + ctx.system.LogonLanguage);
// whole list of parameters for Port Binding Reverse Lookup
console.log('Company name:' + ctx.inport.CompanyName);
console.log('Address:' + ctx.inport.Address);
console.log('Street:' + ctx.inport.AddressStreet);
console.log('Street with house No.:' + ctx.inport.AddressStreetHouseNumber);
console.log('House No.:' + ctx.inport.AddressHouseNumber);

SAP Cloud Applications Studio – Version May 2018 (1805)

500 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 console.log('City:' + ctx.inport.AddressCity);
console.log('Country:' + ctx.inport.AddrssCountry);
console.log('Country code:' + ctx.inport.AddressCountryCode);
console.log('Postal code:' + ctx.inport.AddressPostalCode);
console.log('State/province:' + ctx.inport.AddressStateProvince);
console.log('State/province code:' + ctx.inport.AddressStateProvinceCode);
};

Write Back Data to Application UI

Method
sap.byd.ui.mashup.fireResultUpdate(resultObject)
Usage
To consume this API, a writeback port binding (for example, Reverse Lookup) should be specified in the mashup.
The Output Parameters table contains the parameters used to write back data to the corresponding application in-
port. Click Copy to copy the corresponding parameter of the selected row to the editor. Using this API method, the
preview values are filled with the values from the HTML application.
Parameters
resultObject is a JSON object which reflects the corresponding in-port of the application UI.
Example
// Example: Port Binding Reverse Lookup
// Address is a local object.
sap.byd.ui.mashup.fireResultUpdate({
'CompanyName': address.name,
'AddressStreetHouseNumber': address.street,
'AddressStreet': address.street,
'AddressCountryCode': address.country,
'AddressStateProvinceCode': address.state,
'AddressCity': address.city,
'AddressPostalCode': address.zipCode
});

See Also
Create an HTML Mashup

8.13.3.6 Create a Mashup Web Service

Overview
In the studio, you can create mashup Web services that can then be integrated into a data or HTML mashup. RSS/
Atom, REST, SOAP, and OData Web services are supported.

Prerequisites
● For RSS or Atom feeds, you know the end-point URL of the Web service or the WSDL location.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 501
 ● For REST Web services, you need to know the request URL as well as any relevant parameters.
● For SOAP Web services, you need to know the WSDL location (URL).

Typically, you can find this information on the Web site of the service provider.

You can also integrate an external SOAP or REST Web service into your solution. To do this, you use the
External Web Service Integration Wizard.
For more information, see Integrate an External Web Service Using SOAP [page 551] and Integrate an
External Web Service Using REST [page 552] .

Procedure
Open your solution. In the Solution Explorer do one of the following steps:
● If you are creating a mashup Web service for the first time for this solution, right-click Add-on Solution (In
Development), then select Add New Item Create .... Mashup Web Service (for example, Create REST
Mashup Web Service).
● If you have already created a mashup Web service for this solution, you can simply right-click
MashupAuthoring and select Create .... Mashup Web Service (for example, Create REST Mashup Web
Service).

The SAP cloud solution opens. If required, enter your user and password, then do the following steps:
1. Enter a name and description for the Web service.
2. Select whether you want the Web service to have the status Active or Inactive.

Only active Web services can be used.

3. Depending on the type of mashup you are creating, do the following:

RSS or Atom Feed
a. On the New RSS/Atom Service screen, under Service Information, select an authentication method, if
required.

You can only use the OAuth standard to authenticate users accessing the service if OAuth is
supported by the provider. You can find all of the information required on the provider's Web site.

b. Enter the URL of the RSS or Atom feed and click Extract Parameters .
The system extracts any parameters and displays them under Input Parameters. You can adjust these
as required. Note that only those parameters that have empty constants can later be mapped to a
mashup in-port or user input with default or dynamic values when creating a data mashup.

For URLs that do not use queries you can manually add curly brackets around terms that should act
as placeholders. For example, in the URL https://mail.google.com/mail/#search/SAP, you
can replace the word SAP with a search term in curly brackets, for example, {term}. If you then enter
https://mail.google.com/mail/#search/{term} in the URL field and click
Extract Parameters , the word in brackets is extracted as a parameter.

REST
a. On the New REST Service screen, under Service Information, select an authentication method, if required.

SAP Cloud Applications Studio – Version May 2018 (1805)

502 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 You can only use the OAuth standard to authenticate users accessing the service if OAuth is
supported by the provider. You can find all of the information required on the provider's Web site.

b. Select an HTTP method.

c. Depending on the method you selected, do the following:
If you selected GET:
1. Enter the URL of the Web service and click Extract Parameters .
2. The system extracts any parameters and displays them under Input Parameters. You can adjust
these as required.

For URLs that do not use queries you can manually add curly brackets around terms that
should act as placeholders. For more information, see the related note in the RSS or Atom
Feed section above.

If you selected POST:

1. Select a content type. If you select Form, proceed as described above for the GET method. If you
select XML Body, proceed as follows.
2. Enter the URL of the Web service and the XML code.
3. Click Generate Body Parameters to extract the parameters from the code, if applicable.
The system extracts any parameters and displays them under Input Parameters. You can adjust
these as required. Note that only those parameters that have empty constants can later be mapped
to a mashup in-port or user input with default or dynamic values when creating a data mashup.

You can also use curly brackets to define parameters in POST XML bodies. For example, you
can replace a value returned by the REST service with a placeholder, for example
{placeholder}, which can then be mapped to a screen out port in a mashup.

d. Under Output Parameters, click Simulate to preview the information that is returned by the Web service.

SOAP
a. On the New SOAP Service screen, under Service Information, enter the WSDL URL and click Import .
The system extracts the WSDL content.
b. Select a service operation.
c. If required, click Copy Description to copy the service operation description into the mashup’s Service
Description under General Information.
d. Enter constants, if required.
Only those parameters that have empty constants can later be mapped to a mashup in-port or user input
with default or dynamic values when creating a data mashup.

The following restrictions apply when creating SOAP-based Web services: the XSD extensions
union, list, and restriction are not supported; it is not possible to use header messages, imports
in WSDLs, and maximum or minimum occurrence indicators; the XSD complex type structure is
always handled as a sequence; for WSDLs containing more than one service, multiple ports with
the same name are not supported; and SOAP 2.0 is not supported.

e. Under Output Parameters, click Simulate to preview what information will be returned by the Web
service.
4. Save your changes.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 503
Result
If the status of the Web service is active, it will be made available to integrate into a data or HTML mashup.
If the status of the Web service is inactive, you can edit and activate it at a later date from the Mashup Web Services
view in SAP's cloud solution.

See Also
Using a Mashup Web Service in a Script File [page 507]
Mashups Quick Guide [page 475]

8.13.3.7 Add a Mashup to an SAP Floorplan

Overview
When you add a mashup to an SAP floorplan, you can specify how it should appear on the screen. The following
options are available:
● As an embedded pane
This pane displays the mashup content directly in a section on the screen.
● As a new tab
● As a menu button
The mashup can be accessed from Web Services located at the top of a screen.
● As a link in a section of a screen
The link opens the mashup in a separate browser window.

The options that are available depend on the mashup itself and the anchors that the floorplan has. The following
table lists the anchors and the possible appearances on the screen.

Anchors and Appearance on Screen

Add Mashup Through Appearance on Screen

Floorplan anchor Embedded pane on a section of a screen

Menu button

Outport anchor Embedded pane on a section of a screen

Tab
Menu button
Link in a section of a screen

Section group anchor Embedded pane on a section of a screen

Link in a section of a screen

Switch navigation anchor Tab

Overview page anchor Embedded pane on a section of a screen

You can also choose an extension field to allow the user to toggle the display of the mashup on the screen by selecting
and deselecting this extension field.

SAP Cloud Applications Studio – Version May 2018 (1805)

504 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Prerequisites
● You have created the mashup. For more information, see:
○ Create a URL Mashup [page 492]
○ Create an HTML Mashup [page 497]
○ Create a Data Mashup [page 494]

● You must enable the admin mode for the solution in which you create the mashup to ensure that the system
saves your content and any changes you make in the solution. To do this, open your solution and select
Administration Switch On/Off Admin Mode in SAP Solution . For more information about the admin
mode, see Working in the Integrated Development Environment [page 37].

● The SAP floorplan must have an existing outport with a stable anchor and a referenced anchor. You cannot
create your own outports for SAP floorplans.

Procedure
1. Open the SAP floorplan.
a. In the studio, right-click one of your floorplans in your solution, and select Open in UI Designer.
The UI designer opens.
b. In the UI designer, go to Configuration Explorer, and navigate to the SAP floorplan in which you want
to add the mashup.
c. Right-click the SAP floorplan, and click Open.
The SAP floorplan opens in the Designer tab.
2. Add the mashup to the SAP floorplan.
You can do this in the following ways:
Add Mashup Through a Floorplan Anchor
a. In the Configuration Explorer, open an SAP floorplan that has a floorplan anchor.
b. Right-click the floorplan in the Designer tab, and choose Select Floorplan .
c. In the Extensibility Explorer, under Operations, click Widget Mashups Management .
A dialog box opens, and a list of available mashups is displayed.
d. Select the required mashup.
The configuration details are displayed below.
e. Select the checkbox in the Visible column. This allows the mashup to be displayed on the screen.
f. Select the required appearance in the Appearance field.
g. If a mashup should be displayed using the entire width of the screen, select Full Screen Width.
h. If there are extension fields of the type boolean, you can select an extension field in the Visibility
Binding field, to allow the user to toggle the visibility of the mashup on the screen
i. Click Apply.
The system creates a change transaction.
j. Save and activate your changes.

Add a Mashup Through an Outport Anchor

a. In the Configuration Explorer, open an SAP floorplan that has an outport anchor.
b. In the Controller tab, choose an outport under the Outports node.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 505
 c. In the Extensibility Explorer, under Operations, click Mashups Management .
A dialog box opens, and a list of available mashups is displayed.
d. In the Visible column, select the checkbox for each mashup that you want to add to the floorplan.

If the Visible column for a mashup is disabled, it means that the mashup is already available on
the floorplan. To remove the mashup, you need to delete the corresponding change transaction
in Extensibility Explorer.

e. Select a mashup to configure it.

The configuration details are displayed below.
f. Select the required appearance in the Appearance field.
g. If the mashup should be displayed using the entire width of the screen, select Full Screen Width.
h. If there are extension fields of the type boolean, you can select an extension field in the Visibility
Binding field, to allow the user to toggle the visibility of the mashup on the screen
i. Click Apply.
The system creates a change transaction.
j. Save and activate your changes.

Add a Mashup Using a Section Group Anchor

a. In the Configuration Explorer, open an SAP floorplan that has a section group anchor.
b. Select a section group in the floorplan.
c. In the Extensibility Explorer, under Operations, click Mashups Management .
A dialog box opens, and a list of available mashups is displayed.
d. In the Visible column, select the checkbox for each mashup that you want to add to the floorplan.

If the Visible column for a mashup is disabled, it means that the mashup is already available on
the floorplan. To remove the mashup, you need to delete the corresponding change transaction
in Extensibility Explorer.

e. Select a mashup to configure it.

The configuration details are displayed below.
f. Select the required appearance in the Appearance field.
g. Click Apply.
The system creates a change transaction.
h. Save and activate your changes.

Add a Mashup Through a Switch Navigation Anchor

a. In the Configuration Explorer, open an SAP floorplan that has a switch navigation anchor.
b. Right-click the floorplan in the Designer tab, and choose Select NavigationItem .
c. In the Extensibility Explorer, under Operations, click Mashups Management .
A dialog box opens, and a list of available mashups is displayed.
d. Select the required mashup.
The configuration details are displayed below.
e. Select the checkbox in the Visible column. This allows the mashup to be displayed on the screen.

If the Visible column for a mashup is disabled, it means that the mashup is already available on
the floorplan. To remove the mashup, you need to delete the corresponding change transaction
in Extensibility Explorer.

SAP Cloud Applications Studio – Version May 2018 (1805)

506 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 f. Select the required appearance in the Appearance field.
g. If a mashup should be displayed using the entire width of the screen, select Full Screen Width.
h. If there are extension fields of the type boolean, you can select an extension field in the Visibility
Binding field, to allow the user to toggle the visibility of the mashup on the screen
i. Under Parameter Binding, select the required extension fields to be bound to the parameters.

Parameters that are marked with an asterisk (*) are mandatory.

j. If the mashup has an output parameter, select an extension field for output binding.
k. Click Apply.
The system creates a change transaction.
l. Save and activate your changes.

Add a Mashup Through an Overview Page Anchor

a. In the Configuration Explorer, open an SAP floorplan that has an overview page anchor.
b. In the Extensibility Explorer, under Operations, click Add Content to Overview .
A dialog box opens.
c. In the Type field, select Mashup from the dropdown list.
The dialog box changes.
d. In the Mashup field, select the mashup that you want to add to the floorplan from the dropdown list,
and click Apply .

If the selected mashup is already part of the view, the Apply button is disabled.

e. If the mashup should be displayed using the entire width of the screen, select Full Screen Width.
f. Save and activate your changes.

Result
The mashup is now visible on the floorplan.

To remove a mashup from an SAP floorplan, you need to delete the corresponding change transaction in the
Extensibility Explorer of the UI designer, under Operations.

See Also
Mashups Quick Guide [page 475]

8.13.3.8 Using a Mashup Web Service in a Script File

Overview
If you have configured a REST or RSS/Atom mashup Web service, you can implement the call of this Web service in
a script file of your solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 507
Prerequisites
● You have defined an active REST or RSS/Atom mashup Web service in your solution, either with basic
authentication or without authentication.
● You have created a solution with at least one business object. In the example below, an action has been added
to the business object definition.

Process Flow
1. Create a REST or RSS/Atom mashup Web service in your solution.
For more information, see Create a Mashup Web Service [page 501].
After you have created the mashup Web service, choose Simulate in the Mashup Web Services view to test
it.
2. Create a script file for your business object, for example, an action.
3. Define the business logic to call the mashup Web service. The following is an example of an action.

import AP.Common.GDT;
var serviceID : LANGUAGEINDEPENDENT_Text;
var parameter : NameAndValue;
var parameters : collectionof NameAndValue;
serviceID = "PW00001";
parameter.Name = "keywords";
parameter.Value = "Rome";
parameters.Add(parameter);
var result = WebServiceUtilities.ExecuteWebService(serviceID,
parameters);
var content = result.ResponseContent;
var returnCode = result.ReturnCode;

The parameters of this Web service call are as follows:

● Input Parameters
○ Service ID (mandatory)
The ID of the REST or RSS/Atom mashup Web service of type String. Do not include the solution
namespace. For example, if the service ID is displayed as follows: YUYYRY2MY_MAIN/PW00001, use
only PW00001 in the call.
○ Parameters (optional)
Parameter of type collectionof NameAndValue. This refers to the table of input parameters
defined in the mashup Web service.
● Result
The type is WSCallResult and contains the following elements:
○ ReturnCode
The return code of the Web service call as String.
○ ResponseContent
The content of the response as String.
4. Save your script file.

SAP Cloud Applications Studio – Version May 2018 (1805)

508 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.13.3.9 Add a URL Mashup to an SAP Floorplan

Overview
In this example you are going to add a URL mashup to the quick activity (QA) floorplan. This mashup will display the
car park location on a map, based on the location information entered.

Prerequisites
● You have completed the example: Building a Solution [page 93]
● The mashup has been created in the SAP cloud solution. For more information, see Mashups Quick Guide
[page 475].

Procedure
1. Add an element on the root level of the Car Park business object to record location information.
element CarParkLocation : LANGUAGEINDEPENDENT_Text;
2. Save and activate the business object.
3. Double-click the quick activity floorplan to open it in the UI designer.
4. Click the Update Metadata button to update the BO metadata.
5. Drag the CarParkLocation from the BO Browser / Data Model onto the Designer tab.
6. Change the label for the field to Car Park Location.
7. On the Controller tab, perform the following actions:
a. Add a new outport with the name URL_Mashup_OutPort and the following settings:
● PortType Package = /SAP_BYD_TF/Mashups/globalmashupsupporttypes
● PortType Reference = Address_Info
b. Bind the Address parameter to the CarParkLocation data field.
c. In the Property Explorer, select the QA floorplan from the drop-down list at the top.
d. Click the Anchor field under Extensibility.
The Anchor Modelling dialog box appears.
e. Click the plus sign to create a stable anchor for the floorplan.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 509
 f. In the Property Explorer, select the mashup outport from the drop-down list at the top.
g. Click the Anchor field under Extensibility.
The Anchor Modelling dialog box appears.
h. Click the plus sign to create a stable anchor for the floorplan.
i. In the Property Explorer, click the Referenced Anchor field under Extensibility.
The Anchor Modelling dialog box appears.
j. Click the plus sign to create a referenced anchor for the outport.
k. Click the three dots next to the XRep Path field.
l. In the Configured Anchors dialog box, click the anchor you created for the QA floorplan.

SAP Cloud Applications Studio – Version May 2018 (1805)

510 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 8. Save and activate.
9. Click the Designer tab.
10. In the Extensibility Explorer, select the mashup outport and click the Mashups Management button.
The Mashups Management dialog box appears, listing the available mashups.
11. Select the mashup you want to use and click Apply.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 511
 12. Save and activate.

Result
The mashup is available from the Web Services menu on the QA. When you click the mashup, the URL is opened with
the value entered into the Car Park Location field as an input parameter.

SAP Cloud Applications Studio – Version May 2018 (1805)

512 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.13.3.10 Add a Mashup to Your Floorplan

Overview
When you add a mashup to a floorplan that you have designed, you can specify how it should appear on the screen.
The following options are available:
● As an embedded pane, with or without a port
This pane displays the mashup content directly in a section on the screen.
● As a new tab
● A menu button in a function bar
The mashup can be accessed from Web Services in the function bar at the top of a floorplan.
● A menu button in a list toolbar
The mashup can be accessed from Web Services in the toolbar at the top of an object worklist.
● A link in a section of a screen
This link opens the mashup in a separate browser window.

The options that are available depend on the mashup type. The following table lists the mashups and the possible
appearances on the screen.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 513
Mashups and Appearance on Screen

Mashup Type Appearance on Screen

Data mashups that write data back into the SAP cloud Embedded pane on a section of a screen, with or without a port
solution Menu button to a function bar
URL mashups Menu button to a list toolbar
Link in a section of a screen

Data mashups that do not write data back into the SAP cloud Embedded pane on a section of a screen
solution
HTML mashups

Prerequisites
● You have created the mashup. For more information, see:
○ Create a URL Mashup [page 492]
○ Create an HTML Mashup [page 497]
○ Create a Data Mashup [page 494]

● You must enable the admin mode for the solution in which you create the mashup to ensure that the system
saves your content and any changes you make in the solution. To do this, open your solution and select
Administration Switch On/Off Admin Mode in SAP Solution . For more information about the admin
mode, see Working in the Integrated Development Environment [page 37].

Procedure
1. Open your floorplan.
a. In the studio, in the Solution Explorer, right-click your floorplan and select Open in UI Designer.
The UI designer opens.
2. Add the mashup to your floorplan.
Choose one of the following options to add a mashup to your floorplan:
Add a Mashup as a Link / Button in a Function Bar or a List Toolbar / Section of a Screen
a. In the Controller, right-click Mashup Components, and select Add Mashup Component.
A dialog box opens.
b. In the dialog box, go to the main folder of your solution and the folder where the mashups are stored.
c. Select a URL mashup or a data mashup that writes data back into the SAP cloud solution, and click
OK.
d. Go to the Toolbox tab to add a navigation item for a function bar or a list toolbar, or as a link to a section
group.

If the Toolbox tab is not visible, make it visible by going to View Toolbox

e. In the Controls section, drag and drop the required element (Link / Button / SectionGroup ) to the
floorplan.
f. Add an event argument with argument name $MashupPipeID, and a constant the target mashup
component ID, for example,TM00020.
g. Create a new event handler, and add two operations: SyncDataContainer and FireOutport.

SAP Cloud Applications Studio – Version May 2018 (1805)

514 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 h. For FireOutport, select an available outport such as Address_Info_Out. If there is no outport for this
floorplan, add a new outport in the Controller.
i. On the Properties tab, under Events, assign the event handler to a navigation item, for example,
OnClick.
j. In the Simple Navigation tab, right-click on the Navigations folder, and select Add Navigation from the
context menu.
k. Select the outport and the inport from the dropdown lists.
l. Bind the outport and inport parameters.

The outport that you select here should be the same outport that you selected for FireOutport
a few steps previously.

m. Save and activate your changes.

Add a Mashup With Port as an Embedded Pane

a. In the Configuration Explorer, select a mashup that is a an embedded pane, and drag it to a section of
the floorplan.
b. In the Controller, right-click Mashup Components, and select Add Mashup Component.
A dialog box opens.
c. In the dialog box, go to the main folder of your solution and the folder where the mashups are stored.
d. Select a mashup that has the same pipe ID as the one you have just selected, and click OK.
e. In the Simple Navigation tab, right-click on the Navigations folder, and select Add Navigation from the
context menu.
f. Select the outport and the inport from the dropdown lists.
g. If your floorplan does not have an outport, add an outport as follows:
1. On the Controller tab, right-click Outports.and choose Add Outport.
The new outport is displayed under Outports.
2. In the Port Type Package field, click ... to select a port type package.
3. In the dialog box, go to SAP_BYD_TF Mashups , choose globalmashupporttypes, and
click OK.
4. In the Port Type Reference field, select a port type reference from the dropdown list.
5. If there are parameters displayed in the table below, you can bind them. To do this, click ... next
to Parameter Binding.

If you do not bind the parameters, you will not be able to pass the values from the floorplan
to the mashup.

6. In the dialog box, choose the required element of the business object and click OK.
h. Bind the outport and inport parameters.
i. Save and activate your changes.

Add a Mashup Without Port as an Embedded Pane

a. In the Configuration Explorer, select a mashup that is an embedded pane, and drag it to a section of
the floorplan.
b. Save and activate your changes.

Add a Mashup as a Tab

a. Right-click the floorplan, and choose Select NavigationItem .

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 515
 b. Under Misc, click ... next to NavigationItems to configure the properties.
c. In the dialog box, select a view and click Add.
d. On the new view, add a mashup with or without a port as explained in the previous sections.
e. Save and activate your changes.

Result
You can now test the mashup in your floorplan by clicking the Run the Component button (green triangle) in the
toolbar.

See Also
Example: Add a URL Mashup to Your Floorplan [page 516]
Mashups Quick Guide [page 475]

8.13.3.11 Example: Add a URL Mashup to Your Floorplan

Overview
This example shows how to add a URL mashup as a link in a floorplan that you have designed.

Prerequisites
● You have created the mashup. For more information, see:
○ Create a URL Mashup [page 492]
○ Create an HTML Mashup [page 497]
○ Create a Data Mashup [page 494]

● You must enable the admin mode for the solution in which you create the mashup to ensure that the system
saves your content and any changes you make in the solution. To do this, open your solution and select
Administration Switch On/Off Admin Mode in SAP Solution . For more information about the admin
mode, see Working in the Integrated Development Environment [page 37].

Procedure
1. Add a link to your floorplan.
a. In the studio, in the Solution Explorer, right–click your floorplan and select Open in UI Designer.
The UI designer opens.
b. Go to the Toolbox tab.

If the Toolbox tab is not visible, make it visible by going to View Toolbox

c. In the Controls section, drag and drop Link to the floorplan.

The Link element is displayed on the floorplan. It contains a Link field and a Link hyperlink.

SAP Cloud Applications Studio – Version May 2018 (1805)

516 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 d. You can rename the text of the Link field. To do this, ensure that the Link element is selected.
e. On the Properties tab, under Text Information, click on the dropdown arrow in the Label field.
f. In the dialog box, enter the required text, and click OK.
The renaming of the hyperlink will be described later on in this document.
2. Add your mashup.
a. In the UI designer, go to the Controller tab of the floorplan.
b. Right-click on Mashup Components, and select Add Mashup Component from the dropdown list.
c. In the dialog box, go to the main folder of your solution and the folder where the mashups are stored.

This name starts with MAIN_<Solution Name> SRC Mashups Pipes <Pipe ID>

d. Select your mashup as follows.

● A URL mashup that is displayed in a new window
● A data mashup that writes data back into the solution
e. Click OK
The mashup is displayed on the Controller tab underneath Mashup Components.
3. Add an event.
a. In the UI designer, on the Designer tab, select the Link element in the floorplan.
b. On the Properties tab, under Data Information, select EventArguments and click ...
c. Click the Add Argument button.
A new event argument is added.
d. Under ArgumentName, rename the event argument to $MashupPipeID.

We recommend that you copy the name $MashupPipeID from this document and paste it
in the ArgumentName field.

e. Leave the dialog box open, and go to the .

f. In the , on the Solution Explorer tab, under MashupConfiguration Mashup Authoring , select the
mashup.
g. On the Properties tab, copy the value in the Repository field. This value has the format MAIN_Solution
Name>/<Pipe ID>.
h. Go back to the open dialog box in the UI designer, paste the value of the Repository field under
Constant, and click OK.
i. Save your changes.
4. Create a new outport.
a. On the Controller tab, right-click Outports.and choose Add Outport.
The new outport is displayed under Outports.
b. Right-click the outport and select Rename; then enter a new name for the outport.
5. Select a port type package for the outport.
a. In the Port Type Package field, click ...
b. In the dialog box, go to SAP_BYD_TF Mashups , choose globalmashupporttypes, and click
OK.
6. Configure a port type reference for the outport.
a. In the Port Type Reference field, select a port type reference from the dropdown list.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 517
 b. If there are parameters displayed in the table below, you can bind them. To do this, click ... next to
Parameter Binding.

If you do not bind the parameters, you will not be able to pass the values from the floorplan to
the mashup.

c. In the dialog box, choose the required element of the business object and click OK.
7. Create an event handler.
a. On the Controller tab, right-click Event Handlers and select Add EventHandler..
The new event handler is displayed under Event Handlers.
b. Right-click the new event handler and select Rename; then enter a new name for the event handler,
for example, MashupHandler.
c. Under EventHandler Operations, click the Add Operation button twice to add two new operations.
d. For each operation, under Type, click in the field and select the following operation types:
● SyncDataContainer
● FireOutport
e. Under Name, you can change the names of these operation types
f. For FireOutport, under Configure the operation, choose the outport that you created previously.
g. Save and activate your changes.
8. Specify the navigation for the mashup.
a. On the Controller tab, under Mashup Components, select the mashup.
b. Go to the Simple Navigation tab.
c. In the Navigations folder, right-click and select Add Navigation from the context menu.
The Navigation Details tab opens.
d. Select the outport and the inport from the dropdown lists.

The source is the outport of your floorplan; the target is the inport of the mashup category.

e. To map the outport and inport parameters from the floorplan to the mashup, select these, and click
Bind.
The results are displayed in the table below.
f. Save and activate your changes.
9. Assign the event handler to the mashup in your floorplan
a. Go to the Designer tab.
b. Select the Link element in the floorplan.
c. On the Properties tab, under Events, select OnClick, and select the event handler that you created
previously from the dropdown list.
10. Add a data field to your business object.
a. Go to the Data Model tab.
b. Right-click on your business object, and select Add Data Field from the context menu.
The data field is added to your business object.
c. Select DataField.
d. On the Properties tab, under Design, enter a text for Initial Value.
This text is used for the hyperlink that is displayed on the floorplan.

SAP Cloud Applications Studio – Version May 2018 (1805)

518 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 This text is not displayed in the floorplan in the UI designer, but you will see it when you test the
mashup.

11. Assign the data field to the mashup on your floorplan

a. Go to the Designer tab.
b. Select the Link element.
c. In the Properties tab, under Data Information, click the dropdown arrow next to Text.
d. In the dialog box, go to the Data Model tab.
e. Select DataField underneath your business object, and click OK.
12. Save and activate your changes.

Result
You can now test the mashup in your floorplan by clicking the Run the Component button (green triangle) in the
toolbar.

See Also
Add a Mashup to Your Floorplan [page 513]
Mashups Quick Guide [page 475]

8.14 Service Integration

8.14.1 Service Integration Quick Guide

In the studio, you can create synchronous or asynchronous message-based communication between a business
object and another communication partner, such as a different system, by means of Web-service technology.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Business and Technical Background

Web Services Quick Guide

The studio allows you to create a Web service on an SAP business object or on any of your business objects, which
can then be consumed by a client application. This enables remote access to the business object data. You can
integrate an external Web service into your solution and address it in your business logic to enable access from the
SAP cloud solution to a remote application. You can also select a set of inbound and outbound services to create a

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 519
communication scenario. This allows customers to create communication arrangements in the SAP cloud solution
to exchange business documents electronically. Communication for Web services is based on SOAP or REST.
For more information, see Web Services Quick Guide [page 529].

File Input Quick Guide

In the SAP cloud solution, the File Input Run view in the Application and User Management work center enables
administrators to create and schedule mass data runs for third-party data integration uploading files from other
systems. The file input process allows business documents containing the files to be imported without the need for
application-specific functionality. During a run, all files of the same type are input. The file input run receives inbound
messages containing the files via application-to-application communication.
For more information about this tool, see the relevant documentation for the SAP cloud solution.

Condition Evaluation for Internal Communication

Condition evaluation is used to determine when a business object needs to send a message to the target business
object, for example, a message to create or change a business object instance. For each business object identified
as relevant for the subsequent service integration process, the system can evaluate a start condition, change
condition and a cancel condition. By default, the system sends a message every time a business object is changed
or deleted. To reduce the amount of messages, you can define that a message is raised only, for example, when the
source business object has a specific status.
For more information, see Condition Evaluation for Internal Communication [page 521].

Tasks

Configure Internal Communication

You can use internal communication to exchange data between business objects that are located in different
deployment units (DUs). To communicate, the business objects exchange XML messages in an asynchronous way
which means that the source business object sends a request message to the target business object without
expecting a response.
For more information about this task, see Configure Internal Communication [page 523].

Create XML File Input

In the SAP cloud solution, administrators can use an XML file to import third-party data from other systems into a
business object. To enable this functionality, you create an XML schema definition in the studio. This schema
definition allows customers to create an XML file, which can then be used to import the data into the SAP cloud
solution.
For more information about this task, see Create XML File Input [page 524].

Define Service Integration Error Handling

Error and conflict handling is needed in message-based internal communication because there is no direct
interaction with the user who initiated the process. Thus the receiver of a message has to handle the problem and
has to trigger an appropriate resolution mechanism. A major part of development is to avoid error and conflict
situations by design but it is not possible to avoid these situations entirely. This means that you also need to consider
error and conflict situations in asynchronous communication.
For more information about this task, see Define Service Integration Error Handling [page 526].

SAP Cloud Applications Studio – Version May 2018 (1805)

520 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Implement the Condition Evaluation Logic for Internal Communication
For internal communication, you can implement the business logic for condition evaluation to specify when a
business object needs to send a message to the target business object, for example, a message to create or change
a business object instance.
For more information about this task, see Implement the Condition Evaluation Logic for Internal Communication
[page 528].

8.14.2 Condition Evaluation for Internal Communication

Overview
Condition evaluation is used to determine when a business object needs to send a message to the target business
object, for example, a message to create or change a business object instance. For each business object identified
as relevant for the subsequent service integration process, the system can evaluate a start condition, change
condition and a cancel condition. By default, the system sends a message every time a business object is changed
or deleted. To reduce the amount of messages, you can define that a message is raised only, for example, when the
source business object has a specific status.

Features
If you implement the evaluation logic for a condition, the system returns a Boolean value to express if the condition
is true or false, for example, based on the status of the source business object.

Condition evaluation checks the condition of the root node of a business object.

Condition Types
You can define the following conditions:
● Relevance Condition
Based on the data of the source business object, the system checks whether the business object instance is
relevant for service integration. The system evaluates the relevance condition first. If the result is true, the
message is sent to the business object and the system evaluates the start condition. If the result is false, the
message is not sent and the service integration process is not started.
● Start Condition
This condition starts the service integration process, if the business object instance was not yet involved in
the service integration process or if the process was canceled. If the result is true, the system starts the service
integration process, that is, it compiles and sends the message to the business object.
● Change Condition
If the service integration process for the business object instance has already started, the system evaluates
the change condition. If the result is true, that is, the business object instance has changed, the system sends
a change message. If the result of the change condition is false, the system evaluates the cancel condition.
● Cancel Condition
The system evaluates the cancel condition, if the result of the change condition is false.

Implementing the Evaluation Logic

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 521
When you create a condition, the system generates a script file. You implement the evaluation logic by using the
scripting language. For more information, see Implement the Condition Evaluation Logic for Internal Communication
[page 528].
The following methods are available for service integration script files:
● Return Statement
The return statement is mandatory for each condition because it returns the result of the evaluation. The
argument is a variable or a literal of Boolean type, for example, return true;. For more information, see
Return Values (Business Logic) [page 234].
● GetProcessContext Method
The GetProcessContext method is called for business object nodes. The following change notification fields
are available for this method:
○ IsActiveInProcess
The business object node was already sent and not canceled.

You cannot use this field in a relevance condition.

○ IsCreated
The business object node has been created.
○ IsUpdated
The business object node has been updated.
○ IsDeleted
The business object node has been deleted.

For more information, see Process Context (Business Logic) [page 228].
● InReconciliation Parameter
The InReconciliation parameter specifies that the service integration process is in reconciliation mode.
For more information, see Script File Parameter (Business Logic) [page 234].

The following example shows the code for the implementation of a relevance condition, a start condition
and a change condition:
● Relevance Condition
return true;
● Start Condition
return(this.SalesProcessingStatusCode == "2" ||
this.SalesProcessingStatusCode == "3");
● Change Condition
return true;

The scenario for this implementation is as follows: Service integration is relevant if the sales process is
started or finished. A start message will be sent if no message has been sent yet and the sales processing
status is “In Process” (code value: 2) or “Finished” (code value: 3). A change message will be sent if the
business object is changed and saved and the sales process is still in process or is finished. It is not
necessary to implement a cancel condition because the change condition is always true.

SAP Cloud Applications Studio – Version May 2018 (1805)

522 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.14.3 Tasks

8.14.3.1 Configure Internal Communication

You can use internal communication to exchange data between business objects that are located in different
deployment units. To communicate, the business objects exchange XML messages in an asynchronous way, which
means that the source business object sends a request message to the target business object without expecting a
response.

You have defined the Bonus Entitlement business object in the Customer Invoicing deployment unit. The
Employee Compensation Agreement business object is located in the Human Capital Management
deployment unit. To transfer the bonus to the employees, you need to define an internal communication
configuration between both business objects.

Prerequisite
You have created and activated your business object.

Procedure
1. Open your solution and, in the Solution Explorer, open the Service Integration Wizard either via the context
menu of your business object or via the Add New Item dialog:

Solution Explorer: Business Object Context Menu Solution Explorer: Add New Item Dialog

1. In the Solution Explorer, right-click a business 1. In the Solution Explorer, click Add New Item ( ).
object in your solution and select Create Service The Add New Item dialog opens.
Integration.... 2. Select SAP Service Integration Internal
The Service Integration Wizard opens.
Communication , enter a name and click Add.
2. In the Select Service Integration Type step, select
The Service Integration Wizard opens.
Internal Communication and click Next.
3. In the Create an Internal Communication step,
3. In the Create an Internal Communication step,
specify the sender and recipient of the
specify the sender and recipient of the
communication by doing the following:
communication by doing the following:
a. Optionally, change the name. Select a
a. Optionally, change the name and the sending
sending business object, a receiving
business object .
business object, and a receiving business
b. Select a receiving business object and a object node.
receiving business object node.
One of the business objects must be a
One of the business objects must be a custom business object.
custom business object.

b. Click Next.
c. Click Next

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 523
 2. In the Define Message Structure and Map to Receiving Business Object step, specify the message definition
and the identification attributes for the receiving business object as follows:
a. Specify the structure of the message by selecting the elements of the receiving business object and
its subnodes.
b. Optionally, change the interaction message name. The default name is Maintain.
c. Optionally, select a Readable ID and click Next.
3. In the Map Message Structure to Sending Business Object step, map the sending business object elements
to the receiving business object elements. For example, map the EmployeeID element of the source business
object Bonus Entitlement to the EmployeeID element of the Item node of the target business object
Employee Compensation Agreement.
To map an element, click a cell in the Receiving Business Object column. A dialog box appears in which you
select the elements of the sending business object by double-clicking them. Only compatible fields are
displayed.

You can also use the Propose Mapping function.

Click Next.
4. In the Instance Identification for Update step, define how node instances of the receiving business object are
identified for update by doing the following:
a. Under Instance Identification, select an alternative key or query.
● If you select Alternative Key, select the alternative key field.
● If you choose a query, for example, QueryByElements, choose the query parameters for the
query mapping. Map each query parameter to a message field. Click the Query Parameter field
twice and select a parameter, then click the Message Field field twice and select a field.
b. Under Identification of Subnode Instance, do the following:
● To prevent data that is not part of the message from being deleted in the receiving business object,
select Prevent Data Deletion.
● Choose a subnode and the corresponding key field(s). If needed, you can choose additional
subnodes and key fields.
c. Click Next.
5. In the Review step, check that the information you have entered is correct and click Finish.
A new service integration definition with the file extension .pid ( ) appears in the Solution Explorer.
6. To activate your service integration settings, in the Solution Explorer, right-click the service integration
definition and select Activate.

See Also
Define Service Integration Error Handling [page 526]
Implement the Condition Evaluation Logic for Internal Communication [page 528]

8.14.3.2 Create XML File Input

In the SAP cloud solution, administrators can use an XML file to import third-party data from other systems into a
business object.

SAP Cloud Applications Studio – Version May 2018 (1805)

524 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
To enable this functionality, you create an XML schema definition in the studio. This schema definition allows
customers to create an XML file, which can then be used to import the data into the SAP cloud solution.
For more information, see the relevant documentation of the SAP cloud solution.

Prerequisite
You have created a solution.

Procedure
1. Open your solution and, in the Solution Explorer, open the Service Integration Wizard as follows:

Custom Business Object SAP Business Object

1. In the Solution Explorer, right-click a 1. In the Solution Explorer, click Add New Item ( ).
business object in your solution and The Add New Item dialog opens.
select Create Service Integration. 2. Select SAP Service Integration XML File Input , enter
The Service Integration Wizard opens.
a name and click Add.
2. In the Select Service Integration Type The Service Integration Wizard opens.
step, select XML File Input and click
Next.

2. In the Create an XML File Upload step, do the following:

a. Optionally, change the name. Select a receiving business object and a receiving business object node.
b. Click Next.
3. In the Define XML File Structure step, do the following:
a. Select the elements of the business object and its subnode.
b. Optionally, select a Readable ID for identification in other processes.
c. Optionally, select List (Mass Processing). This allows your customer, for example, to upload several
customer invoice requests with one .xml file.
d. Click Next.
4. In the Instance Identification for Update step, define how node instances of the receiving business object are
identified for update by doing the following:
a. Under Instance Identification, select an alternative key or query.
● If you select By Alternative Key, select the alternative key field.
● If you select By Business Object Query, do the following:
1. Select a query, for example, QueryByElements.
2. Select the query parameters for the query mapping: Click the Query Parameter field twice
and select a parameter, then click the Message Field field twice and select a field.
Instead, you can also click Propose Mapping.
b. Under Identification of Subnode Instance, do the following:
● To prevent data that is not part of the message from being deleted in the receiving business object,
select Prevent Data Deletion.
● Choose a subnode and the corresponding key field(s). If needed, you can choose additional
subnodes and key fields.
c. Click Next.
5. In the Review step, check that the information you have entered is correct and click Finish.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 525
 A new service integration definition with the file extension .pid ( ) appears in the Solution Explorer.
6. To activate your XML file input settings, in the Solution Explorer, right-click the service integration definition
and select Activate.
The system does the following:
● It creates a folder within the standard WebDAV folder that is used by the SAP cloud solution. The name
of the new folder is as follows: ...\<your project name>\<your XML file input name>.
Customers need to use this folder at a later point in time for their XML file.
● It creates an XML schema definition.

To download the XML schema definition to your local PC, proceed as follows:
7. In the Solution Explorer, double-click your service integration definition.
The service integration definition opens in a document window and the information you have defined is
displayed on different tabs. On the Schema Definition tab, you can review the XML schema definition.
8. Select the General tab. Click the schema definition link and save the XML schema definition to your local PC.
You can now predefine the business tasks that an administrator can then monitor in the SAP cloud solution
if errors or conflicts occur during the upload of third-party data. For more information, see Define Service
Integration Error Handling [page 526].

If errors occur during the upload of third-party data to the SAP cloud solution, for example, when invalid
data violates the XML schema definition, the error messages are displayed in the system in the
Application Log. When error messages are raised by the business object itself they are displayed in the
Process Communication Errors view for administrators, or tasks are created and assigned to the users
responsible for the processing. The task are also displayed in the administrator's Work view within the
Application and User Management work center.

In cases of errors during the upload due to currency or alternate key inconsistencies in the XML file,
the system displays the upload status under Execution Details with a red light. This indicates that the
upload has failed. You can view the details of the error by clicking on the corresponding Application Log
ID.
Additionally, you can view the document under Unprocessed Files in the Application and User
Management work center, File Input view. You can delete the file and upload the XML again after the
required corrections have been made.

Result
Based on this XML schema definition, customers can create an XML file, for example, in Microsoft Office Excel. The
XML file is to be stored in the WevDAV folder that was created by the studio.

8.14.3.3 Define Service Integration Error Handling

Overview
You can predefine the business tasks that an administrator can monitor in the cloud solution if errors or conflicts
occur during asynchronous communication. To do this, you define the tasks and assign them to the appropriate
messages of the target business object.
In the cloud solution, the tasks will be assigned to the administrator who is responsible for the support area that the
target business object belongs to. To display the tasks, administrators navigate as follow: Application and User

SAP Cloud Applications Studio – Version May 2018 (1805)

526 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Management Business Data Consistency Process Communication Error and then choose Open Errors with
Incidents in the Show dropdown list.

Prerequisites
In the studio, you have created a service integration definition by creating an internal communication or xml file input
using the Service Integration Wizard. For more information, see Configure Internal Communication [page 523] or
Create XML File Input [page 524].

Procedure
1. In the studio, open the solution that contains the service integration definition for which you want to configure
the error handling.
2. In the Solution Explorer, double-click the *.pid ( ) file.
The service integration definition opens in a document window.
3. Select the Error Handling tab.
On this tab on the left, the message structure of the target business object is displayed. On the right, you can
define tasks that correspond to business object messages. These tasks are the business tasks that will appear
in the cloud solution.
4. In the Error Situations Solved by Task area, enter a short text for a task, for example, StartDateInvalid.

5. Assign the appropriate target business object messages to your task. To do this, select a message in the
message structure on the left and then click Assign. You can assign one or more messages to each task. The
messages then appear in the Assigned Messages area.
6. In the Error Situations Solved by Task area, click Long Text.
A text editor opens.
7. Enter the details about the error situation and how to solve it and then click OK.
The text editor closes and your text is displayed in the Long Text field.
8. Save your service integration definition.
9. In the Solution Explorer, right-click the *.pid file and select Activate.
During activation, a task list view with the name of the service integration definition and the
*.tasklistview file extension is created. You can only display the task list view in the user interface designer
(UI designer).
10. In the Solution Explorer, right-click a screen file and select Open in UI Designer.
11. In the UI designer, in the Configuration Explorer, open the Process Communication Errors work center view.
The view is located in the following folder: SAP_BYD_APPLICATION_UI/itsam/appmngt/pie/. The file
name of the view is PCE_WCView.
12. In the Extensibility Explorer, add the task list view to the Process Communication Errors work center view as
follows:
1. Select the PCE_WCView.ao.uianchor anchor and choose Assign Component To View.
2. In the Add Assigned Object dialog box, select the TaskListView type.
3. In the Component field, click ... and select your task list view. The view is located in the SRC subfolder
of your project folder. For example, if the name of your project is A2BCD300, the folder name is
MAIN_A2BCD300/SRC/.
4. Click Apply.
13. Save and activate the PCE_WCView file.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 527
See Also
Service Integration Quick Guide [page 519]

8.14.3.4 Implement the Condition Evaluation Logic for Internal

Communication

For internal communication, you can implement the business logic for condition evaluation to specify when a
business object needs to send a message to the target business object, for example, a message to create or change
a business object instance.
For more information, see Condition Evaluation for Internal Communication [page 521].

Prerequisites
In the studio, you have created a service integration definition by using the Service Integration Wizard. For more
information, see Configure Internal Communication [page 523].

Procedure
1. In the studio, open the solution that contains the service integration definition for which you want to implement
the condition evaluation.
2. In the Solution Explorer, open the service integration definition by double-clicking the *.pid file.
The service integration definition opens in a document window.
3. On the Conditions tab, select a condition, for which you want to implement the evaluation logic, for example,
Relevance Condition, and click Add.
The studio generates a script file that opens in a separate document window.
4. In the code editor, define the evaluation logic for the condition.
The condition must contain at least a return statement that returns the result of the condition evaluation with
a Boolean return value. For more information, see Service Integration Methods [page 235].
5. Optional: Add further conditions and define the respective evaluation logic.
6. Save the service integration definition. Then right-click the service integration definition and select Activate
Script Files.
The script files for the implementation of the condition evaluation logic are activated.

The script files do not appear in the Solution Explorer. However, you can only select Activate Script
Files if script files exist.

See Also
Service Integration Quick Guide [page 519]

SAP Cloud Applications Studio – Version May 2018 (1805)

528 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.15 Web Services

8.15.1 Web Services Quick Guide

The studio allows you to create a Web service on an SAP business object or on any of your business objects, which
can then be consumed by a client application. This enables remote access to the business object data. You can
integrate an external Web service into your solution and address it in your business logic to enable access from the
SAP cloud solution to a remote application. You can also select a set of inbound and outbound services to create a
communication scenario. This allows customers to create communication arrangements in the SAP cloud solution
to exchange business documents electronically. Communication for Web services is based on SOAP or REST.

Business and Technical Background

The following graphic shows you the steps involved in creating and integrating a Web service into your solution.

Web Services
A Web service is a set of programming standards that enables interoperation between different software
applications, running on a variety of platforms or frameworks. Web services use Extensible Markup Language (XML),
Simple Object Access Protocol (SOAP), Representational State Transfer (REST), and Web Services Description
Language (WSDL) to integrate software applications over the internet. XML is used to tag the data, SOAP and REST
are used to transfer the data, and WSDL is used to describe the Web service. Web service discovery mechanisms
such as Universal Description, Discovery and Integration (UDDI), and Web Services Inspection Language (WSIL) can
locate the Web services provided by a Web site.
For more information, see Web Services [page 533].

Web Service Operations

Web services contain multiple service operations, which are stateless synchronous inbound operations. The service
operations are assigned to service interfaces which specify how to perform service requests and serve as collectors
for specific operation types. There is one endpoint per service interface. The following service operations are
available: Read, Create, Update, Query, and Action.
For more information, see Web Service Operations [page 537].

External Web Service Integration

You can integrate an external Web service into your solution to access a remote application using SOAP or REST.
After creating a communication scenario and a communication arrangement, you can address the Web service in
your business logic.
For more information, see External Web Service Integration [page 544].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 529
Communication Scenarios
In a communication scenario, you can define a set of inbound and outbound services for a business process. Inbound
services are Web services that you have created based on an SAP or custom business object, or Web services
provided by SAP. Outbound services are external Web services that you have integrated into your solution. Based
on a communication scenario, a customer can create a communication arrangement in SAP’s cloud solution to
exchange business documents electronically.

Communication Systems
A communication system represents an external system which is used for application integration. Communication
systems can be, for example, external time recording applications or master data systems. You define a
communication system in the SAP cloud solution and use it when you create the communication arrangement.
For more information, see the “Communication Systems Quick Guide” in the documentation of the SAP cloud
solution.

Communication Arrangements
A communication arrangement helps you configure the electronic data exchange between your solution and the
communication partner. It can be set up for multiple business documents and communication types. In the case of
the communication type B2B, the communication partner is another company, for example a customer or supplier;
in the case of the communication type Application Integration, the communication partner is another system.
When you create a communication arrangement, you can specify an authentication method to authorize a user to
call a Web service that you have created. You can create a communication arrangement for inbound and outbound
services. An inbound service is a Web service that is based on a business object. An outbound service is a Web service
that you have integrated into your solution.
For more information, see the "Communication Arrangements Quick Guide” in the documentation of the SAP cloud
solution.

Tasks

Create a Web Service

You can create a Web service based on an SAP business object or one of your business objects. You select the
business object elements and define the service operations that carry out tasks on the business object, for example,
creating or updating the business object data.
For more information, see Create a Web Service [page 545].

Test a Web Service

Before you can use your Web service in a client application, you must test it in a separate testing tool.
For more information, see Test a Web Service [page 547].

Modify a Web Service

You can modify a Web service that you have created based on an SAP business object or one of your business objects.
To modify a Web service, you can do the following:
● Add or remove business object elements for the service operations already defined in the Web service.
● Add or remove service operations.
● Adjust the derived names for the message data types used in the WSDL file.

For more information, see Modify a Web Service [page 548].

SAP Cloud Applications Studio – Version May 2018 (1805)

530 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Edit Web Service Authorizations
You can edit the authorization of the business users assigned to work center views to use the Web service operations.
For more information, see Edit Web Service Authorizations [page 550].

Integrate an External Web Service Using SOAP

To enable access from the SAP cloud solution to an external application, you can create an external Web service
integration scenario using SOAP
For more information, see Integrate an External Web Service Using SOAP [page 551].

Integrate an External Web Service Using REST

To enable access from the SAP cloud solution to an external application, you can create an external Web service
integration scenario using REST.
For more information, see Integrate an External Web Service Using REST [page 552].

Example: Consume a REST Service

This example illustrates the consumption of a REST Web service in the business logic of a custom business object
in the studio.
For more information, see Example: Consume a REST Service [page 554].

Modify an External Web Service Integration

You can modify an external Web service integration that you have created to access a remote application.
If you use SOAP-based communication, you can make the following changes:
● Replace the existing WSDL file with a new file
● Add or remove XML schema documents, if any are referenced in the WSDL file

For more information, see Modify an External Web Service Integration (SOAP) [page 559].
If you use REST-based communication, you can define or delete API keys used for authentication.
For more information, see Modify an External Web Service Integration (REST) [page 560].

Define a Communication Scenario

In a communication scenario, you can define a set of inbound and outbound services for a business process. Inbound
services are Web services that you have created based on an SAP or custom business object, or Web services
provided by SAP. Outbound services are external Web services that you have integrated into your solution. Based
on a communication scenario, a customer can create a communication arrangement in SAP’s cloud solution to
exchange business documents electronically.
For more information, see Define a Communication Scenario [page 557].

Modify a Communication Scenario Definition

You can modify a communication scenario that you have created based on a business-to-business or application
integration communication type. You can modify a communication scenario as follows:
● Change the communication type on which the communication scenario is based.
● Add or remove inbound and outbound services.

For more information, see Modify a Communication Scenario [page 561].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 531
Create a Communication System
To test the application integration scenario, you can create a communication system, which you can then use when
you create the communication arrangement. When your customers use the solution in their production system, they
create the communication system in the SAP cloud solution.
For more information, see Create a Communication System [page 562].

Create a Communication Arrangement

To test the communication scenario you have created, you need to create a communication arrangement in the SAP
cloud solution.
For more information, see Create a Communication Arrangement [page 563].

Test a Service Operation

Before you can use your Web service in a client application, you must test it in a separate testing tool.
For more information, see Test a Service Operation [page 564].

Define the Business Logic to Call a Service Operation

If you have integrated an external Web service into your solution, you typically call the service operations provided
by the Web service in a script file. The external Web service integration generates a library in the project namespace.
This library is similar to a reuse library and you can use it to implement your business logic to call the service
operations.

Look for Deprecated Web Services in the SAP Cloud Solution

1. In the SAP cloud solution, in the Application and User Management work center, select the Service Explorer
view.
2. Choose Advanced to open the advanced search pane.
3. Under Operation in the field Release Status, select Deprecated and in the field Deprecation Release, specify
the release in which you want to search for deprecated Web services. Choose Go .

The system displays the list of deprecated Web services in the release you specified.

Further Information
Maintenance Mode
A customer-specific solution is in maintenance mode, if it has been assembled and downloaded; the solution status
then is Assembled. You can make changes to the solution in a patch; however, you can only make restricted changes
to certain content types. These change and delete restrictions ensure that you do not make changes to a solution
that could lead to loss of data or create inconsistencies or errors on a customer's production tenant.
When your solution is in maintenance mode, please consider the following:
● You can add new fields to a service operation and delete them.
In solution templates, you can also add new fields but you cannot delete them.
● You cannot delete delivered service operation fields.
● You can delete delivered service operation fields that have been deprecated.

SAP Cloud Applications Studio – Version May 2018 (1805)

532 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.15.2 Web Services

Overview
A Web service is a set of programming standards that enables interoperation between different software
applications, running on a variety of platforms or frameworks. Web services use Extensible Markup Language (XML),
Simple Object Access Protocol (SOAP), Representational State Transfer (REST), and Web Services Description
Language (WSDL) to integrate software applications over the internet. XML is used to tag the data, SOAP and REST
are used to transfer the data, and WSDL is used to describe the Web service. Web service discovery mechanisms
such as Universal Description, Discovery and Integration (UDDI), and Web Services Inspection Language (WSIL) can
locate the Web services provided by a Web site.

In the cloud solution, internal communication between business objects is implemented as service integration.
For more information, see the Service Integration Quick Guide [page 519].

Features

Web Service Operations

The function in the Web service is defined in service operations performed on specified elements in the selected
business object.
For more information, see Web Service Operations [page 537].

Authorization Concept
You can authorize users to call a Web service that you have created as follows:
● Web Service Authorization Object
You can define a Web service authorization object for the service operations in the Web service. The
authorization concept is illustrated in the following diagram:

Web Service Authorization Process

The Web service authorization object is assigned to work center views. For every assigned work center view,
an external application containing the selected Web service operations is created. All users who have these
work center views assigned to them are subsequently authorized to call the Web service operations. Any
restrictions, such as read-only access to data, that have been defined for the assigned work center view are
also taken into account when accessing business objects using the service operation.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 533
 For more information about defining Web service authorizations, see Create a Web Service [page 545].
● Communication Arrangement
You can add a Web service that you have created as an inbound service to a communication scenario. Based
on this communication scenario, you can create a communication arrangement in the cloud solution. In the
communication arrangement, you can provide an authentication method to authorize a user to call the Web
service.
For more information about communication arrangements, see the “Communication Arrangements Quick
Guide” in the SAP cloud solution.

If you use a communication arrangement to authorize a Web service that has a Web service authorization
object, you can delete the Web service authorization object.

Testing Consumption and Error Handling

To test the Web service, you download the WSDL file, import it into your client testing tool, and then assign the
relevant work center views to a test user. For more information, see Test a Web Service [page 547].
The following list is intended to help you test the Web service:
● Checking Endpoint Activation
Every studio tenant supports the WSIL standard. The WSIL service is a web site with the URL https://[host
name]//sap/bc/srt/wsil that lists the active Web services and endpoints provided by SAP. Enter the URL
for the WSIL service in your browser to check whether the endpoint is active and accessible.
● XML Validation
As for all inbound service interfaces, the Web service runtime only performs a minimal set of checks (for
example, checking maximum string lengths) and not general or strict validation of the inbound message.
Superfluous tags are simply ignored.
● Fault Messages
If an error occurs within a Web service, the Log element contains the details of the error in the response
message. For more information about Log element, see Web Service Operations [page 537].

Web Services Description Language

The Web Services Description Language (WSDL) is an XML-based language that is used for describing the functions
offered by a Web service. A WSDL file provides a description of how the Web service can be called, which parameters
it expects, and which data structures it returns. WSDL is often used in combination with SOAP and an XML schema
document to define Web services in the internet. A client application connecting to a Web service can read the WSDL
file to determine which service operations are available on the server. The client application can then use SOAP to
call one of the service operations listed in the WSDL file. Some of the data types used are defined in a separate XML
schema document that is referenced in the WSDL file.
In a WSDL file the following elements are used for the definition of Web services:
● Types
A container for data type definitions such as XML Schema Definition (XSD).
● Message
An abstract, typed definition of the data being communicated.
● Operation
An abstract description of an action supported by the service.
● Port Type
An abstract set of operations supported by one or more endpoints.
● Binding

SAP Cloud Applications Studio – Version May 2018 (1805)

534 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 A concrete protocol and data format specification for a particular port type. Optionally, a binding can be
defined between the operation name and the SOAP action.
● Port
A single endpoint defined as a combination of a binding and a network address.
● Service
A collection of related endpoints.

A WSDL file defines Web services as collections of network endpoints, or ports. A port is defined by associating a
network address with a reusable binding. In WSDL, the abstract definition of endpoints and messages is separated
from their concrete network deployment or data format bindings. This allows the reuse of abstract definitions:
messages and port types.
The following is an example of a basic WSDL file that refers to an XML Schema document:

<?xml version=”1.0” encoding=”UTF-8”?>

<definitions targetNamespace="http://example.com/control/ws”>
<types>
<xsd:schema elementFormDefault="qualified" targetNamespace="http://
example.com/control" xmlns:ps="http://example.com/control">
<xsd:import namespace="http://example.com/schema/control"
schemaLocation="PayrollControlSchema.xsd" xmlns:pcns="http://
example.com/schema/control"/>
<xsd:element name="ProcessPayrollControl"
type="ps:ProcessPayrollControlType"/>
<!— — Add more elements here — —>
</xsd:schema>
</types>
<message name="GetAnnualPayrollSchedule">
</message>
<portType name="RequestPayrollControlServicesPortType">
<operation name="ProcessPayrollControl">
</operation>
</portType>
<binding name="RequestPayrollControlServicesBinding"
type="psws:RequestPayrollControlServicesPortType">
<operation name="ProcessPayrollControl">
</operation>
</binding>
<service name="PayrollControlServices">
<port binding="psws:RequestPayrollControlServicesBinding"
name="RequestPayrollControlServicesPortType">
</port>
</service>
</definitions>

XML elements and attributes are usually placed inside a container called a namespace. Inside the <types> element,
the targetNamespace attribute is used if you want to place elements and attributes from the default namespace
that is defined using the xmlns attribute into a different namespace. The value of the schemaLocation attribute
is the location of the XML schema document to use for the target namespace. Usually this value can be a URL or the
location of the XML schema document relative to the location of the WSDL file on your local computer. In the above
example, the WSDL file refers an XML schema document PayrollControlSchema.xsd that is located in the same
folder as the WSDL file.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 535
 The studio only accepts the relative location of the XML schema document for the value of the
schemaLocation attribute.

XML Schema Document

An XML schema document describes and validates data in an XML document. It is written in the XML schema
language, also referred to as XML Schema Definition (XSD).
Some of the data types used in a WSDL file are embedded in the file in the form of an XML schema document. This
modular schema design maximizes the potential for reusability, flexibility, and maintainability of Web services
components. As an XML schema document is written in XML, there is no need for a parser. An XML schema document
defines a rich set of data types, for example, numeric data types, string data types, and date data types, and also
makes it easier to validate documents based on namespaces.
An XML schema defines the following:
● Elements and attributes that can appear in a document.
● Whether an element is a child element.
● The order and the number of child elements.
● Whether an element is empty or can include text.
● Data types for elements and attributes.
● Default and fixed values for elements and attributes.

The following is an example of a basic XML schema document:

<?xml version="1.0" encoding="UTF-8"?>

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified" targetNamespace="http://example.com/schema/
control">
<xsd:import namespace="http://example.com/schema/common"
schemaLocation="PayrollCommonSchema.xsd"/>
<xsd:element name="PayrollGroupAnnualSchedule" nillable="false"
type="pcns:PayrollGroupPayrollScheduleType"/>
<xsd:complexType name="PayrollGroupPayrollScheduleType">
<xsd:annotation>
<xsd:documentation>Denotes the list of payroll schedules for the
calendar year for the payroll group</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="PayrollGroupCode" nillable="false"
type="cns:PayrollGroupCode"/>
<xsd:element maxOccurs="unbounded" name="PayrollSchedule"
nillable="false" type="pcns:PayrollScheduleType"/>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>

In the above example, the XML schema document refers another XML schema document
PayrollCommonSchema.xsd.

See Also
Web Services Quick Guide [page 529]

SAP Cloud Applications Studio – Version May 2018 (1805)

536 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.15.3 Web Service Operations

Overview
Web services contain multiple service operations, which are stateless synchronous inbound operations. The service
operations are assigned to service interfaces which specify how to perform service requests and serve as collectors
for specific operation types. There is one endpoint per service interface. The following service operations are
available: Read, Create, Update, Query, and Action.

Core Concepts

Statelessness
By definition and design, Web service operations are stateless synchronous inbound operations. This means that
no resources such as enqueue locks or buffers are shared or maintained across subsequent calls. To ensure
reasonable transaction sizes for mass operations, it is recommended that you avoid excessively large transactions
because the time required to transfer huge amounts of data across the network may cause communication time-
outs.

Action Code
The action code is a coded representation of an instruction to the recipient of a message telling the recipient how to
process it.

Action Code List

Code Name Description

01 Create The element is to be created at the recipient. The element must not exist at the recipient. The element ID
and all data must be transferred.

02 Change The element is to be changed at the recipient. The element must exist at the recipient. The element ID and
all data must be transferred.

03 Delete The element is to be deleted at the recipient. The element must exist at the recipient. The element ID must
be transferred. No data should be transferred, with the exception of elements that are mandatory due to
their cardinality.

04 Save The element is to be saved at the recipient. The element can exist at the recipient.
If, at the recipient, the element:
● Already exists, it is changed
● Does not exist, it is created

The element ID and all data must be transferred.

05 Remove The element is to be deleted at the recipient. The element can exist at the recipient.
If, at the recipient, the element:
● Already exists, it is changed
● Does not exist, it is created

06 No action No action is to be carried out for the element at the recipient. The element must exist at the recipient. The
element ID and all data must be transferred.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 537
Complete Transmission Indicator
Due to the synchronous nature of Web services, the selective transmission of data during updates is essential for
performance. In addition it cannot be assumed that the whole business object instance has to be read before an
update takes place. This is especially true in cases where new field nodes are added via extensions. Without selective
transmission, the new fields would be cleared and the new node instances would be deleted when an update message
is processed. The CompleteTransmissionIndicator is used to indicate if the data in the requested operation
represents all the data of an element or only part of it.
For operation message data types, the following rules apply:
● The CompleteTransmissionIndicator attribute is only used for lists, not for elements.
● For all updates, the default value is false, that is, by default, lists are always incomplete.
● For updates, if the value is true, all instances of the associated business object node that are not part of the
message will be deleted.
● For creations or deletions, the indicator is assumed to be true or you can set it yourself explicitly to true.

Log
The Log element represents the result of an operation as a series of requests and responses.
The most important parts of the Log element are:

Description of Key Elements

Element Details

MaximumLogItemSeverityCode, These elements provide you with information on the degree of success of a given
LogItemSeverity operation. The possible values are:
● 1 Information
● 2 Warning
● 3 Error

LogItem The aggregated data type for theLogItem contains the following elements:
● In a response, the ReferenceObjectNodeSenderTechnicalId
references the ObjectNodeSenderTechnicalId used in the request
message. For more information, see the Object Node Sender Technical ID
section below.
● ReferenceMessageElementName
This value denotes the element in the request that the log item refers to. It
enables you to relate error messages to lines and columns in the query or
request message, irrespective of the
ObjectNodeSenderTechnicalId.

Object Node Sender Technical ID

When a request contains at least one element that occurs more than once, it must be possible to identify the
corresponding elements in the response and the LogItem. To this end, the ObjectNodeSenderTechnicalId
element is contained on every level of the request message as an optional element. The corresponding element
ReferenceObjectNodeSenderTechnicalId is contained in the LogItem element at the root level of the response
message.
The ObjectNodeSenderTechnicalId is also used to identify a failed newly created instance in a mass operation.
Because the instance was not created in the database in these cases, no UUID or ID is returned and only the
ReferenceObjectNodeSenderTechnicalId indicates which part of the request has failed.

SAP Cloud Applications Studio – Version May 2018 (1805)

538 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
The ObjectNodeSenderTechnicalId contains transient values that establish the correspondence between
elements only for a single call.

Change State Identifier

Due to the stateless behavior of the Web service operations, no transactional or logical locking is possible. However,
the ChangeStateId provides a way to ensure that a modifying operation is not executed if the state of the underlying
business object instance in the database has changed since the last time that data was read. The
ChangeStateId is an uninterpretable string that is provided by all operations and may be consumed by all modifying
operations.
Update Operations
If the ChangeStateId is provided when calling an update operation, the system does not perform the operation if
the state of the business object instance in the database has changed since the ChangeStateId was computed.
Create Operations
For create operations, there is no previous state of the underlying business object instance. Therefore the change
state identifier is not modeled in single instance create operations and is optional in mass instance operations that
support the corresponding action codes for creation.
If the change state identifier is specified and the specified value for a business object instance is different from the
actual value computed from the database, an error message with the value"SBM.SBM.CSM" (change state
mismatch ) in the element LogItem.LogItemCategoryCode is returned for that business object instance in the
Log element of the response.

Operations which create or update data, return the new IDs and the ChangeStateId only for those business
object instances for which the operation succeeded.

Read Operation
The read operation returns detailed information of one or more instances of a business object. The part of the
business object returned can be limited by the defined business object view. In general, the read operation always
forms a pair with the corresponding create or update operation. Therefore, if a full or partial update operation for a
business object exists, a full or partial read operation must also exist in order to retrieve the change state identifier
for the update. A response message is always sent.
Result
The following is an example of a response message:

<BusinessObject1ByIDResponse_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/
Global">
<BusinessObject1>
<SAP_UUID>00163e01-27e0-1ed0-a6f9-129eeb25f05e</SAP_UUID>
<id>1</id>
<item>Washing Powder</item>
</BusinessObject1>
<Log />
</BusinessObject1ByIDResponse_sync>

Note that response and confirmation messages may contain an XML namespace definition for
xmlns:prx="urn:sap.com:proxy…". This is only used for support purposes and should ignored at runtime.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 539
Create Operation
The create operation creates a business object instance. A confirmation message is always sent.
Result
The following is an example of a confirmation message:

<BusinessObject1viewCreateConfirmation_sync xmlns:nm="http://sap.com/xi/
SAPGlobal20/Global">
<BusinessObject1>
<SAP_UUID>00163e01-27e0-1ed0-a6f9-a08d04afd1f8</SAP_UUID>
<id>3</id>
</BusinessObject1>
<Log>
<MaximumLogItemSeverityCode>1</MaximumLogItemSeverityCode>
<Item>
<TypeId>007(/CSG_RUNTIME/)</TypeId>
<SeverityCode>1</SeverityCode>
<Note>Create operation was successful</Note>
</Item>
</Log>
</BusinessObject1viewCreateConfirmation_sync>

Update Operation
The update operation updates a single instance of an object with checks for concurrent updates. The part of the
business object susceptible to the update can be limited by the defined business object view. The update operation
may add and/or remove parts of the business object but it is not meant to be used for status changes. A confirmation
message is always sent.
The update operation checks for concurrent updates. It checks the ChangeStateId element to determine whether
somebody else has changed the same business object instance since the last read. If this is the case, then an error
message is returned.
Result
The following is an example of a response message:

<nm:BusinessObject1viewUpdateConfirmation_sync xmlns:nm="http://sap.com/xi/
SAPGlobal20/Global">
<Log>
<MaximumLogItemSeverityCode>1</MaximumLogItemSeverityCode>
<Item>
<TypeId>013(/CSG_RUNTIME/)</TypeId>
<SeverityCode>1</SeverityCode>
<Note>Update operation was successful</Note>
</Item>
</Log>
</nm:BusinessObject1viewUpdateConfirmation_sync>

SAP Cloud Applications Studio – Version May 2018 (1805)

540 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Query Operation
When defining a query operation in the Web Service Creation Wizard, you can only use queries that already exist for
the business object. The query operation retrieves specified information in business object instances. Query
operations only read data; there is no change of any persistent data. A response message is always sent. The basic
query naming pattern is:
Find[View]SimpleBy[Selection criteria]
Where:
● The business object view defines the response structure.
● The selection criteria view splits the operation so that each operation offers a semantically meaningful set of
selection criteria typically needed for a given purpose. It is determined from the name of the underlying
business object query.

Maximum Number of Rows Returned

You can define the maximum number of rows returned by a query using the following elements of the
ProcessingConditions element:
● QueryHitsUnlimitedIndicator
● QueryHitsMaximumNumberValue

If the QueryHitsUnlimitedIndicator is not set and the QueryHitsMaximumNumberValue is zero, the default
of 100 rows is assumed.

The caller of the Web service is responsible for creating a reasonable package size. Therefore, we do not
recommend that you set the unlimited indicator to true or that you return more than 1000 rows.

Note that the LastReturnedObjectID element is not supported in query response messages. Queries return a
filtered result and may offer sorting criteria. Therefore, choosing a key or ID will depend on the query parameters,
the returned fields, and the sorting order used in the query results. Also, not all business object nodes will have a key
or the key will not have a linear order, for example if it is a UUID. The caller has to decide which fields can be used in
each specific case. In simple cases the ID element of the node for which the query is defined is sufficient. In complex
cases, all elements of the response have to be treated as part of the key.
Comparisons Permitted
You can use the following types of comparisons in Web service query operations:
● Equals

If an Equals string contains an asterisk (*), the system implicitly interprets this as a wildcard query
and thus as a CONTAINS pattern. You cannot therefore query items that have the asterisk in their
name. For example, QUERY PRODUCT WHERE PRODUCT ID=A* returns all products beginning
with the letter A. It does not return the details of the product name A*

● Between
● Less than
● Less than or equal to
● Greater than
● Greater than or equal to

Each query parameter includes a SelectionBy[Name], where the name determines the query parameter, and has
the following structure:

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 541
Details of Query Parameters

Element Value Description

InclusionExclusionCode I Include in the result set

E Exclude from the result set

IntervalBoundaryTypeCode 1 Equal to
Single Value; = X

2 Between (excluding upper boundary)

Interval with closed lower and open upper boundary; [X, Y)

3 Between
Interval with open lower and open upper boundary; (X, Y)

4 Between (excluding both boundaries)

Interval with open lower and open upper boundary; (X, Y)

5 Between (excluding lower boundary)

Interval with open lower and closed upper boundary; (X, Y]

6 Less than
Interval with unlimited lower and open upper boundary; < X

7 Less Than or Equal to

Interval with unlimited lower and closed upper boundary; <= X

8 Greater Than
Interval with open lower and unlimited upper boundary; > X

9 Greater Than or Equal to

Interval with closed lower and unlimited upper boundary; >= X

Result
The following is an example of a response message:

SAP Cloud Applications Studio – Version May 2018 (1805)

542 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 <nm:BusinessObject1QueryByElementsSimpleByConfirmation_sync xmlns:nm="http://
sap.com/xi/SAPGlobal20/Global">
<BusinessObject1>
<SAP_UUID>00163e01-3318-1ed0-b4df-43192913f03f</SAP_UUID>
<ID>1</ID>
<FirstName>Abc</FirstName>
<MiddleName>D</MiddleName>
<LastName>Xyz</LastName>
<State>1</State>
</BusinessObject1>
<ProcessingConditions>
<ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue>
<MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator>
</ProcessingConditions>
<Log>
<MaximumLogItemSeverityCode>1</MaximumLogItemSeverityCode>
<Item>
<TypeID>009(/CSG_RUNTIME/)</TypeID>
<SeverityCode>1</SeverityCode>
<Note>Query returned 1 records</Note>
</Item>
</Log>
</nm:BusinessObject1QueryByElementsSimpleByConfirmation_sync>

Action Operation
When defining an action operation in the Web Service Creation Wizard, you can only use actions that already exist
for the business object. The action operation changes the state of a business object instance. It is not intended to
be used to modify data. The request message types are typically very short; they often contain just the business
object ID. A response message is always sent.
Result
The following example shows an action response message:

<nm:BusinessObject1ResetStateResetStateConfirmation_sync xmlns:nm="http://
sap.com/xi/SAPGlobal20/Global"">
<Log>
<MaximumLogItemSeverityCode>1</MaximumLogItemSeverityCode>
<Item>
<TypeId>017(/CSG_RUNTIME/)</TypeId>
<SeverityCode>1</SeverityCode>
<Note>Action RESETSTATE992EBFB4F6ADFACD executed</Note>
</Item>
</Log>
</nm:BusinessObject1ResetStateResetStateConfirmation_sync>

See Also
Web Services Quick Guide [page 529]

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 543
8.15.4 External Web Service Integration

You can integrate an external Web service into your solution to access an external application using the SOAP or
REST protocol.
What is SOAP?
SOAP (Simple Object Access Protocol) is an xml-based protocol specification for exchanging structured information
via Web services. The integrated Web service is described by a WSDL file. With SOAP, you can use different transport
protocols, for example, HTTP or SMTP. SOAP uses named operations, each implementing business logic through
different interfaces. WS-Security and Reliable Messaging are supported.
For more information, see Integrate an External Web Service Using SOAP [page 551].
What is REST?
REST (Representational State Transfer) is an architectural style for designing networked applications. REST services
provide a uniform interface using standard HTTP operations (such as GET, POST, PUT...) and exchange
representations of resources. JSON and XML are frequently used formats in REST services.
For more information, see Integrate an External Web Service Using REST [page 552].
To integrate REST Web services, you can also use a mashup. For more information, see Create a Mashup Web Service
[page 501].

What is the difference between SOAP and REST?

The SOAP and REST protocols both provide a set of rules for requesting information from a server. The following
table lists some of the differences. It should also help you decide which protocol to use for your integration scenario.
Note also that Web services often support either REST or SOAP.

Category SOAP REST

Handling complex simple

Format XML XML, CSV, JSON, RSS

Protocol HTTP, SMTP HTTP, HTTPS

Means used to define Web service WSDL URL

Purpose for APIs for simple transactions, CRUD

operations, fast results

How do I integrate an external Web service into my solution?

The following graphic shows what you need to do to integrate an external Web service into your solution:

External Web Service Integration

The procedures for integrating SOAP and REST Web Services are very similar. However, the steps you need to take
in the External Web Service Wizard are quite different as you can see in the following table:

SAP Cloud Applications Studio – Version May 2018 (1805)

544 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 SOAP REST

1. Upload a WSDL file. 1. Enter URL of Web service that you want to use.
2. Optional: Select XML schema document. 2. Optional: Allow non-secure communication or define
3. Decide if you want to use stateful communication. API keys.

For more information, see Integrate an External Web Service For more information, see Integrate an External Web Service
Using SOAP [page 551]. Using REST [page 552].

See Also
Example: Consume a REST Service [page 554]

8.15.5 Tasks

8.15.5.1 Create a Web Service

You can create a Web service based on an SAP business object or one of your business objects. You select the
business object elements and define the service operations that carry out tasks on the business object, for example,
creating or updating the business object data.
The Web service can then be consumed by a client application to access the business object data remotely.

Prerequisites
● If you create a Web service based on an SAP business object, the business object must be released for the
SAP public solution model (PSM).
● If you create a Web service based on your business object, the business object must be activated.

Procedure
1. In the Solution Explorer, do one of the following:
● If you create a Web service based on an SAP business object or any of your business objects, proceed
as follows:
a. Right-click the project in your solution and select Add New Item .
b. Select SAP Service Integration Web Service , enter a name and click Add.
The Web Service Creation Wizard opens.
● If you create a Web service based on one of your business objects, right-click the business object and
select Create Service Integration....
a. The Service Integration Wizard opens.
b. Select Web Service and click Next.
2. In the Enter Web Service Name step, proceed as follows:

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 545
 a. If you used the Add New Item function, optionally, change the name and select a namespace
and the business object based on which you want to create the Web service.
b. If the Web service is based on your business object, enter a name for the Web service.
c. Click Next.
3. In the Select Elements step, select the business object elements that you need for the Web service operations.
If you have already created a Web service for the business object, you must enter a business object view
name.
If you create a Web service based on a business object that has an association to another business object,
you can also add elements of the associated business object. For more information, see Association (Business
Object) [page 180].

If you have included a dependent object in your business object definition, you can only select the
dependent object node and not the elements. The elements of the dependent object, however, are
included. For more information on dependent objects, see Dependent Object (Business Object)
[page 185].

Click Next.
4. In the following steps, define the service operations for the Web service. For each service operation that you
define, select the checkbox, enter a name, and select on which business object elements you want to perform
the service operation.
The following Web service operations are provided by the studio:
● Create service operation
● Read service operation
● Update service operation
● Query service operation:
In the Define a Query Service Operation step, enter a service operation name and select a query.

If you define a query service operation with query parameters that are not released for the PSM,
you cannot activate the Web service.

● Action service operation:

In the Define a Action Service Operation step, enter a service operation name and select an action.

For more information about service operations, see Web Service Operations [page 537].
Click Next.
5. In the Define Web Service Authorization step, assign your service operations to work center views. This will
authorize business users who are assigned to the views to use the service operations in the Web service.
Proceed as follows:
a. Click Add.
b. In the Add Work Center View dialog, do one of the following:
● Click Use Existing View to select a view.
● Click Create New View and enter a name.
The view will be created when you have completed all steps in the wizard.
c. Click Next.
d. For each work center view, select the service operations that you want to assign.

For more information about the authorization concept, see Web Services [page 533] under Authorization
Concept.
6. Review your settings and click Finish.

SAP Cloud Applications Studio – Version May 2018 (1805)

546 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 A Web service with the file extension .webservice

( ) appears in the Solution

Explorer. Below the Web service, the Web service authorization object with the extension .wsauth ( ) is
listed, which contains the authorization settings of the Web service.
7. In the Solution Explorer, right-click the Web service and select Activate.

Result
● WSDL File
The Web service and the Web service authorization object are activated. You can now download the WSDL
file, which can be consumed by a client application. To download the file, right-click the Web service and select
Download WSDL File.
● Adjust Derived Names
You need to adjust the derived names in the WSDL file if you are prompted to do so. You can also optionally
choose to adjust the names for ease of use. For more information, see Modify a Web Service [page 548].
● Work Center View
If you entered a name for a new work center view while defining the Web service authorization settings, the
view appears in the Solution Explorer with the file extension .uiwocview ( ). To edit the work center view,
right-click the file and select Open in UI Designer. For more information, see Model a Work Center View
[page 612].
● Maintenance Mode
You can create a Web service when your solution is in maintenance mode. For more information, see
Maintenance Mode [page 170].

See Also
Test a Web Service [page 547]

8.15.5.2 Test a Web Service

Overview
Before you can use your Web service in a client application, you must test it in a separate testing tool.

Prerequisites
● You have created and activated the Web service and have defined the Web service authorizations.
For more information, see Create a Web Service [page 545].
● If you want to test a Web service, it must be in scope.
If you have created BAC elements in your solution and assigned your solution content to a business option,
you can perform scoping manually in the development environment of the SAP cloud solution. You must be
assigned the Business User role and have access rights for the Business Configuration work center. For more
information, see User Setup Quick Guide [page 31].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 547
 Alternatively, you can trigger the deployment of business configuration in the Solution Explorer by right-
clicking the solution and selecting Deploy Business Configuration.

If you have defined BAC elements for your solution, a dialog box opens when you use the Deploy
Business Configuration function. You have to select one of the following options:
● Deploy all business configuration content for your solution
● Deploy only the business configuration content for your solution that is assigned to the business
options you have selected in the business adaptation catalog

This allows you to test both partial and complete activation of your business configuration content in
the development environment.

Procedure
1. In the studio, in the Solution Explorer, right-click the Web service that you want to test and select Download
WSDL File.

If an error occurs when you download the WSDL file, check that your user has been created according
to the procedure described in the User Setup Quick Guide [page 31].

2. Import the WSDL file into your client testing tool.

3. In the SAP cloud solution, assign a test user to the work center views authorized for the Web service.
Note that the work center views that are authorized to access the Web service must have been assigned to
a work center. You can then assign test users to this work center in the system for the SAP cloud solution. To
do so, navigate to the User and Access Management work center, Business Users view. For more information,
see the Business Users Quick Guide.

This step needs to be repeated when your customers go live with your final solution. You have to
ensure that any users who should have access to the Web service are assigned to the relevant work
center views in the customer's productive system.

4. Test the Web service.

For more information about the syntax used, see Web Service Operations [page 537].

8.15.5.3 Modify a Web Service

You can modify a Web service that you have created based on an SAP business object or one of your business objects.
To modify a Web service, you can do the following:
● Add or remove business object elements for the service operations already defined in the Web service.
● Add or remove service operations.
● Adjust the derived names for the message data types used in the WSDL file.

Prerequisite
You have created a Web service based on an SAP business object or one of your business objects. For more
information, see Create a Web Service [page 545].

SAP Cloud Applications Studio – Version May 2018 (1805)

548 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Procedure
1. In the Solution Explorer, double-click the .webservice file of the Web service that you want to modify.
2. To modify your Web service, do one of the following:
● To add or remove a business object element available for use in the Web service, select the Business
Object View tab. Select or deselect the element that you want to add or remove.
If you deselect a business object element, it will be removed from all existing service operations. If you
add an element, it will become available for use in all existing service operations.

If you have included a dependent object in your business object definition, you can only select
the dependent object node and not the elements. The elements of the dependent object,
however, are included. For more information on dependent objects, see Dependent Object
(Business Object) [page 185].

● To add or remove a business object element from a specific service operation, select the Service
Operations tab. Proceed as follows:
a. From the dropdown list, select the service operation from which you want to add or remove a
business object element.
b. Select or deselect the relevant business object element.
● To add or delete a service operation, select the Service Operations tab.
○ To add a service operation to your Web service, proceed as follows:
a. Click Add.
The Add Service Operation dialog box opens.
b. Select a service operation and enter a unique name for the service operation. Click Add.
○ To delete a service operation from your Web service, proceed as follows:
a. From the dropdown list, select the service operation that you want to delete.
b. Click Delete.
● To adjust the derived name for a message data type used in the WSDL file, select the Message Data
Types tab.
When you create a Web service, the corresponding request and response messages for each service
operation contain derived names based on the names of the business object elements and Web service
operations. You may be prompted to adjust these derived names if they exceed the 120 characters
limit. You can also optionally choose to adjust the names for ease of use.
To adjust the derived name, proceed as follows:
a. Select a service operation and then choose either the request or response message type.
The derived names used in the message are displayed.
b. Select a line in the structure and enter an alternative name in the Abbreviated Name field.
c. Click Apply.
The new name is displayed in the message structure. If you renamed a line in the structure that
has subitems, then the subitems are renamed accordingly.

If you want to reset a derived name of a message type to its initial name, select the service operation
and choose the request or response message type. Click Reset Tree to Initial Names.
3. Click Save.
4. In the Solution Explorer, right-click the Web service and select Activate.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 549
 When you re-activate an existing Web service in the studio, an updated version of the Web service's
WSDL file is generated. You must download the new WSDL file after you re-activate the Web service.

Result
The modified Web service is activated. The system updates the Web service authorization object with the changes
you made to existing service operations. However, if you have added new service operations, you must edit the
authorizations manually. For more information, see Web Services Quick Guide [page 529] under Edit Web Service
Authorizations.
You can now download the updated WSDL file, which then can be consumed by a client application to access the
business object data remotely.

8.15.5.4 Edit Web Service Authorizations

You can edit the authorization of the business users assigned to work center views to use the Web service operations.

Prerequisites
You have opened a solution that contains a Web service. For more information, see Create a Web Service
[page 545].

Procedure
1. In the Solution Explorer, double-click the .wsauth file to open it for editing.
2. You have the following options:
● To add a new work center view, click Add, select Create New View, and enter a technical name for a
new view.
● To remove authorization from a work center view, select the line in the table and click Remove. Note
that this does not delete any work center views created specifically for the Web service.
● If you have removed authorization from a work center view, you can add it as follows: Click Add, select
Use Existing View, select the view, and click Add.
● To assign the Web service operations to work center views, select a view and then select or deselect
the checkboxes in the lower table.
● To find out where a work center view is stored in the UI designer, view the Repository Path column.
3. Save your changes and activate the Web service.

If you delete a Web service authorization object in the Solution Explorer, any work center views that
you created during Web service creation are not deleted. You can delete these manually. You can
recreate a deleted Web service authorization by right-clicking the Web service and selecting Create
Web Service Authorization.

SAP Cloud Applications Studio – Version May 2018 (1805)

550 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.15.5.5 Integrate an External Web Service Using SOAP

To enable access from the SAP cloud solution to a remote application, you can create an external Web service
integration scenario using SOAP.
SOAP (Simple Object Access Protocol) is an xml-based protocol specification for exchanging structured information
via Web services. The integrated Web service is described by a WSDL file. With SOAP, you can use different transport
protocols, for example, HTTP or SMTP. SOAP uses named operations, each implementing business logic through
different interfaces. WS-Security and Reliable Messaging are supported.
For more information, see External Web Service Integration [page 544].

Prerequisites
● You have opened a solution in the studio.
● You have saved the WSDL file of the Web service that you want to integrate into your solution on your local
computer.
● If the WSDL file refers to one or more XML schema documents, you have saved the schema documents on
your local computer.
● If the WSDL file refers to XML schema documents and the value of the schemaLocation attribute in the
WSDL file is a URL, you have replaced the URL with the location of the XML schema document on your
computer. Note that the document’s location must be relative to the location of the WSDL file.
For more information about WSDL and XML schema document, see Web Services [page 533].

Save the WSDL file and the XML schema documents in the same location on your computer. In this case, the
values of the schemaLocation attribute are the XML schema document names only.

Procedure
1. In the Solution Explorer, right-click your solution and select Add New Item.
The Add New Item dialog opens.
2. Select SAP Service Integration External Web Service Integration and click Add.
The External Web Service Integration Wizard opens.
3. In the Enter Web Service Name and Type step, enter a name for the Web service and select SOAP. Click
Next.
4. In the Import WSDL File Documents step, do the following:
a. Select the WSDL file of the Web service that you want to integrate into your solution.
b. Select the Use Session ID checkbox, if you want the external Web service to allow stateful
communication, that is, return a session ID/cookie when it is called.
c. Optional: If the WSDL file refers to one or more XML schema documents, click Add, select the XML
schema document and click Open.
Change the port name, if required.
d. Click Next.
5. In the Define Communication Scenario step, do the following:

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 551
 a. Optional: Select the Create Communication Scenario checkbox to create a communication scenario
that includes the Web service integration that you have defined.
If you choose not to select this option, you must assign the Web service integration to a communication
scenario later. For more information, see Define a Communication Scenario [page 557].
b. Enter a name for the communication scenario. It must start with a capital letter and can have 25
characters (letters, digits, and underscores).
c. Optional: Select the Allow Non-Secure URLs (HTTP) checkbox to allow non-secure communication.
d. Click Next.
6. On the Review page, review your entries and click Finish.
In the Solution Explorer, an external Web service integration file with the extension .wsid ( ) together with
the .wsdl file ( ) appears. If you have created a communication scenario, the corresponding .csd file

( ) is also displayed.
7. In the Solution Explorer, right-click the .wsid file and click Activate.
If you have created a communication scenario, right-click the .csd file and click Activate.

Result
You have created an external Web service integration and can now do the following:
● Edit your external Web service integration.
To do so, right-click the .wsdl file. The document window opens where you can edit the Web service
integration definition
For more information, see Modify an External Web Service Integration (SOAP) [page 559].
● Test the service operations.
Right-click the .wsid file and select Test Service Operations.
For more information, see Test a Service Operation [page 564].
● Create a communication scenario
If you have not created a communication scenario yet, right-click the .wsid file and select Create
Communication Scenario Definition.
For more information, see Define a Communication Scenario [page 557].
● Create a communication system
If you have created a communication scenario, right-click the .csd file and select Manage Communication
System. Afterwards, you can use the communication system to create a communication arrangement.
For more information, see Create a Communication System [page 562] and Create a Communication
Arrangement [page 563].

8.15.5.6 Integrate an External Web Service Using REST

To enable access from the SAP cloud solution to an external application, you can create an external Web service
integration scenario using REST.
REST (Representational State Transfer) is an architectural style for designing networked applications. REST services
provide a uniform interface using standard HTTP operations (such as GET, POST, PUT...) and exchange
representations of resources. JSON and XML are frequently used formats in REST services.
For more information, see External Web Service Integration [page 544].

SAP Cloud Applications Studio – Version May 2018 (1805)

552 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
If you want to learn how you can use this function in a real-life example, see Example: Consume a REST Service
[page 554].

Prerequisites
You have opened a solution in the studio.

Procedure
1. In the Solution Explorer, right-click your solution and select Add New Item.
The Add New Item dialog opens.
2. Select SAP Service Integration External Web Service Integration and click Add.
The External Web Service Integration Wizard opens.
3. In the Enter Web Service Name and Type step, enter a name for the Web service and select REST. Click
Next.
4. In the Enter End Point of REST Service step, do the following:
a. Enter the URL of the service.
The Host Address, Port, and Path fields are filled automatically.
b. Click Next.
5. In the Define Communication Scenario step, do the following:
a. Optional: Select the Create Communication Scenario checkbox to create a communication scenario
that includes the Web service integration that you have defined.
If you choose not to select this option, you must assign the Web service integration to a communication
scenario later. For more information, see Define a Communication Scenario [page 557].
b. Enter a name for the communication scenario. It must start with a capital letter and can have 25
characters (letters, digits, and underscores).
c. Optional: Select the Allow Non-Secure URLs (HTTP) checkbox to allow non-secure communication.
d. If the service you are calling requires authentication, you can define the required identifiers as API
keys. The values of the API keys are maintained in the communication arrangement. You cannot use
API keys with non-secure URLs (HTTP). To define an API key, do the following:
1. Enter the key in the API Key field.
2. Click the Placeholder for API Key in Script File field to the right of the API Key field.
The placeholder is generated, which you can use in the script file to build the Web service request.
e. Click Next.
6. On the Review page, review your entries and click Finish.
In the Solution Explorer, an external Web service integration file with the extension .wsid ( ) is displayed.
If you have chosen to create a communication scenario, a communication scenario definition file with the

extension .csd ( ) is also displayed.

7. In the Solution Explorer, right-click the .wsid file and click Activate.
A communication scenario and a communication system are generated in the SAP cloud solution. These can
be used to create a communication arrangement.

Result
You have created an external Web service integration and a communication scenario and can now do the following:

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 553
 ● Edit your external Web service integration.
To do so, right-click the .wsid file and select Open. The document window opens where you can edit the Web
service integration definition.
For more information, see Modify an External Web Service Integration (REST) [page 560].
● Create a communication scenario
If you have not already created a communication scenario, right-click the .wsid file and select Create
Communication Scenario Definition.
For more information, see Define a Communication Scenario [page 557].
● Edit a communication scenario
To edit your communication scenario, double-click the .csd file to open it.
For more information, see Modify a Communication Scenario [page 561].
● Create a communication arrangement.
To do so, right-click the .csd file and select Manage Communication Arrangement.
For more information, see Create a Communication Arrangement [page 563].
● Define the business logic to call a service operation.
For more information, see Define the Business Logic for a Business Object [page 369].
When you create the script file, you can use the following functions provided in the SAP reuse library:
○ WebServiceUtilities. ExecuteRESTService
○ WebServiceUtilities.EncryptWithHashBasedMessageAuthenticationCode

For more information, see Web Service Utilities [page 266].

8.15.5.7 Example: Consume a REST Service

Overview
This example illustrates the consumption of a REST Web service in the business logic of a custom business object
in the studio.

Use case
In a Web application, users enter their country and postal code on a screen. The REST service
automatically fills the city field.

To test this example, please use a REST Web service that displays the city when you enter the corresponding postal
code. You can find such REST Web services free of charge on the Internet.
Here is what you do in this example:

Example: Consume a REST Service

Prerequisites
● You have a partner developer user in the studio and a business user in the SAP cloud solution. For more
information, see User Setup Quick Guide [page 31].
● You have created a solution in the studio. For more information, see Create a Solution [page 165].

SAP Cloud Applications Studio – Version May 2018 (1805)

554 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Define an external Web service integration scenario
1. In the studio, in the Solution Explorer, open your solution and click Add New Item ( ).
2. In the Add New Item dialog, select External Web Service Integration, enter the name
GetCityByPostalCode name and click Add.
The External Web Service Integration Wizard opens.
3. In the Enter Web Service Name and Type, select the web service type REST, and click Next.
4. In the Enter End Point of REST Service step, enter the URL of the REST Web service and click Next.
5. In the Define Communication Scenario step, do the following:
a. Select Create Communication Scenario, and enter GetCity as the Communication Scenario Name.
If the Web service can only be called using HTTP instead of HTTPS, select Allow Non-Secure URLs
(HTTP).
b. Click Next.
6. In the Review step, review your entries and press Finish.
A .csd file and a .wsid file are added to the Solution Explorer.
7. Right-click the .wsid file and click Activate.
8. Right-click the .csd file and click Activate.

Create a communication arrangement

1. In the Solution Explorer, right-click the .csd file and select Communication Arrangement.
The Communication Arrangements view opens.
2. Click New.
3. In the New Communication Arrangement view, do the following:
a. In the Select Scenario step, select the GetCity communication scenario and click Next.
b. In the Define Business Data step, enter the System Instance ID GETCITY-[]namespace of your
solution]_ and click Next.
c. In the Define Technical Data step, click Edit Advanced Settings, and do the following:
1. Under Details: GetCity, deselect the Use Basic Settings checkbox.
2. In the Application Protocol field, select Http and, if required, change the protocol to Hypertext
Transfer Protocol (http).
3. In the Authentication Method field, select None.
4. Click Check Completeness and make sure that no errors occur, then click Next.
d. In the Review step, review your entries, and click Finish and Close.

Create a business object

1. In the studio, in the Solution Explorer, open your solution and click Add New Item ( ).
2. In the Add New Item dialog, select Business Object, enter the name Address and click Add.
3. In the editor, enter the following code:
import AP.Common.GDT as apCommonGDT;
businessobject Address {
[Label ("Country")] element CountryCode: CountryCode;

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 555
 [Label ("Postal Code")] element PostalCode:PostalCode;
[Label ("City")] element City: LANGUAGEINDEPENDENT_LONG_Name;
}
Save and activate the business object.

Create a script file

1. In the Solution Explorer, right-click the business object and select Create Script Files.
2. In the Create Script Files dialog, select Event: After Modify and click OK.
An .absl file is generated.
3. Enter the following code:
import ABSL;
// Communication details
var ScenarioName = "GetCity";
var ServiceName = "GetCityByPostalCode";
var HttpMethod = "GET";
var HttpResource = ""; // not required for this example
var ContentType = ""; // not required for this example
var Body = ""; // not required for this example
var HeaderParameter : collectionof NameAndValue; // not required for this example
// Set URL Parameter
var URLParameter : collectionof NameAndValue;
var URLParameterEntry : NameAndValue;
URLParameterEntry.Name = "country";
URLParameterEntry.Value = this.CountryCode;
URLParameter.Add(URLParameterEntry);
URLParameterEntry.Name = "postalcode";
URLParameterEntry.Value = this.PostalCode;
URLParameter.Add(URLParameterEntry);
URLParameterEntry.Name = "username";
URLParameterEntry.Value = // Add your user name;
URLParameter.Add(URLParameterEntry);
// Execute webservice call
var ws_result = WebServiceUtilities.ExecuteRESTService(ScenarioName, ServiceName,
HttpMethod, HttpResource, URLParameter, HeaderParameter, ContentType, Body);
//Parse result of Web service and retrieve city name; you may have to adapt the
logic to the Web service used
var position = ws_result.Content.Find("placeName");
if ( position != -1)
{ var start = position + 12;
position = ws_result.Content.Find("lat");
if ( position != -1)
{ var length = position - start - 3;
this.City = ws_result.Content.Substring(start, length);
}
else { this.City = ""; };
}
else { this.City = ""; };
4. Save and activate the script file.

SAP Cloud Applications Studio – Version May 2018 (1805)

556 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Create screens
1. In the Solution Explorer, select the business object and select Create Screens.
2. In the Create Screens dialog, select a screen scenario, enter a Short ID and click OK.
Several .uicomponent files are generated.

Test the Web service

1. Right-click the OWL.uicomponent file and select Preview Screen.
2. Log on to the SAP cloud solution.
3. In the object work list, click New.
4. In the quick activity, select a country and enter a postal code of your choice, then click Save.
The city field is automatically filled by the REST Web service.

The REST Web service has filled the City field

8.15.5.8 Define a Communication Scenario

In a communication scenario, you can define a set of inbound and outbound services for a business process. Inbound
services are Web services that you have created based on an SAP or custom business object, or Web services
provided by SAP. Outbound services are external Web services that you have integrated into your solution. Based
on a communication scenario, a customer can create a communication arrangement in SAP’s cloud solution to
exchange business documents electronically.
For more information about communication arrangements, see the "Communication Arrangements Quick Guide"
in the documentation of the SAP cloud solution.

Prerequisites
● You have opened a solution in the studio.
● You have checked the available inbound services in the Service Explorer of the SAP cloud solution. The Service
Explorer lists all released inbound services available for the solution, along with service documentation and
technical data. For more information, see the "Service Explorer Quick Guide" in the documentation of the SAP
cloud solution.
● You have created and activated an inbound service or an outbound service.

An inbound service is a Web service that is based on a business object. An outbound service is a Web
service that you have integrated into your solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 557
 For more information about creating an inbound Web service, see Create a Web Service [page 545].
For more information about integrating an outbound Web service, see Integrate an External Web Service
Using SOAP [page 551] and Integrate an External Web Service Using REST [page 552].

There are three ways to define a communication scenario:

1. You can use the Add New Item dialog. This procedure is described below.
2. You can use the Define Communication Scenario step of the External Web Service Integration Wizard.
3. After integrating an external Web service using SOAP or REST into your solution, you can right-click
the .wsid file in the Solution Explorer and select Create Communication Scenario Definition.

Procedure
1. Right-click your solution and select Add New Item .
2. Select the Communication Scenario template, enter a name, and click Add.
The Communication Scenario Definition Wizard opens.
3. In the Enter Communication Scenario Name step, do the following:
a. Enter a name for the communication scenario and select the Web service type SOAP or REST.
For more information, see Integrate an External Web Service Using SOAP [page 551] and Integrate
an External Web Service Using REST [page 552].
b. SOAP only: Select the communication type:
● Business-to Business (B2B) to define the electronic exchange of business documents with a
business partner.
● Application Integration (A2X) to define the electronic exchange of business documents with a
communication system, for example, an external time recording system.

For more information about communication types, see the “Communication Arrangements Quick
Guide” in the documentation of the SAP cloud solution.
c. Optional: Select Allow Non-Secure URLs (HTTP).
d. Click Next.
4. In the Select Services and Operations step, select the inbound and outbound services that you want to include
in your communication scenario and click Next.
5. REST only: In the Enter API Keys for Communication Scenario step, do the following:
a. In the API Key field, enter the name of the API key that is relevant for the external Web service. Your
customer can then enter values for the API key in the corresponding communication arrangements in
the cloud solution. For security reasons, you cannot access the values of the API key in your business
logic. However, if you want to use the values, you can use the generated placeholders instead.
b. Click the Placeholder for API Key in Script File field to the right of the API Key field.
The placeholder is generated, which you can use in the script file.
c. Click Next.
6. Review your settings and click Finish.

A communication scenario definition with the file extension .csd ( ) appears in the Solution Explorer.
7. In the Solution Explorer, right-click the communication scenario definition and select Activate.

SAP Cloud Applications Studio – Version May 2018 (1805)

558 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Result
You have created a communication scenario definition in the studio. You can now do the following:
● Create a communication system in the SAP cloud solution
If you have chosen to create an application integration scenario, you can now create a communication system.
For more information, see Create a Communication System [page 562].
● Create a communication arrangement in the SAP cloud solution
For more information, see Create a Communication Arrangement [page 563].
● Optional: Test the execution of the service operations provided by the external Web service that you have
integrated into your solution.
For more information, see Test a Service Operation [page 564].
● Call the service operations of the inbound and outbound services in a script file.
For more information, see Define the Business Logic for a Business Object [page 369].

8.15.5.9 Modify an External Web Service Integration (SOAP)

You can modify an external Web service integration that you have created to access a remote application.
If you use SOAP-based communication, you can make the following changes:
● Replace the existing WSDL file with a new file
● Add or remove XML schema documents, if any are referenced in the WSDL file

Prerequisites
● You have created an external Web service integration.
For more information, see Integrate an External Web Service Using SOAP [page 551].
● If you want to replace the current WSDL file with a new file, you have saved the new WSDL file on your local
computer.
● If the WSDL file refers to one or more XML schema documents, you have saved the schema documents on
your local computer.

Procedure
1. In the Solution Explorer, double-click the .wsid file ( ) of the external Web service integration that you want
to modify.
2. To modify your external Web service integration, select the General tab. Do one of the following:

● To import a new WSDL file, click Upload WSDL File and select the file from the location on your computer
where you have saved it.
● If the WSDL file refers to one or more XML schema documents, select the schema document from
your local computer and click Add.
● If you want to remove one or more XML schema documents that you have already added, select the
schema document from the list and click Remove Document.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 559
 If you import a new WSDL file and XML schema documents were uploaded for the previous WSDL file,
the schema documents are deleted on saving the changes.

3. To view the service operations provided by the external Web service, select the Service Operations tab.
4. Click Save.
5. In the Solution Explorer, right-click the external Web service integration file, and select Activate.

Result
● To test the execution of the service operations provided by the external Web service, right-click the .wsid
file and click Test Service Operations.
For more information, see Test a Service Operation [page 564].
● The external Web service integration is re-activated. You can add it as an outbound service in a communication
scenario and create a communication arrangement based on the communication scenario. For more
information, see Define a Communication Scenario [page 557] and Create a Communication Arrangement
[page 563].

See Also
Modify an External Web Service Integration (REST) [page 560]

8.15.5.10 Modify an External Web Service Integration (REST)

You can modify an external Web service integration that you have created to access a remote application.
If you use REST-based communication, you can define or delete API keys used for authentication.

Prerequisites
You have created an external Web service integration. For more information, see Integrate an External Web Service
Using REST [page 552].

Procedure
1. In the Solution Explorer, double-click the .wsid file ( ) of the external Web service integration that you want
to modify.
2. To modify your external Web service integration, do one of the following:
● On the General tab, select the Allow Non-Secure URLs (HTTP) checkbox.

If you select this checkbox, you cannot use API keys any longer.

● On the API Keys tab, delete or define API keys.

3. Click Save.
4. In the Solution Explorer, right-click the external Web service integration file, and select Activate.

SAP Cloud Applications Studio – Version May 2018 (1805)

560 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Result
The external Web service integration is re-activated. You can add it as an outbound service in a communication
scenario and create a communication arrangement based on the communication scenario. For more information,
see Define a Communication Scenario [page 557] and Create a Communication Arrangement [page 563].

See Also
Modify an External Web Service Integration (SOAP) [page 559]

8.15.5.11 Modify a Communication Scenario

You can modify a communication scenario that you have created based on a business-to-business or application
integration communication type. You can modify a communication scenario as follows:
● Change the communication type on which the communication scenario is based.
● Add or remove inbound and outbound services.

Prerequisites
You have defined a communication scenario. For more information, see Define a Communication Scenario
[page 557].

Procedure
1. In the Solution Explorer, double-click the .csd file of the communication scenario that you want to modify.
2. To modify your communication scenario, do one of the following:
● Change the communication type on which the communication scenario is based.
● Select or deselect the inbound and outbound services that you want to add or remove.
3. Click Save.
4. In the Solution Explorer, right-click the communication scenario and select Activate.

Result
The communication scenario definition is re-activated. You can now use the modified communication scenario to
create a communication arrangement in the SAP cloud solution. For more information, see Create a Communication
Arrangement [page 563].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 561
8.15.5.12 Create a Communication System

To test the application integration scenario, you can create a communication system, which you can then use when
you create the communication arrangement. When your customers use the solution in their production system, they
create the communication system in the SAP cloud solution.
A communication system represents an external system which is used for application integration. Communication
systems can be, for example, external time recording applications or master data systems. You define a
communication system in the SAP cloud solution and use it when you create the communication arrangement.
For more information, see the “Communication Systems Quick Guide” in the documentation of the SAP cloud
solution.

Prerequisites
● You have defined an external Web service integration using SOAP or REST as described in the following table:

You have defined an external Web service You have defined an external Web service integration scenario
integration scenario using SOAP using REST

In the External Web Service Integration The communication system is created automatically.
Wizard, in the Enter Web Service Name and However, you can follow the procedure described below to change the
Type step, you have chosen to define an communication system or its properties.
Application Integration scenario.

For more information, see Integrate an For more information, see Integrate an External Web Service Using
External Web Service Using SOAP REST [page 552].
[page 551].

● You have created a communication scenario. For more information, see Define a Communication Scenario
[page 557].

Procedure
1. In the studio, in the Solution Explorer, right-click the communication scenario definition (.csd) file and select
Manage Communication System.
2. The SAP cloud solution opens. Log on to the system.
The Communication Systems view opens.
3. Click New.
The New Communication System screen opens.
4. Under Basic Information, enter an ID for the communication system, the Host Name, and the System Access
Type.

You can find the host name in the .wsdl file.

5. Click Save and Close.

6. Refresh the screen.
The communication system that you have created is displayed in the Communication Systems view.

SAP Cloud Applications Studio – Version May 2018 (1805)

562 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 7. Select your communication system and click Actions Set to Active .
The status of the communication system changes to Active.

Result
You have created a communication system. You can now use it to create a communication arrangement to test the
application integration scenario. For more information, see Create a Communication Arrangement [page 563].

8.15.5.13 Create a Communication Arrangement

To test the communication scenario you have created, you need to create a communication arrangement in the SAP
cloud solution.
Usually, your customer sets up the communication arrangement for your solution in the SAP cloud solution.
However, to test the communication scenario you have created, you need to create a communication arrangement
as well.
For more information on communication arrangements, see the “Communication Arrangements Quick Guide” in
the documentation of the SAP cloud solution.

Prerequisites
You have created a communication scenario in your solution.

Procedure
1.
In the studio, in the Solution Explorer, right-click the communication scenario definition (.csd, ) file and
click Manage Communication Arrangement.

2. Log on to the SAP cloud solution.

The Communication Arrangements work center view opens.
3. Click New.
4. The New Communication Arrangement view opens.
5. In the Select Scenario step, select the communication scenario that you have created in the studio and click
Next.

When you hover over the name of the communication scenario, its key is displayed. It contains the
namespace of your solution.
When there is a solution with a communication scenario, and a patch solution is also created for the
solution, you will see two communication scenarios with the same name in the system. In such cases,
if you wish to create a communication arrangement to test the communication scenario within the
patch solution, then you must select the communication scenario with the word patch in brackets.

6. In the Define Business Data step, select the business partner and click Next.
7. In the Define Technical Data step, do the following:
a. Select the Application Protocol and Authentication Method. You can select one of the following options:

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 563
 ● SSL Client Certificate: Enter a certificate.
● User and Password: Click Edit Credentials and, in the Authentication dialog, enter a User ID and,
optionally, a password.
● None (REST only)
b. Enter the Host Name.
You can find it in your solution in the studio: In the Solution Explorer, open the .wsid file, go to the
General tab, and copy the name from the Host Address field.
c. Click Next.
8. In the Review step, review your entries and click Check Completeness. Then click Finish and Close.

Result
Your communication arrangement is created. You can now test your web service.
For more information, see Test a Web Service [page 547].

8.15.5.14 Test a Service Operation

You can use the Test Tool to test the execution of the service operations provided by an external Web service.

Prerequisites
● You have integrated an external Web service using SOAP and activated the .wsid file.
For more information, see Integrate an External Web Service Using SOAP [page 551].
● You have created a communication scenario.
For more information, see Define a Communication Scenario [page 557].
● A communication arrangement exists for the communication scenario.
For more information, see Create a Communication Arrangement [page 563].

Procedure
1. In the Solution Explorer, right-click the .wsid file of the external Web service integration for which you want
to test the execution of service operations and select Test Service Operations.
The Test Tool opens.

The Test Tool tab is not available in the following cases:

● You cleaned the .wsid file.
● You deleted the .wsdl file.
● You uploaded a new .wsdl file to replace the original file.

2. Select a service operation.

3. Provide test values for the request message in the Request tab and click Submit Request.
4. Select the communication scenario and click OK. If the communication scenario is based on a B2B
communication type, enter the business partner name.

SAP Cloud Applications Studio – Version May 2018 (1805)

564 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 5. Click OK.
You can see the response message in the Response tab and verify if it is correct.

Result
You have tested the integrated Web service. If you are not satisfied with the result, you can edit the external Web
service integration. For more information, see Modify an External Web Service Integration (SOAP) [page 559].

8.16 Report an Incident

If you encounter a problem during development, you can report an incident to request help in solving the problem.
the SAP cloud solution collects context data, such as system information and relevant business data, and attaches
it to the incident. This gives information about the system at the time at which the incident occurred and helps SAP
Support to better understand the problem. Note that the context data is only useful if you report the incident from
the screen on which the problem occurred, as it includes information that is specific to that screen. This means it is
important that you always report your solution-related incidents from the screen on which they occur in your system.
You report a problem that is not related to your UI components in the Partner Development work center in the SAP
cloud solution. For example, you create an incident in this work center if you encounter issues with the studio or the
user interface designer.

You cannot create an incident from the studio or the user interface designer.

Prerequisites
If you create the incident for SAP Support from the SAP cloud solution, you must be logged on to that system with
your development user. Development users have administrator rights in the SAP cloud solution and are assigned to
the Incidents view. This view is available in the SAP cloud solution as follows:
● In the SAP Cloud for Customer solution: Administrator Incidents
● In all other SAP cloud solutions: Application and User Management Incidents

Note that you can also create an incident with a standard business user. However if that business user is not an
administrator in the SAP cloud solution, the system forwards the incident to the responsible development user with
administrator rights, who in turn forwards it to SAP Support.

Procedure
1. In the SAP cloud solution, click Help Report Incident .
2. Enter the required details.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 565
8.17 Debugging

8.17.1 Debugging Quick Guide

You can use debugging to observe the runtime behavior of your solution and to locate logic errors.
For information about how to access the debug functions, see Debugging User Interface [page 571].

Each time you start the debugger, tracing is also started automatically. For more information about tracing,
see here [page 575].

Business and Technical Background

The main tool that you use for debugging is the debugger, which works with your script files and allows you to break
the execution of your solution at specified breakpoints to examine your code and to display values of variables defined
in your solution.
For more information, see About Debugging [page 567].

Tasks

Debugging a Solution
This simple process explains how you can easily debug your solution. For more information, see here
[page 573].

Set a Breakpoint
1. In the Solution Explorer, open a script file.
The script file opens in the code editor.
2. You can set a breakpoint in the code editor by doing one of the following:
● In the left grey margin of the code editor, click a line of executable code.
● Click a line of executable code and press F9 .

The glyph in the margin indicates that a breakpoint is set.

Delete a Breakpoint
To delete breakpoints in your current script file, proceed as follows:
● To delete a particular breakpoint, click or press F9 in the code line, where the breakpoint has been set.
The margin is cleared and the red glyph is deleted.
● To delete all breakpoints in your script file, in the toolbar of the Breakpoints tool window, click Delete all
breakpoints

Disable or Enable a Breakpoint

● To disable breakpoints that are set in the current script file, proceed as follows:

SAP Cloud Applications Studio – Version May 2018 (1805)

566 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 ○ To disable a particular breakpoint, in the Breakpoint tool window, clear the checkbox of the enabled
breakpoint.
The breakpoint is now disabled.
To disable all breakpoints in your script file, in the toolbar of the Breakpoints tool window, click Enable
or disable all breakpoints

● To enable breakpoints that have been disabled before, proceed as follows:

○ To enable a particular breakpoint, in the Breakpoint tool window, select the checkbox of the disabled
breakpoint.
The breakpoint is enabled again.
○ To enable all disabled breakpoints, in the toolbar of the Breakpoints tool window, click Enable or disable
all breakpoints

Start and Stop Debugging

● To start debugging, in the Debug toolbar, click or press F5 .
The code editor is brought to the foreground and Debug windows are enabled, for example, the Breakpoints
window and the Locals window. The debugger is in run mode and you cannot edit your code anymore. You
can now open a screen, for example, by using the preview function, to debug your solution.
● To stop debugging, in the Debug toolbar, click or press SHIFT + F5 .
The Debug windows are closed and you are in design mode again, that is, you can now edit and change your
code.

Step Through the Code

In break mode, you can perform the following activities to step through your code:

Your Activity Icon Ksey

Step through the code one statement at a time F10

Hit the next breakpoint F5

You are inside a script file and want to return to the calling SHIFT + F11
script file

If you have inspected another script file and want to return to the script file, where the running process has
stopped, in the Debug toolbar, click .

8.17.2 Business and Technical Background

8.17.2.1 About Debugging

Debugging is an important process during the development of a solution which enables you to observe the runtime
behavior of your solution and to locate logic errors. The main tool that you use for debugging is the debugger, which
works with your script files and allows you to break the execution of your solution at specified breakpoints to examine
your code and to display values of variables defined in your solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 567
Each time you start debugging in the studio, tracing is also started automatically. The tracing information enriches
the debug information with informational messages and, if applicable, with error messages. For more information,
see Tracing [page 575].

Debugging Basics

Debug Modes
During design mode, which is the mode when you are implementing the business logic for your solution, you cannot
use the debugger. However, you can manage breakpoints, for example, set or delete them.
After you have started debugging, you cannot edit or change your code anymore. The following debug modes are
available:
● Run Mode
This mode is divided into the following phases:
○ The debugger is waiting to attach to a process that is represented, for example, by the actions that you
perform on a screen in your solution. In this mode, you can manage breakpoints, for example, set or
delete breakpoints.
○ The debugger is already attached to a process and is executing the business logic. This phase ends when
execution is completed or when the debugger hits a breakpoint.
During this phase you can set breakpoints, but the breakpoints are only enabled after execution is
completed.
● Break Mode
You have opened a screen in your solution, for example, by using the preview function in the studio. When
you perform actions on this screen and a break occurs, your solution and the debugger are in break mode.
During break mode, you can use all debugging functions and inspect the information provided by the
debugger.

Breakpoints
Breakpoints enable you to suspend execution where and when you need to. You can allow your solution to run until
it hits a breakpoint, and then you can start to debug your code.
The following functions are available for breakpoints:
● Setting and Deleting Breakpoints
You set or delete a breakpoint in the left margin of your script file manually. A breakpoint location is indicated
by a glyph in the margin. All breakpoints that are set in your solution are listed in the Breakpoints window.
● Disabling and Enabling Breakpoints
You can disable or enable a breakpoint that is already set. The glyph indicates that the breakpoint is enabled.
The glyph indicates that the breakpoint is disabled. If you disable a breakpoint, you can still see where it
was set, but the debugger does not stop execution at this position anymore. Only if you enable the breakpoint
again, the debugger will stop execution when it hits this breakpoint.
● Exporting and Importing Breakpoints
You can export breakpoints to a local XML file, for example, to create a backup or to share them with another
user.

For information about how to set and manage breakpoints, see Debugging Quick Guide [page 566].

Stepping
One of the common debugging procedures is stepping, which means, executing code one statement at a time.
Execution stops if the debugger reaches one of the following:

SAP Cloud Applications Studio – Version May 2018 (1805)

568 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 ● A code line that contains an executable statement.
If a code line contains more than one executable statement, the debugger executes them one statement at
a time.
● An enabled breakpoint.
● The end of the script file.

If the debugger reaches the end of a script file, it steps out of the current script file and stops at the next executable
statement in the calling script file. Execution continues if there is no call from another script file.

Frequently Asked Questions

Why can't I set a breakpoint in this code line?

Please check the following:
● Does the current code line contain an executable statement?
If not, you can't set a breakpoint in this code line.
● Has the script file been activated?
If not, stop debugging and then activate the script file. Restart debugging and then set the breakpoint.
● Did you already reach a number of 30 breakpoints in your script file?
You have reached the maximum number of breakpoints in a script file. Before you are able to set a new
breakpoint, delete one or more breakpoints which you don't need.

Why didn't the debugger hit a specific breakpoint?

Please check the following:
● Has debugging been started and if yes, has it been started for the correct user?
In the Options dialog box, on the Tracing and Debugging tab, check whether the setting for the business user
is correct. If you want to enable debugging for your development user, please make sure that the Enable for
business user checkbox is deselected. For more information about this setting, see Debug User Interface
[page 571] under Debug Settings Debugging and tracing: Enable for business user .
● Does the breakpoint look like this: ?
If yes, the breakpoint is disabled. Please enable the breakpoint by selecting the checkbox of the disabled
breakpoint in the Breakpoint tool window. Now the breakpoint is enabled and looks like this: .
● Did you activate the script file or the solution after you have set the breakpoint?
If not, the breakpoint is not valid. Please stop debugging, close the screen, and then activate the solution.
Restart debugging and open the screen again, for example, by using the preview function.
● Did you open the screen before you have activated the script file or the solution?
If yes, close the screen and open it again, for example, by using the preview function.
● Did the debugger already hit a breakpoint in the other session?
Please keep in mind that the debugger evaluates only one session at a time. A session typically corresponds
to the actions performed on one screen. Although you are able to perform actions in parallel on another screen
during the debug run, you can't debug the code of these actions.
● Is the debugger still executing the business logic in another session?
In the Debug toolbar, you have clicked or and the debugger is still executing the business logic in the
other session. Please wait until execution is finished. You can then start execution in the next session.

When I am stepping through the code, why can't I see some variable values?
The value of a variable doesn't show in the Locals window, when the following applies:

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 569
 ● The variable is currently not in scope, that is, it is defined in a code block of a foreach or if statement.
● The variable contains a query. As the compiler optimizes the code, query variables are not available at runtime.
● The value is not stored in a variable. The value is the result of an association or a function, which is part of a
path expression, but which is not explicitly assigned to a variable.

Can I step within a path expression?

No, stepping executes the entire statement.

Can I debug more than one session in parallel at a time?

No, the debugger evaluates only one session at a time. A session typically corresponds to the actions performed on
one screen. Although you are able to perform actions in parallel on another screen during the debug run, you can't
debug the code of these actions.

Why doesn't the Output window update the tracing information after a certain period of time?
If you have opened your screen, for example, by using the preview function, and you haven't performed any actions
on this screen for 10 minutes, tracing will stop automatically.
If you want to enable tracing again, restart debugging and perform the actions on the screen again.

Can I enable debugging to examine actions performed by a specific business user?

Yes, you can. For more information, see Debug User Interface [page 571] under Debug Settings Debugging
and tracing: Enable for business user .

Can I cancel a session using the debugger?

No, this is not possible. Just close the screen on which you are performing the actions. This will cancel the debug
session.

How can I debug an internal communication scenario?

In an internal communication scenario, business objects exchange XML messages in an asynchronous way, which
means that the source business object (source BO) sends a request message to the target business object (target
BO) and the target BO processes this message accordingly. The processes related to the source BO and the
processes related to the target BO run in different sessions.
The debugger can stop either in the script files of the source BO or in the script files of the target BO. If you want to
debug the script files of the target BO, please make sure that the breakpoints in the script files of the source BO are
disabled.

Can I debug a Web Service in the Cloud Applications Studio?

No. Debugging of a Web Service is not possible since a technical user is required for the execution. This technical
user is different from the user that executes that web service.

Which user can I use to debug an XML file input run?

Debug the actions with the business user who schedules the file input run. For this, in the Options and Settings dialog
box on the Debugging and Tracing tab, enter the name of the relevant business user. For more information about
this setting, see Debug User Interface [page 571] under Debug Settings Debugging and tracing: Enable for
business user .

SAP Cloud Applications Studio – Version May 2018 (1805)

570 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.17.2.2 Debugging User Interface

The studio's debugging user interface is composed of several elements, which enable you, for example, to select
debugging functions, to view information provided by the debugger, and to specify debug settings.

Debug Menu
You can find all debugging and tracing functions in the Debug menu. There you can also enable the appropriate
windows, for example, the Call Stack window or the Output window.

Debug Toolbar
The Debug toolbar provides buttons that allow you to start and stop debugging together with tracing and also to
start and stop tracing separately. If you have already started debugging, the tracing buttons are inactive. The
Debug toolbar is automatically enabled when you start debugging. To enable the Debug toolbar separately, choose
View Toolbars Debug .

Debug Windows
The debug windows display information the debugger provides and support you in analyzing this information. The
following windows are provided:
● Locals
● Breakpoints
● Call Stack
● Output

To enable a debug window, choose Debug Windows and select the appropriate window.

You can only enable the Locals window and the Call Stack window if debugging has started.

Locals Window
This window displays variables local to the current script file. You can view the name, the value, and the type of the
variable. If the variable type is a structure, a business object node or a collection, you can expand or collapse the
information provided. You cannot edit this information.

Breakpoints Window
This window lists all breakpoints that are set in your solution. The Breakpoints window also contains a set of functions,
which allow you, for example, to disable and to enable breakpoints and to export breakpoints to an XML file. For more
information about breakpoints, see About Debugging [page 567].

Output Window
In the Debug view of the Output window you can view tracing information that the system is collecting during the
debug run. Each script file is listed in the order it was called and can be nested if it was called from another script fie.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 571
The information displayed in the Debug view is the same information that you can find in the Trace Explorer window.
However, the information in the Debug view is displayed during the debugging process whereas the information in
the Trace Explorer window is displayed after debugging or tracing has been stopped. The format in the Debug view
is also quite different, that is, each line starts with a time stamp and the session number and severity, for example,
[1:E] for session 1, containing an error message in the specified script file.

The debugger evaluates one session in parallel at a time. A session typically corresponds to the actions
performed on one screen. Although you are able to perform actions in parallel on another screen during the
debug run, you cannot debug the code of these actions.

Call Stack Window

The Call Stack window supports you in finding out which script file called the script file that is currently processed.
The arrow identifies the script file which is currently processed. If you double-click in the window, the
corresponding code line in the script file is highlighted in yellow. The arrow identifies the script file from which
the script file with the arrow has been called. If you double-click in the window, the corresponding script file
is brought to the foreground and the code line containing the call is highlighted in green.

DataTips
A DataTip is a box in the code editor that displays the value of a variable in your solution similar to the Locals window.
When the debugger is in break mode, you can enable a DataTip in the current script file by placing the mouse pointer
over a variable in the code editor.
You can pin a DataTip to a specific location in the script file or you can leave it floating on top of all studio windows.
For more information about DataTips, see the Microsoft Visual Studio documentation at http://www.microsoft.com
.

DataTips are not supported if the path to the element includes an association or a function call.

Debug Settings
You can set debug settings in the Options dialog box as a default. To change the debug settings, choose
Administration Options and Settings . In the navigation pane of the Options dialog box, click SAP and then click
the Debugging and Tracing tab on the right. The following settings are provided:
● Debugging and tracing: Enable for business user
Usually, you examine actions performed on a screen when you are logged on to the cloud solution with your
development user. However, you can also enable debugging and tracing to examine actions that are
performed by a specific business user.
If you enable this option the breakpoints that you set in your script file are only relevant for this specific
business user. This means that the debugger only stops at a breakpoint when the script file is executed by
this specific user. The debugger does not stop at a breakpoint when the script file is executed by another user.

Change the setting of this option only when you are in design mode.

● Before starting the debugger

SAP Cloud Applications Studio – Version May 2018 (1805)

572 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Before you start debugging, the system prompts you to save changes and to refresh and activate your
solution. Here you can change this setting, for example, you can enable the system to save, refresh, and
activate automatically every time you start debugging.

The other debug settings in the Options dialog box are default Microsoft Visual Studio settings, which do not
have any impact on the studio's debugger.

8.17.2.3 Debugging a Solution

This simple process explains how you can easily debug your solution. For information about the functions that you
can use for debugging, see Debugging Quick Guide [page 566].

Prerequisites
● You have created a solution, defined a business object, and implemented the business logic in a script file.
● You have created a screen for your business object.

Process Flow
1. You open the script file in the code editor and set breakpoints.
2. You start debugging.
3. You open your screen, for example, by using the preview function, to observe the runtime behavior of your
solution.
You can also debug your solution when you log on to the SAP cloud solution and select the relevant screen.
4. On the screen, you perform the actions that are implemented in your script file.
When the debugger hits a breakpoint, it breaks the execution of your solution and the system brings the code
editor with the corresponding script file to the front.
You can now step through the code, display variable values, and analyze the tracing information.
5. When you have found an error, you stop debugging and correct the error.
6. You start debugging again. Make sure that you have reactivated the solution and preview your screen again.

8.18 Tracing

8.18.1 Tracing Quick Guide

You can use tracing to record information about your code as it is being executed. From the Trace Explorer, you can
run a local trace, run a trace for an end user, use incident traces for troubleshooting purposes, and view the results
of a recorded trace.

If you have started the debugger tracing is turned on by default. You can start tracing separately when the
debugger is not started.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 573
You can access the tracing functions as follows:
● To enable the Trace Explorer tool window, click Debug Windows Trace Explorer .
The Trace Explorer provides a view of active and completed traces.
● To enable the Debug toolbar, click View Toolbars Debug .
The Debug toolbar provides buttons that allow you to start and stop tracing separately. When you have already
started the debugger, these tracing buttons are inactive.

Business and Technical Background

Tracing
You can use tracing to record information about your code as it is being executed, including variable values,
informational messages, and error messages. By inspecting the information recorded by a trace, you can obtain a
better understanding about how your code works and troubleshoot problems.
For more information about tracing, see here [page 575].

Trace Class and Methods

You can use the methods defined by the Trace class in the ABSL namespace to record information about the state
of your code. Method calls from the Trace class are evaluated and recorded when a trace is active in the system.
The Trace class provides methods to record informational messages (Trace.Info) and error messages
(Trace.Error).
For more information about the Trace class and methods, see here [page 577].

Tasks

Run a Local Trace

You can activate tracing on any system that you can log on to with your developer user account. When a trace is
active, script files are logged as they are executed, and methods from the Trace class are evaluated and recorded.
For more information about this task, see here [page 579].

Run a Trace for a Business User

You can activate tracing for a business user. When tracing has been activated for a business user, the code that is
executed by that user is traced. Because tracing is a developer feature, business users cannot enable tracing directly.
For more information about this task, see here [page 579].

Working with Incident Traces

When a user reports an incident in a productive system, you can ask them to reproduce the incident and include
trace information. This information can help you track down the source of the issue that the user is experiencing.
Incident traces contain the same information as local traces, but are tied to the lifecycle of the incident.
For more information about this process, see here [page 580].

View Trace Results

When a trace has been completed, you can view the recorded information in the Trace Explorer.
For more information about this task, see here [page 581].

SAP Cloud Applications Studio – Version May 2018 (1805)

574 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.18.2 Tracing

Overview
You can use tracing to record information about your code as it is being executed, including variable values,
informational messages, and error messages. By inspecting the information recorded by a trace, you can obtain a
better understanding about how your code works and troubleshoot problems.
When you have started tracing, some information is traced automatically, including the identity of each script file
that is executed. You can enhance the information that is recorded during a trace by adding methods from the
Trace class to your script files. This way, you can record informational and error messages, and output variable
values.

Prerequisites
You are familiar with creating business objects and working with the scripting language.

Features

Local Traces
Local traces are the traces that are created when you start tracing on the system that you are logged on with your
developer user account. You can use local traces to evaluate code that is in development, or to investigate issues
that have been reproduced on a local system.
● Local Traces for Developer Users
When you start tracing, the script files that you run under your developer user account are recorded and the
methods from the Trace class are evaluated and recorded.
For more information, see Run a Local Trace [page 579].
● Local Traces for Business Users
You can configure tracing to record the actions of a business user instead of tracing the actions performed
under your developer user account. This enables you to observe workflows that are performed by a business
user in the cloud solution. Business users cannot activate tracing directly because tracing is a developer
feature that is accessed only in the studio. When you run a trace for a business user, the script files and the
trace statements in the code that are executed by the business user are evaluated and recorded.
For more information, see Run a Trace for a Business User [page 579].

Incident Traces
When business users encounter errors in a production system, they can use the incident reporting process to report
the error and request assistance. Business users can attach trace information to incidents, and you can use this
information to help troubleshoot the cause of the incident.
You work with incident traces the same way as you work with local traces. However, incident traces are tied to the
life span of an incident. Incident traces are created when the incident is submitted and are deleted when the incident
is closed. When you use the trace information that is attached to an incident, it is important to compare it to code
from the same version of the system that was used to report the incident. Otherwise, the code paths may have
changed and trace statements may be different.
For more information, see Working with Incident Traces [page 580].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 575
Performance
Trace information is only recorded while an active trace is running. When tracing is not active, no system resources
are allocated for tracing. The methods from the Trace class are only evaluated when a trace is active; therefore you
can include them in your script files without incurring any performance penalty during the course of regular operation.

Tracing can record a potentially large amount of information; therefore it is recommended to start tracing
for limited periods of time. Otherwise, the amount of data recorded by the trace may become
unmanageable. Tracing is automatically stopped if it is left running.

Interpreting Trace Results

In the Trace Explorer window, you can view information about the session, sequence, and script files that are called,
as well as the results of evaluating methods from the Trace class that have been added to script files, and information
about other errors that have occurred.

Tracing can record several sessions in parallel at a time. A session typically corresponds to the actions
performed on one screen. In contrast to this, the debugger can evaluate only one session in parallel at a time.

As each session, sequence, and script file is called, a trace message is recorded in a tree structure in the trace details
pane. The trace messages are numbered in the order that they were called, and are nested under the calling parent
session, series or script file as follows:
● Session
Each session is displayed in order.
● Sequence
Each sequence is displayed in order.
● Script file
Each script file is displayed in the order it was called, and may be nested if it was called from another script
file. This view displays a summary of all of the trace messages for this script file. If any of the trace messages
for the script file are error messages, then an error icon is displayed. This enables you to quickly identify which
script files contain error messages without having to manually view the details about each script file.

You can view details about the trace messages recorded for each script file by double-clicking the script file entry in
the Trace Explorer window. This displays the script file in the Trace Details pane. The Trace Details pane contains a
list of the trace messages that were recorded for the script file. The first item in this list is a message that identifies
the script file. The rest of the list contains the results of calling methods from the Trace class, and errors that may
have occurred. The details for the trace messages are as follows:
● Status
This defines whether the message is an error or for information purposes.
● Type
This defines the type of message. For example, every script file is identified by a message whose type is
"this" object ID. Messages that were generated by method calls from the Trace class are identified by
a message of type user-defined trace command.
● Number
The order that this trace message was processed for this script file.
● Name
The name of the message. For messages recorded by the Trace class, this displays the first parameter passed
to the Trace.Info and Trace.Error method calls.
● Value

SAP Cloud Applications Studio – Version May 2018 (1805)

576 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 The value of this message. For object identification messages, this can be the alternative key or the UUID of
the object. For Trace class messages, this is the value of the second parameter passed to Trace.Info and
Trace.Error method calls.

See Also
Trace Class and Methods [page 577]
Tracing Quick Guide [page 573]

8.18.3 Trace Class and Methods

Overview
You can use the methods defined by the Trace class in the ABSL namespace to record information about the state
of your code. Method calls from the Trace class are evaluated and recorded when a trace is active in the system.
The Trace class provides methods to record informational messages (Trace.Info) and error messages
(Trace.Error).

Trace Class
The Trace class provides methods that you can use to record information about the state of your code.

Importing the Trace Class

You import the ABSL namespace to access the Trace class.

import ABSL;

Trace.Error Method
You use the Error method to record information about errors. There are two overloads of the Error method, taking
one or two String parameters. The results of evaluating these methods are displayed in the Trace Details pane and
are marked by an error icon.

Syntax Trace.Error(String);
Trace.Error(String, String);

Example Trace.Error(“Creation failed”);

Trace.Error(“Creation failed”, this.Identifier.Content);

Trace.Info Method
You use the Info method to record information that is not an error case. There are two overloads of the Info method,
taking one or two String parameters. The results of evaluating these methods are displayed in the Trace Details
pane and are marked by an information icon.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 577
Syntax Trace.Info(String);
Trace.Info(String, String);

Example Trace.Info(“Test triggered”);

Trace.Info(“Test triggered”, this.Identifier.Content);

Example
import ABSL;
Trace.Info(“Start Test”, this.Identifier.Content);
Trace.Error(“Invalid parameter”, this.Identifier.Content);
Trace.Info(“End Test”);

Trace.Runtime Method
You use the Runtime method to record the lapsed time since the very first call of this method or the latest reset call.
There are two overloads of the Runtime method, taking one String parameter or a String parameter and an
Indicator parameter. If the Indicator is set to true, the runtime is reset and the measurement will show zero
again.
The results of evaluating these methods are displayed in the Trace Details pane and are marked by an runtime icon.
The value column will show the runtime used up in seconds.

Syntax Trace.Runtime(String);
Trace.Runtime(String, Indicator);

Example Trace.Runtime(“Runtime measurement started”, true);

Trace.Runtime(“Runtime used up to now”);

Example
import ABSL;
Trace.Runtime(“Start Measurement”, true);
Trace.Runtime(“Current time used up”);

See Also
Tracing [page 575]
Tracing Quick Guide [page 573]

SAP Cloud Applications Studio – Version May 2018 (1805)

578 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
8.18.4 Tasks

8.18.4.1 Run a Local Trace

Overview
You can activate tracing on any system that you can log on to with your developer user account. When a trace is
active, script files are logged as they are executed, and methods from the Trace class are evaluated and recorded.

Prerequisites
You must know how to run your script files, and you may want to add methods from the Trace class to your script
files to record custom information.

Procedure
1. To begin recording trace information, in the Trace Explorer window, click the Start Tracing button.
2. Run the script files that you want to trace.
3. To stop recording trace information, in the Trace Explorer window, click the Stop Tracing button.
4. To view traces, in the Trace Explorer window, click the Local Traces tab.
5. To update the list of traces, click the Refresh Traces button.
The completed trace appears in this list, identified by the time that trace was started, and the ID of the user
executing the code.

See Also
Run a Trace for a Business User [page 579]
Trace Class and Methods [page 577]

8.18.4.2 Run a Trace for a Business User

Overview
You may want to trace a workflow that can be run by a business user but cannot be run by a developer user. For
example, you must be logged on to the SAP cloud solution as a business user to access some workflows. Since
business users cannot activate and deactivate tracing, developer users can run a trace on their behalf through the
Trace Explorer. When a developer user activates a trace for a business user, the code that is executed by the business
user is traced.

Prerequisites
To record custom information, you have to add methods from the Trace class to your script files.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 579
Procedure
1. To open the trace settings dialog, click Administration Options and Settings . In the navigation pane of
the Options dialog box, click SAP and then click the Debugging and Tracing tab on the right.
2. Select Enable for business user.
3. In the text box, enter the ID of the business user to enable tracing, and click OK.
For example, enter PGREENE to enable tracing for the business user Peter Greene.
4. In the Trace Explorer window, click the Start Tracing button.
A dialog is displayed that confirms that the trace has been activated for the business user.
5. Log on to the system as the business user and run the workflow you want to trace.
6. In the Trace Explorer window, click the Stop Tracing button.
A dialog is displayed that confirms that the trace has been deactivated for the business user.
7. In the Trace Explorer window, click the Local Traces tab.
8. To update the list of traces, click the Refresh Traces button. The trace appears with the time stamp of when
the trace was started and the ID of the business user.
To view a trace, see View Trace Results [page 581].
To delete a trace, select one or more from the list and click Delete Selected Traces.

See Also
Run a Local Trace [page 579]
Trace Class and Methods [page 577]

8.18.4.3 Working with Incident Traces

Overview
When a user reports an incident in a productive system, you can ask them to reproduce the incident and include
trace information. This information can help you track down the source of the issue that the user is experiencing.
Incident traces contain the same information as local traces, but are tied to the lifecycle of the incident.

Prerequisites
You use the same version of the system that was used to report the incident.

Process Flow
1. A user encounters an error in the cloud solution and reports an incident to an administrator.
2. The administrator returns the incident and requests trace information.
3. In the Incident editor, the user clicks Start Trace and repeats the steps that caused the incident.
4. In the studio, the incident trace appears in the Incident Trace tab of the Trace Explorer.
5. Developer users with the relevant authorization can view the incident trace in the Trace Explorer.

SAP Cloud Applications Studio – Version May 2018 (1805)

580 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 6. The incident trace remains accessible until the incident is closed.

See Also
Working with Incidents
Tracing [page 575]

8.18.4.4 View Trace Results

Overview
When a trace has been completed, you can view the recorded information in the Trace Explorer.

Prerequisites
A completed local trace or open incident trace exists.

Procedure
1. In the Trace Selection area of the Trace Explorer, select the type of trace to view:
● To view local traces, click the Local Traces tab.
● To view traces for open incidents, click the Incident Traces tab
2. To display the current list of completed traces, click the Refresh button.
3. Select the check box next to the traces that you want to view, and click the Get Trace Details button.
Each selected trace appears in its own tab.
4. Expand the trace details to show the sessions, sequences, and script files that have been recorded for the
trace.
If the script file contains any error messages, it is marked by an error icon. This enables you to easily identify
the script files that contain errors. If the script file contains no errors, it is marked by an information icon.
5. Double-click a script file trace message to see detailed trace information for that script file in the Trace
Details pane.

See Also
Tracing [page 575]
Run a Local Trace [page 579]
Run a Trace for a Business User [page 579]
Working with Incident Traces [page 580]

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 581
8.19 Dump Analysis

8.19.1 Dump Analysis Quick Guide

You can use the Dump Analysis tool window to list the runtime errors that have occurred in the tenant to which you
have logged on. The tool window presents the dump information in a reader friendly format and supports you in
finding the root cause of a dump.

If the Dump Analysis tool window is not visible in the studio, you can access it by clicking View Dump
Analysis .

Business Background

What is a dump?
If a severe error occurs during execution of a solution, the runtime cannot continue to execute the solution and the
solution is terminated. In such a case a dump is written, which is a data record about the solution's state when it had
been terminated. Severe runtime errors occur, for example, when an unassigned reference or a division by zero is
used or the generated code contains syntax errors. Typically, the runtime error messages that are displayed on the
screen do not contain detailed information about the root cause of the dump. Runtime errors that occur in
background programs or asynchronous processes are even harder to detect, since there is no immediate feedback
to the user.

Tasks

Check for Dump Entries

In the Dump Analysis tool window, select one of the following options:
● Today
All dumps that occurred today are listed.
● Yesterday
All dumps that occurred yesterday are listed.
● All
All dumps that occurred are listed. The period covered depends on how long dumps are kept in the system.
The dump entries in the list are sorted by date.
● Advanced
In the corresponding dialog box, you can specify a date, a date range, a user name or a solution name. The
tool window will then list all dumps that meet these criteria.

The dump list is not updated automatically. To update the list, click Refresh or any of the other
buttons in the tool window. If you click Reset, the filter is cleared and the list shows the dump entries
of the current day.

SAP Cloud Applications Studio – Version May 2018 (1805)

582 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Dumps caused by the following runtime errors are not listed in the Dump Analysis tool window:
● The business object element has been deleted or renamed but the element is still used on the
user interface (UI).
● The data string in the business object element is too long for the database.

Filter Dump Entries

If the list contains a large number of dump entries, you can set a filter to reduce the number of entries by specifying
a date, a date range, a user name or a solution name.
1. In the Dump Analysis tool window, click Advanced.
The Advanced Selection dialog window is displayed.
2. Enter the relevant data and click Search.
Only the dump entries are listed in the Dump Analysis tool window that meet the filter criteria.
3. Optional: To clear the filter, click Reset in the Dump Analysis tool window.

Evaluate Dump Entries

1. In the Dump Analysis tool window, select a dump entry.

You can check the following:
● Time when the error occurred
● User who executed the solution when the error occurred
● Error type
● Solution name
● Path to the script file that caused the error
● Line and column of the script file where the error occurred
If these fields contain numbers in black, the position of the error in the script file has been identified and
you can navigate to this position in the script file. However, it is not always possible to show the correct
position of the error. For example, if the script file has been changed, cleaned, or deleted after the error
has occurred, the information about the previous position is displayed in grey. If the position cannot be
determined at all, the fields contain the information n/a.

2. Double-click the dump entry to open the script file in the editor.
The cursor is positioned in the line of the script file where the error occurred.
If the script file where the error occurred has been called by another script file, you can see this information
in the Call Stack area of the Dump Analysis tool window, .
3. Optional: In the Call Stack area, click the relevant line to open the script file that has called the other one.
The cursor is positioned in the line of the script file where the error occurred.

You can navigate from a line in the tool window to the corresponding script file, if the following conditions are
met:
● The current user is assigned to the customer ID for which the solution has been created..
● The solution or script file has not been deleted.

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 583
8.20 Translation

8.20.1 Translation Quick Guide

The studio provides functions that enable the translation of business configuration content texts and on-screen texts
into one of the languages supported by the cloud solution. The translation functions enable you to adapt a solution
created using the studio for a specific country or region. You can export the text of specific project items to a file in
XML Localization Interchange File Format (XLIFF). After the XLIFF file is translated, you can then import the
translated file into the studio and check the result. You can also monitor the translation status of project items.

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

The following table gives an overview of the project items from which you can extract text for translation and the
specific text elements that can be translated.

Texts That Can Be Extracted for Translation

Project Item Text Element

User interface (UI) component ● Title of floorplan and group

(*.uicomponent) based on a custom business ● Column and menu header
object (*.bo)
● Labels for field, checkbox, and radio button
● Definition, description, instruction, and information
● Other on-screen texts such as button text, link text, list item text,
explanation text, general text, tab strip text, quick info text, tree
node text, bullet list item text, technical text

The system does not support the extraction of message texts to an XLIFF
file.

Business object (*.bo) ● Label of a business object field

● Tooltip of a business object field

The system does not support the extraction of message texts to an XLIFF
file.

Business object extension (*.xbo) ● Label of an extension field

● Tooltip of an extension field

The system does not support the extraction of message texts to an XLIFF
file.

SAP Cloud Applications Studio – Version May 2018 (1805)

584 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Project Item Text Element

Business adaptation catalog (BAC) element ● Description of a business topic

(business option, business topic) ● Description of a business option
● Scoping question/statement of a business option
● Details: Overview and Relevance texts

Business configuration (BC) set (*.bcc) Description of a field value

Code list data type (*.codelist) Description of code list value

Data mashup, HTML mashup, URL mashup On-screen texts

(*.MC.uimashup)

Business and Technical Background

XML Localization Interchange File Format (XLIFF)

XML Localization Interchange File Format (XLIFF) is a standard XML-based file format for localization, specifically
designed for exchanging bilingual content between systems. This format enables translators to concentrate on the
text to be translated by extracting translatable text and separating it from non-translatable text. XLIFF is beneficial
as a single format which can be used for translating different kinds of files. With all the advantages of XML-based
processing, this format aims to standardize localization and is supported by a wide variety of translators.
For more information, see XML Localization Interchange File Format (XLIFF) [page 586].

Managing Translation
When you create a solution in the studio, you can translate business configuration content and other solution content
into another language. To translate business configuration content and on-screen texts, you must export the
translatable content to an XLIFF file on your local computer. Once the XLIFF file is translated, you can import the
translated file into the studio and check the translation status and the result.
For more information, see Managing Translation [page 588].

Tasks

Export Text for Translation

In the studio, you can extract translatable texts from specific project items in a solution. You export this text to a file
in XML Localization Interchange File Format (XLIFF) to your local computer for translation into one of the languages
supported by the SAP cloud solution. You specify the target language when you export the text.
For more information, see here [page 590].

Import Translated Text

After you have exported text of the translatable project items in a solution to a file in XML Localization Interchange
File Format (XLIFF) and it has been translated into the target language, you can import the translated XLIFF file from
your local computer to the solution and test the results of the translation in the target language in the SAP cloud
solution.
For more information, see here [page 591].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 585
Check Translation Status
You can check the translation status of a project, business configuration content and a UI component by viewing the
total number of translatable text strings and translated text strings.
For more information, see here [page 592].

Translate Message Texts

1. Translate message texts that you defined for a business object or a business object extension in the
corresponding .bo or .xbo file by using the following syntax based on a sample message:
message NoValidSite text "Enter a valid site";
message NoValidSite_DE text "Geben Sie einen gültigen Ort ein";
message NoValidSite_ZH text "θθ";
2. In your action or event script file, raise the language-dependent message using the var expression by using
the following syntax:
var userLanguageCode;
...
userLanguage = Context.GetCurrentUserLanguage().ToString();
if ( userLanguage == "DE" ) { raise NoValidSite_DE.Create("E"); }
else if ( userLanguage == "ZH" ) { raise NoValidSite_ZH.Create("E"); }
else { raise NoValidSite.Create("E"); }

8.20.2 Business and Technical Background

8.20.2.1 XML Localization Interchange File Format (XLIFF)

Overview
XML Localization Interchange File Format (XLIFF) is a standard XML-based file format for localization, specifically
designed for exchanging bilingual content between systems. This format enables translators to concentrate on the
text to be translated by extracting translatable text and separating it from non-translatable text. XLIFF is beneficial
as a single format which can be used for translating different kinds of files. With all the advantages of XML-based
processing, this format aims to standardize localization and is supported by a wide variety of translators.

XLIFF File
As XLIFF is an XML-based file format, it begins with an XML declaration. After the XML declaration comes the XLIFF
document itself, enclosed within the <xliff> element. An XLIFF document is composed of one or more sections,
each enclosed within a <file> element. Each <file> element corresponds to a file which has to be translated and
contains information about the source language and the target language. It could be a project, a business
configuration, a project item, such as a floorplan or a business configuration element, such as a BC set or a BAC
element. The file element consists of a <header> element and a <body> element.
The following is an example of the basic structure of an XLIFF file:

SAP Cloud Applications Studio – Version May 2018 (1805)

586 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 <?xml version='1.0' encoding='utf-8'?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" version="1.2">
<file datatype="plaintext" date="2011-12-02T06:22:58Z" original="self"
source-language="en" target-language="de">
<header>
</header>
<body>
<group>
<trans-unit>
</trans-unit>
</group>
</body>
</file>
</xliff>

The <header> element contains metadata about the file which has to be translated. This information depends on
the level at which you want to translate.
The following is an example of a <header> element in an XLIFF file exported at UI component level:

<header>
<phase-group>
<phase company-name="SAP AG" date="2011-12-02T06:22:58Z" phase-
name="file-creation" process-name="file-creation" tool-id="urn:x-
sap:byd:xrep:xliff"/>
</phase-group>
<note from="SAP">In order to provide additional context/meta data for
translators, The strings in this file are grouped according to UI</note>
<tool tool-company="SAP AG" tool-id="urn:x-sap:byd:xrep:xliff" tool-name="ByD
XRep XLIFF Interface" tool-version="1.1.0"/>
<sxmd:metadata xmlns="urn:x-sap:mlt:tsmetadata:1.0" xmlns:sxmd="urn:x-
sap:mlt:xliff12:metadata:1.0">
<object-name>BY003505</object-name>
<collection>/BY003505/BC</collection>
<domain>BAC</domain>
<developer>TESTUSER</developer>
<description>BY003505 Translation XLIFF File</description>
<origin>/BC_BY003505/SRC/BusinessConfiguration.xml</origin>
</sxmd:metadata>
</header>

The <body> element contains the extracted translatable data from the file in the form of translation units represented
by <trans-unit> elements. The translatable data within <trans-unit> elements is organized into source and
target paired elements. A <source> element stores the source text, and a <target> element stores the translated
text. The <target> elements are not mandatory. These <trans-unit> elements can be grouped recursively in
<group> elements. For example, If you translate at the project level, the <header> element contains information
about the project and each <group> element contains information about an individual UI component.
The following is an example of a <trans-unit> element translated from English to German:

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 587
 <trans-unit xmlns:sap=”urn:x-sap:sls-mlt” datatype=”plaintext” id=”UICT-/
BY003505/USINESSOBJECT1_QA.QA-637f86765fbf498ba2cc6017dd6696f0”
maxwidth=”255” resname=”637f86765fbf498ba2cc6017dd6696f0” restype=”x-Text”
sap:sc=”XTXT ”>
<source>Save</source>
<target >Speichern</target>
</trans-unit>

XLIFF is bilingual as each translation unit offers one <source> element and one <target> element. This
makes the overall model simple and easy to handle.

Extraction and Merge Principle

Translation in XLIFF is based on the concept of extracting the translatable text from the original file, and merging it
back in place after translation has been done.
The extraction and merge principle is illustrated in the following diagram:

XLIFF Extraction and Merge Principle

All translatable texts and non-translatable texts are extracted from the original file. The parts that are non-
translatable are preserved in a temporary file. The translatable parts are stored separately and translated. After
translating the translatable texts, both the parts are merged, resulting in the translated file.

See Also
Translation Quick Guide [page 584]

8.20.2.2 Managing Translation

Overview
When you create a solution in the studio, you can translate business configuration content and other solution content
into another language. To translate business configuration content and on-screen texts, you must export the
translatable content to an XLIFF file on your local computer. Once the XLIFF file is translated, you can import the
translated file into the studio and check the translation status and the result.

SAP Cloud Applications Studio – Version May 2018 (1805)

588 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
Prerequisites
● You have opened a solution in the studio that contains content that needs to be translated.
● To test translated solution content, you must be assigned the Business User role and have access rights for
the work center views where the content is displayed. For more information, see User Setup Quick Guide
[page 31].

Process Flow
1. You extract the translatable text strings of all translatable project items in a solution or a specific project item
and export the text to an XLIFF file that you save on your local computer.
For more information, see Export Text for Translation [page 590].
2. The XLIFF file is translated into the target language using a translation tool that supports XLIFF or an XML
editor.
For more information about XLIFF, see XML Localization Interchange File Format (XLIFF) [page 586].
3. You import the translated XLIFF file into the studio.
For more information, see Import Translated Text [page 591].
4. You activate the translated project items.
If you have translated .uicomponent files, you need to update the metadata in the UI designer. To do this,
proceed as follows:
a. Right-click the translated .uicomponent file and select Open in UI Designer.
b. Select Tools Update Metadata .
c. Click the Save and Activate button ( ).
5. Optional: You check the translation status of the solution content.
For more information, see Check Translation Status [page 592].
6. Optional: To test translated business configuration content, you deploy the business configuration to ensure
that you can view the most recently translated business configuration set values in the SAP cloud solution.
For information about business configuration content, see Business Configuration Quick Guide [page 314].
7. You log on to the SAP cloud solution as a business user and make sure that you select the target language
into which the solution content was translated. You test the translated text by viewing the relevant screens
and making sure that all texts appear and are displayed correctly.
8. You request a test deployment. For more information, see Administration Quick Guide [page 151].

See Also
Translation Quick Guide [page 584]

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 589
8.20.3 Tasks

8.20.3.1 Export Text for Translation

Overview
In the studio, you can extract translatable texts from specific project items in a solution. You export this text to a file
in XML Localization Interchange File Format (XLIFF) to your local computer for translation into one of the languages
supported by the SAP cloud solution. You specify the target language when you export the text.

Prerequisites
You have opened a solution in the studio that contains content that needs to be translated.

Procedure
1. Extract the translatable text strings of all translatable project items in a solution or a specific project item by
doing the following:
a. In the Solution Explorer, right-click one of the following items:
● Project node (to extract the translatable text strings of all project items that support translation)
● Business object (*.bo)
● Floorplan (*.uicomponent)
● Business adaptation catalog element (*.bac)
● Business configuration set (*.bcc)
● Business object extension (*.xbo)
b. Select Translation Export Text .
The Export Text for Translation dialog box opens.
2. In the Export Text for Translation dialog box, select the target language to which you want to translate the
text.
3. The Add Standard Translation option is preselected. If you do not deselect it, the system inserts standard
translations of common UI texts into the XLIFF file when you export your texts for translation.
4. Enter a name for the XLIFF file.
You can use the default file name or provide a new name. The default file name is in the format Technical
Name_Target Language Code.xlf where TechnicalName is the name of the project or project item that
you selected. Target Language Code is an abbreviation of the target language you selected. This code will
be added to the generated XLIFF file.

Examples of Default File Names for Exported XLIFF Files

Target
Item Technical Name Language XLIFF File Name

Project Y3S15QDEY_ German Y3S15QDEY_DE.xlf

SAP Cloud Applications Studio – Version May 2018 (1805)

590 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 Target
Item Technical Name Language XLIFF File Name

Object Instance Floorplan BusinessObject1_OIF.OIF.uic Italian BusinessObject1_OIF

omponent _IT.xlf

Object Work List BusinessObject1_OWL.OWL.uic Portuguese BusinessObject1_OWL

omponent _PT.xlf

Work Center View BusinessObject1_WCView.WCVi Spanish BusinessObject1_WCV

ew.uicomponent iew_ES.xlf

Business Adaptation BACElements1.bac Chinese BACElements1_ZH.xlf

Catalog Element

Business Configuration Set CODE.bcc French CODE.bcc_FR.xlf

5. Select the location on your computer where you want to save the exported XLIFF file.
You can save the file in the default location or specify a new location.
6. Click OK.
The file is saved in the specified folder on your local computer.

Result
You have exported the solution content to an XLIFF file on your local computer. You can now translate the XLIFF file
into the target language using a translation tool that supports XLIFF or an XML editor. For more information about
XLIFF, see XML Localization Interchange File Format (XLIFF) [page 586]. You can also open the XLIFF file in the
studio: from the File menu, select Open File and navigate to the location of the XLIFF file you exported. The
file opens in a document window in the code editor.

See Also
Translation Quick Guide [page 584]

8.20.3.2 Import Translated Text

Overview
After you have exported text of the translatable project items in a solution to a file in XML Localization Interchange
File Format (XLIFF) and it has been translated into the target language, you can import the translated XLIFF file from
your local computer to the solution and test the results of the translation in the target language in the SAP cloud
solution.

Prerequisites
● You have exported an XLIFF file and saved it on your local computer.
For more information, see Export Text for Translation [page 590].
● You have translated the XLIFF file into the target language.
For more information about XLIFF, see XML Localization Interchange File Format [page 586].

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 591
Procedure
1. In the Solution Explorer, right-click the project, floorplan, business adaptation catalog element, or business
configuration set for which you want to import translated text and select Translation Import Text .
The Import Translation dialog box opens.
2. Select the location on your computer where you have saved the translated XLIFF file.
3. Click OK.
4. In the Solution Explorer, activate the translated project items by right-clicking the project or the project items
and selecting Activate.
5. Optional: If you have imported translated business configuration content, deploy the business configuration
by right-clicking the project node and selecting Deploy Business Configuration.
You must deploy business configuration content to ensure that you can view the most recently translated
business configuration set values.
6. Log on to the SAP cloud solution as a business user and make sure that you select the target language into
which the solution content was translated.
7. Test the translated text in the SAP cloud solution by viewing the relevant screens and checking that all texts
appear and are displayed correctly.

See Also
Translation Quick Guide [page 584]

8.20.3.3 Check Translation Status

Overview
You can check the translation status of a project, business configuration content and a UI component by viewing the
total number of translatable text strings and translated text strings.

Prerequisites
You have opened the solution in the studio for which you want to check the translation status.

Procedure
1. In the Solution Explorer, right-click the project, floorplan, business configuration set, or other project item for
which you want to check the translation status and select Translation Check Status .
The Check Translation Status dialog box opens.
2. Review the total number of translatable text strings and translated text strings, as well as the language to
which the text strings have been translated.
If you check the translation status at project level, the Check Translation Status dialog box displays the
translation status of all project items in the solution for which translation is supported.
3. Do one of the following:

SAP Cloud Applications Studio – Version May 2018 (1805)

592 © 2018 SAP SE. All rights reserved. • P U B L I C Developer Desktop
 ● To export any texts that still need to be translated into one or more languages, select a language and
click Export to XLIFF.
The Export Text for Translation dialog box opens. For more information, see Export Text for Translation
[page 590].
● If all texts have been translated, click OK.
The Check Translation Status dialog box closes.

If you check the translation status at project level, you can only export text at the project level and not
for individual project items.

See Also
Translation Quick Guide [page 584]

SAP Cloud Applications Studio – Version May 2018 (1805)

Developer Desktop P U B L I C • © 2018 SAP SE. All rights reserved. 593
9 User Interface Designer

9.1 User Interface Designer Overview

The user interface designer (UI designer) is integrated into the studio. You use it to design the user interface of your
solution by modifying the screens that you have created in the studio, for example, quick activity floorplan, object
work list, or work center view. You can also change or enhance SAP floorplans. Further, you can also use the UI
designer to design screens for mobile devices.
The UI designer contains a number of different tools and functions that you can access from the menu or on tabs at
the bottom of the UI designer screen. For more information, see Features of the User Interface Designer
[page 595].

Availability

This documentation covers the SAP Cloud Applications Studio (“studio”) as a whole; therefore it describes
all features that are available within the studio. Not all of these features are available for every cloud
solution from SAP. Before using a particular feature, please consult the Feature Matrix to determine
whether the feature is available for the cloud solution from SAP for which you are creating your solution.
For details, see Feature Matrix [page 25].

Prerequisite
You have created a solution and created one or more screens in the studio. For more information, see Generate
Screens for a Business Object [page 370].

What you can do in the UI designer

1. Model custom floorplans in the UI designer
You can modify the screens that you have created in the studio by adding panes and controls as well as creating
event handlers, queries, interfaces, and navigation. You can bind the controls you have added to business
object elements so that when a particular control is used, data is retrieved from the business object.
For more information, see Floorplan Modification Quick Guide [page 621].
2. Modify SAP floorplans
You can modify SAP floorplans, for example, add a view to a work center or an embedded component to a
floorplan. For information on which changes you are allowed to make, see Change Transactions Quick Guide
[page 651].
You need to use anchors to make sure that the changes are included in every upgrade of the SAP cloud
solution. You can use existing anchors or create a new anchor. For more information, see Anchors
[page 654].
3. Adapt floorplans for mobile devices
You can also modify floorplans for use on a mobile device. For more information, see Mobile Floorplans Quick
Guide [page 668].

SAP Cloud Applications Studio – Version May 2018 (1805)

594 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
Process Flow
The following graphic shows how and where you create and design the screens of your solution:

How you design screens for a solution

To create a screen, do the following:

1. Create screens such as an object work list, a fact sheet, or quick activity floorplan in the studio.
For more information, see Generate Screens for a Business Object [page 370]
2. In the UI designer, drag the required panes and controls to design the layout of the screen.
For more information, see Toolbox.
3. Define the properties of each user interface control.
For more information, see "Property Explorer" in Features of the User Interface Designer [page 595].
4. Bind the business object elements with the user interface elements.
For more information, see Bind Data Elements to Business Object Elements [page 630].
5. Define the behavior of your solution by creating the following:
● Event handlers. For more information, see Create an Event Handler [page 644].
● Navigation. For more information, see Configure an Object-Based Navigation in a Source Floorplan
[page 641] and Configure an Object-Based Navigation in a Target Floorplan [page 640].
● Queries. For more information, see Configure a Query [page 639].
● Scripts. For more information, see Write a Script [page 643].
6. Preview your screens to check your changes. For more information, see Preview a Screen.

Before activating your screens, we recommended that you run the checkmate tool using the Run
Checks button on the top tool panel on your screen.

7. Save and activate your screens.

9.2 Getting Started with the User Interface Designer

9.2.1 Features of the User Interface Designer

Overview
This document provides a brief overview of the common features available in the user interface designer (UI designer)
to design the user interface.
This is what the UI designer looks like:

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 595
User Interface Designer

File Menu

Menu Entry Description

Close Closes a user interface component.

Import Allows you to import user interface component from a file in the local disk. File can be of type .User
Interfacecomponent file or a .xml file.

Save Saves a user interface component in the repository.

Save All Saves all the user interface components that are being edited.

Activate Activates a user interface component, so that the model is available to all users who are accessing the repository.

Exit Exits the UI designer.

View Menu
The View menu allows you to display or close the following tool windows:
● Configuration Explorer
The Configuration Explorer displays the repository content in the UI designer. You can filter the content by a
selected component type.
The last level in the hierarchy is the user interface component. You can double-click to open the component.
The tool tip for the component shows the component type and the complete path which acts as a unique
identifier.
● BO Browser/Data Model
The BO Browser appears in different places in the UI designer:
○ As part of the BOBrowser / DataModel tool

SAP Cloud Applications Studio – Version May 2018 (1805)

596 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 ○ In the Data Model tab of a component
○ In the Controller tab of a component

In the BO Browser tab, the assigned business object (BO) or enhanced controller object (ECO) is displayed
as a tree structure with all available nodes and fields. You can:
○ Choose to display only the elements, queries, actions or everything
○ Add elements and attributes, create associations, queries, actions and their parameters
○ Reset the client side cached metadata from the backend (in case the ECO/BO has been updated)
○ Filter for specific categories (if allowed)
○ Search for opened nodes in the hierarchy

In the Data Model tab you can:

○ Create the structure of the data model
○ Create, delete and rename nodes in the data model structure
○ Bind the data model element to the business object element
○ Display the corresponding properties of the nodes in the Properties Explorer

In the DataModel tab the data structure is displayed together with various data model elements. The binding
status of each of these elements is represented using specific colors. You can also determine the binding
status for each element in the Properties Explorer.

Color Binding Status

Blue Indicates an internal data model element. These are used internally for different purposes. Binding Status in
the Properties Explorer has been set to Internal.

Yellow Indicates an unbound data model element. Data binding has not yet been specified for this element. Binding
Status in the Properties Explorer has been set to ToBind.

Green Indicates a bound data model element. Valid data binding has been specified for this element, or Binding
Status in the Properties Explorer has been set to OK.

Red Indicates a data model element for which the data binding has to be corrected. Binding Status in the Properties
Explorer has been set to ToCorrect.

● Property Explorer
It allows you to view and change properties for each element in the user interface model.
As soon as you select an element in the Designer tab, the DataModel tab or the Controller tab, the
corresponding properties of the selected element are displayed in the Property Explorer.
You can edit a few properties, and some are read-only.
Note the function of the dropdown list above the Properties window. You use this list to switch between
different components of the floorplan, depending on the item currently selected on the Designer tab.
● Toolbox
The Toolbox provides the panes and controls that can be used to design the layout of a user interface
component in the Designer tab.
The controls and panes available depend on the floorplan. You can drag the panes and controls from the
toolbox to the Designer tab.
For more information, see Toolbox.
● Document Outline
The Document Outline provides an overview of all the controls used in the user interface of the selected
component.
● Project Context
The Project Context provides an overview of the users involved in the creation and use of a particular floorplan.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 597
 ● Run Checks
Run Checks provides the list of errors in the floorplan. For more information, see Working with the Checkmate
Tool .
● Where Used List
The Where Used List gives an idea about where exactly a particular user interface component is being used.
● Output Window
The Output Window gives an overview of all the changes made to the floorplan that is currently open.
● Version History
The Version History gives an idea about the name and type of solution the user is working in, the date and
time when the solution was last modified and the user who is responsible for the modifications.
● OBN Explorer
The OBN Explorer will provide information about the operations, target floorplans and the inports configured
in a particular BO.
You can drag and drop the required OBN onto a user interface control in a source floorplan. The event handler
and outport are automatically created; the outport will however need to be configured.
● Extensibility Explorer
The Extensibility Explorer is used to modify floorplans that come from layer lower than the layer the user is
working on. It displays the anchors assigned for a particular area, such as the toolbar, section group or pane
container and the change transactions associated with these anchors.
All the change transactions that have been made can be viewed in the Extensibility Explorer. Change
transactions once created, are displayed in the Unsaved Change Transaction section, once they are saved
they are displayed in the Saved Change Transaction section.
After activation, the change transaction are displayed in the Published Change Transaction section.

These tool windows can be moved around, docked, or hidden.

Tools Menu

Menu Entry Description

Update Metadata Updates the backend meta data information in the active component.

Options… Allows the user to personalize the debug and warning message settings.

Cleanup UI Component Allows the user to delete any unused data structures created by default along with Action
Parameters.

Add to Favorites Adds the floorplan to a favorite list.

Content Area
The content area has the following tabs:
● Designer: To design the user interface of an application with the available panes and controls from the
Toolbox.
● Data Model: To bind the user interface elements to a business object element.
● Controller: To define the interaction between user interface components by creating event handlers,
interfaces, navigation, and queries.
● Preview: To preview the changes made to an user interface component, for example, a floorplan.

SAP Cloud Applications Studio – Version May 2018 (1805)

598 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
9.3 Modeling Floorplans

9.3.1 Floorplan Modeling Quick Guide

This document gives you an overview of the steps involved in modeling different types of floorplans in the studio
using the user interface designer.
In the studio, you can generate screens for the business objects in your solution.
For more information, see Generate Screens for a Business Object [page 370].

Business and technical background

SAP’s User Interface Style Guide

You can learn how to build user interfaces according to this style guide.

Tasks

Model a Fact Sheet

You can create a fact sheet to display a read only overview of an object.
For more information, see here [page 601].

Model a Quick Activity Floorplan

You can create a quick activity to display an overview of a business object.
For more information, see here [page 603].

Model an Object Instance Floorplan

An object instance floorplan (OIF) is used to create and edit business object data or trigger actions on a business
object. It is opened using object-based navigation. It can be used to create new business object data. OIFs are similar
to quick activities except that an OIF has a set of tabs such as General and Line Items.
For more information, see here [page 605].

Model an Object Work List

You can create a list pane that is always embedded in a work center view. The OWL contains business objects such
as purchase orders or opportunities. You can, for example, search for, display, and edit business objects as well as
trigger follow-on processes.
For more information, see here [page 607].

Create an Object Value Selector Dialog Box

You can create an object value selector (OVS) dialog box as a reusable component. It can be called from any OVS
control.
An OVS helps you select one item from a table of business object instances.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 599
For more information, see here [page 608].

Model a Guided Activity Floorplan

You can create a guided activity floorplan to simplify complex tasks. This floorplan helps you navigate step by step
through a given process.
For more information, see here [page 610].

Model a Work Center View

You can model a work center view to hold a list of related floorplans. The work center view is a component that can
be used across different work center floorplans that allow easy navigation to different sections from within the
specified floorplan.
For more information, see here [page 612].

Model a Work Center

You can model a work center floorplan to display the various work center views.
For more information, see here [page 614].

Create a Port Type Package

You can create a port type package in the studio and modify its attributes in the user interface designer. A port type
package is a component that hosts one or more port types. A port type is a blueprint for an inport or an outport.
Navigation between components that have inports and outports within the same port type package can be facilitated
without any mapping effort.
For more information, see here [page 615].

Model a Modal Dialog

You can model a modal dialog to create a dialog box that is triggered by an event action. You can model a reusable
modal dialog and then bind it to a floorplan, or you can model a modal dialog that is specific to a floorplan and that
can be called by an event handler.
For more information, see here [page 616].

Model an Embedded Component

Embedded components are reusable subscreens that facilitate:
● Inport and outport navigation between the parent component and the embedded component.
● Bindings to reference data from the parent component.
● Configuration to let the parent component influence the behavior of an embedded component.

For more information, see here [page 618].

Create a Business Configuration View

You can create a business configuration view (BC view) for a business configuration set (BC set) to allow
administrators to add new values during fine-tuning or to delete the values of a BC set. You create the view in the
studio and you model the view in the UI designer.

You can only create a BC view for a business configuration set (BC set) that was created using a custom
business configuration object (BCO). You cannot create a BC view for an SAP BCO.

For more information, see here [page 337].

SAP Cloud Applications Studio – Version May 2018 (1805)

600 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
Save and Activate Your Changes
After you have created any of the floorplans listed above, you have to save and activate the floorplans.
1. From the File menu, choose Save.
2. From the File menu, choose Activate.
3. In the Activate Worklist dialog box, select the check boxes beside the relevant components and click OK.

9.3.2 Tasks

9.3.2.1 Model a Fact Sheet

Overview
You can create a fact sheet to display a read only overview of an object. It displays the object properties, can have
different views, and can contain links for navigating to related objects.
For example, an Account Overview fact sheet can have the sections Accounts, Sales Data and Relationships
If you create an Employee fact sheet, employees can view their data but cannot change any information.
If you want to allow users to edit the screen, you must create a quick activity floorplan or an object instance floorplan.
Here is a sample fact sheet

Fact Sheet

Prerequisites
● You have created a solution in the studio.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 601
 For more information, see , create a Solution [page 165]
● All the required application entities such as the business object and the embedded component have been
modeled in the solution.
For more information, see Business Object Modeling [page 78].
● You have the detailed information needed for the fact sheet that you are creating.

Procedure
1. Create a Fact Sheet
1. In the Solution Explorer, expand the solution to display the business object.
2. Right-click on the business object and select Create Screens.
3. In the Create New Screen dialog box, do the following:
a. In the Screen Name field, enter a name for the fact sheet. For example, Account Overview
b. Under FloorplanType, select Fact Sheet (FS).
c. Click OK.
The Account Overview fact sheet is created and displayed in the Solution Explorer under the
business object.
2. Add the required UI elements and change field names
1. Double-click the fact sheet that you just created.
The fact sheet opens in the user interface designer with the default UI elements.

If required, you can change the component type from Fact Sheet (FS) to Quick Activity
(QA) in the Properties Explorer, under Component Info-Component Type.

2. Select the identification region

3. Enter a title for the fact sheet in the Properties, under Misc – FloorplanTitle
4. Drag the required controls from the Toolbox to the fact sheet.
For example, you can add the fields required for general information, contacts, relationships and so
on.

Drag and drop the required controls

SAP Cloud Applications Studio – Version May 2018 (1805)

602 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 5. Do the following for each of the required static text fields that are available in the Account Overview
fact sheet.
a. Select the static text field.
b. In the Properties Explorer, under Data Information – Text, click the arrow button.
c. In the Dependent Property Editor, select the required element and click OK.
d. If you do not want to use the associated back end text for a static text field, enter a name for the
field in the Properties Explorer, under Text Information – Field Group Header.

3. Model Elements
1. In the Data Model tab, all the elements of the selected business object are displayed. Bind each of the
data model elements to a business object element.
For more information, see Bind Data Elements to Business Object Elements [page 630].
2. Create and configure the required event handlers in the Controller tab. For example, create and
configure event handlers for each of the buttons available on the fact sheet.
For more information, see Create an Event Handler [page 644].
3. If you want to provide value help for any of the fields, see Configure an Object Value Selector
[page 646].
4. To enable the fact sheet to be opened using object-based navigation, configure the fact sheet so that
it can receive parameters from any floorplan.
For more information, see Configure an Object-Based Navigation in a Target Floorplan [page 640].
5. Save and activate your changes.

9.3.2.2 Model a Quick Activity Floorplan

Overview
You can create a Quick Activity Floorplan (QAF) to display an overview of a business object. You can further view all
the details of the business object in the associated object instance floorplan.
Here is an example of a sample QAF

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 603
Quick Activity Floorplan

Prerequisites
● You have created the required business object.

Procedure
1. Create a quick activity
Let's create a QAF called New Corporate Account:
1. In the Solution Explorer, expand the solution to display the business object.
2. Right-click on the business object and select Create Screens.
3. In the Create New Screen dialog box, do the following:
a. In the Screen Name field, enter New Corporate Account as the name for the quick activity.
b. Under FloorplanType select Quick Activity floorplan (QAF).
c. Click OK.
The quick activity is created and displayed in the Solution Explorer under the business object.
4. Double-click the new QAF.
5. The QAF opens in the user interface designer. It has the following attributes:
● An identification region with the title of the quick activity
● A contextual navigation region with default buttons such as Close, Save and Close, and View All
● An event handler with the operation type WindowAction named Close associated with the
Close button
2. Edit the quick activity
1. Enter a title for the quick activity in the Properties Explorer, under Misc – FloorplanTitle.

If this floorplan allows you to either create or edit details, use a calculation script to dynamically
render the title.
For more information, see Define Dynamic Behavior of a Field [page 630] and Write a Script
[page 643].

2. Model the quick activity

SAP Cloud Applications Studio – Version May 2018 (1805)

604 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 1. Configure the View All button to navigate to the corresponding object instance floorplan to view
the details of the object.
For more information, see, Configure an Object-Based Navigation in a Source Floorplan
[page 641].
2. If required, add additional buttons and assign an event handler to the OnClick event.
For more information, see Configure a Button [page 631] and Create an Event Handler
[page 644].

For BO actions, use the operation type BOAction and bind the action to the BO action. The
fields Action Type and Instance Binding will be automatically updated as per the BO action
property.

3. Drag the required controls from the Toolbox to the quick activity.
4. In the Data Model tab, bind each of the data model elements to a business object element.
For more information, see Bind Data Elements to Business Object Elements [page 630].
5. Create an OBN inport to receive the navigation key from the source floorplan, in order to retrieve
data from the target floorplan:
a. In the Controller tab, right-click on Inports and choose Add Inport.
b. Check OBN Inport.
c. Select an operation, PortType Package and a PortType Reference as OpenByKey.
d. Add the parameter Key List and Key and bind the parameter to an unbound data list and data
field that acts as a placeholder for the key.
e. Create an event handler as follows:
a. In the Operation Type field, select BOOperation.
b. In the BO Operation Type select Read.
c. In the Navigation Type select Key Navigation.
d. Bind the previously used, unbound data field in the ... column.
f. In the Properties Explorer for the newly created inport, under Events — OnFire, select the
even handler you have created.
6. Save and activate your changes.

9.3.2.3 Model an Object Instance Floorplan

Overview
An object instance floorplan (OIF) is used to create and edit business object data or trigger actions on a business
object. It is opened using object-based navigation. It can be used to create new business object data. OIFs are similar
to quick activities except that an OIF has a set of tabs such as General and Line Items.
Here's a sample OIF:

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 605
Object Instance Floorplan

Procedure
1. Create an OIF
1. In the Solution Explorer, expand the solution to display the business object.
2. Right-click on the business object and select Create Screens.
3. In the Create New Screen dialog box, do the following:
a. In the Screen Name field, enter a name for the object instance floorplan.
b. Under FloorplanType select Object Instance Floorplan (OIF).
c. Click OK
A new object instance floorplan is created and displayed in the Solution Explorer under the
business object.
2. Model the OIF
1. Double-click the new OIF.
The OIF opens in the user interface designer.
2. In the Designer tab, select an OIF tab, for example, General Data tab.
3. In the Properties Explorer, select ViewSwitchNavigation from the drop-down list and under Misc-
NavigationItems, click ....
In the OIF View Collection Editor, remove any unwanted tabs.
Edit the properties of each of the tabs. For example, the title of the tab, its behavior, and visibility.

The name of the tab is stored in run time in the data model field /Root/UIState/
ViewSwitchSelectedItem. You can use it in dynamic data or property handling for a calculation
rule.

4. If you want to add sub tabs to a tab, do the following:

a. In the Properties Explorer, select ViewSwitchNavigationItem:NavigationItem and under Misc-
ChildNavigationItems click ... .
b. In the OIF SubView Collection Editor, click Add.
c. Edit the properties of the sub tab, such as the title.
5. Design each of the tabs and sub tabs, and configure the OIF similar to a quick activity.
For more information, see steps 7 to 11 of Model a Quick Activity Floorplan [page 603].
6. Save and activate your changes.

SAP Cloud Applications Studio – Version May 2018 (1805)

606 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
9.3.2.4 Model an Object Work List

Overview
You can create a list pane that is always embedded in a work center view. The OWL contains business objects such
as purchase orders or opportunities. You can, for example, search for, display, and edit business objects as well as
trigger follow-on processes.

Prerequisites
You have created an object instance floorplan (OIF), or a fact sheet.
For more information, see Model an Object Instance Floorplan [page 605] or Model a Fact Sheet [page 601].

Steps

1. Create an object work list (OWL)

a. In the Solution Explorer, expand the solution to display the business object.
b. Right-click on the business object and select Create Screens.
c. In the Create New Screen dialog box, do the following:
● In the Screen Name field, enter a name for the object work list.
● Under FloorplanType select Object Work List (OWL).
● Click OK.
A new object work list is created and displayed in the Solution Explorer under the business object.
d. Double-click the new OWL.
The OWL opens in the user interface designer.

2. Configure the data model view of the OWL

a. Add columns in the OWL by dragging and dropping Controls from the Toolbox.
b. Bind each of the fields to the required business object element.
For more information, see Bind Data Elements to Business Object Elements [page 630].

3. Configure the design view of the OWL

On the Designer tab, you can see that the following fields are available by default:
● List or advanced list pane with columns
● Show drop-down list, basic Find field, Go button in the Search area

a. In the Properties Explorer, change the properties of the required controls.

b. In the Properties Explorer, enable the preview area by selecting AdvancedListPaneVariant.
Under Appearance-UsePreviewPane, select True.
c. In the BO Browser/Data Model, add the necessary fields from the DataList.
d. To add the search parameter fields in the find form area, do the following:
1. Click Advanced.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 607
 2. In the BO Browser tool window set a filter to show queries.
3. Drag query parameters to the find form.

If you add the query parameters like this, then you do not need to add the query parameters and do the binding
in the Controller tab.
e. To configure a button to open target floor plan from the OWL, for example, an OIF or a GAF do the following:
1. Add an Edit button to the tool bar
For more information, see Configure a Button [page 631].
2. Select the Navigation property and open the editor.
3. Select the namespace, OIF/FS controller, and its inport operation Open and click OK.
4. An OBN, an outport, and an event handler are created automatically in the Controller tab.

4. Configure the controller tab of the OWL

a. In the Controller tab there is a default query. You can add more queries and default sets using the context
menu.
b. In the Designer tab, assign a title to the default set that is displayed in the Show drop down list .
c. In the Controller tab, bind the query to the controller’s query using the elements structure.
d. Add and bind the query parameters from the controller to Search Parameter Structure fields.
e. Find the eventhandler, outport, and OBN that were created while configuring the Edit button.
f. To configure the outport, add the parameters Key List and Key and bind the parameter to an unbound data
list and data field that acts as a placeholder for the key.
g. Save and activate your changes.

See Also
Create an OWL Excel Export [page 372]

9.3.2.5 Create an Object Value Selector Dialog Box

Overview
You can create an object value selector (OVS) dialog box as a reusable component for a custom business object and
for an SAP business object. It can be called from any OVS control.
An OVS helps you select one item from a table of business object instances. This is an example of an object value
selector dialog box in SAP Business ByDesign:

SAP Cloud Applications Studio – Version May 2018 (1805)

608 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
Object Value Selector Dialog Box

Prerequisite
You have opened a solution. If you want to add the object value selector dialog box to a custom floorplan, you need
to have created a business object.

Procedure
1. In the Solution Explorer, do the following:

Custom Business Object SAP Business Object

a. Right-click the business object and select Create a. Right-click the solution and select Add New
Screens. Item.
b. In the Create Screens dialog box, do the following: The Add New Item dialog opens.

1. In the Screen Name field, enter a name for the OVS b. Select SAP Screens Object Value
dialog box. Selector (OVS) and click Add.
2. Select the required option from the Supported The Select Business Object dialog opens.
Devices value help. c. Select an SAP business object or a custom
3. Under Screen Type, select Object Value Selector business object or search for a business
(OVS). object.
c. In the Select Business Object Elements for OVS dialog d. Optional: Change the default name.
box, select the business object element(s) and click OK. e. Click OK.
A new OVS dialog box is created and displayed in the A new OVS dialog box is created and
Solution Explorer under the business object ([Name of displayed in the Solution Explorer under the
the business business object ([Name of the
object]_OVS.OVS.uicomponent, ). OVS].OVS.uicomponent, ).

2. Double-click the new OVS.

The OVS opens in the user interface designer. A basic object value selector dialog box for an SAP business
object looks as follows:

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 609
 Object Value Selector for an SAP Business Object

You now need to define the following attributes:

● Event handlers: Used to close the window, to retrieve the value set, to handle the selection change and
to return the selected value
● Query to display the queried business data
● Inport: Used to access the OVS
● Outport: Used to transfer the required data from the OVS to the floorplan where it is being used.
3. In the Property Explorer, select identification region in the OVS dialog.
4. In the Properties Explorer, under Misc-Window Title, click the arrow button.
5. In the Dependent Property Editor, enter the title and click OK.
6. In the Data Model tab, bind the following:
● Root to the corresponding OVS (enhanced) controller object
● List to the ECO node
● List attributes to the ECO node attributes

For more information, see Bind Data Elements to Business Object Elements [page 630].
7. In the Controller tab do the following:
● Select the event handlers GetValueHelpHandler and SetValueHelpHandler and define the appropriate
business object model.
● Select the query of the data model and bind it to the business object.
● Select the outport OVSValueSelectorOutPort to define the correct parameter binding from the
parameter Object ID and Object Name to the attributes of the data model.
8. Save and activate your changes.

Follow-On Processes or Tasks

After you have created an OVS dialog box, you can create an OVS control. For more information, see Configure an
Object Value Selector [page 646].

9.3.2.6 Model a Guided Activity Floorplan

Overview
You can create a guided activity floorplan to simplify complex tasks. This floorplan helps you navigate step by step
through a given process.

SAP Cloud Applications Studio – Version May 2018 (1805)

610 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
Procedure
1. Create a guided activity.
a. In the Solution Explorer, right-click your project and select Add New Item .
The Add New Item dialog box opens.
b. Select Guided Activity Floorplan (GAF).
c. In the Name field, enter a name for the guided activity floorplan and click Add.
The guided activity floorplan is added to your project.
d. Double-click the guided activity floorplan.
The guided activity floorplan opens in the user interface designer.
e. A new guided activity shows the following:
● An IdentificationRegion with the title of the floorplan
● A RoadmapNavigation region with standard steps such as Step, Review and Confirmation
● A ComponentToolbar with default buttons such as Previous, Next, Finish, and Cancel.
2. Design the layout and bind the data elements.
a. Rename each of the steps:
1. On the Designer tab, select a step in the road map navigation region.
2. In the Properties Explorer, under Design — Title, click the arrow button.
The Dependent Property Editor opens.
3. In the Overridden Text field, enter the name for the step.
4. Click OK.
5. Under Misc — Name, enter the name of the step.
The name of the current active tab is stored in the data model field /Root/UIState/
ViewSwitchSelectedItem. You can use it in dynamic data or property handling for calculation
rules.
b. If required add additional steps by right-clicking on the RoadmapNavigation region.
c. Drag the required controls from the Toolbox to each step in the guided activity.
d. In the Data Model tab, bind each of the data model elements to a business object element.
For more information, see Bind Data Elements to Business Object Elements [page 630].
3. Configure the navigation buttons.
a. In the Controller tab, create two event handlers with operation type Script, say HandlePrev and
HandleNext.
b. Write a ruby script such that when the event handlers are called, they allow navigation to the next step.
c. Under Scope Fields select a data field as an invalidation trigger, such that whenever the value of the
field changes the script is executed.
d. Assign the event handlers to the OnClick event of the Previous and Next buttons respectively
e. To dynamically enable and display the Previous, Next, Finish and other available buttons, do the
following for each button:
1. Select the button.
2. In the Properties Explorer, under Behavior — Enabled, select Advanced.
3. In the Dependent Property Editor, select Calculation Rule.
4. Write a calculation rule to control the Enabled and Visible properties of the button.
4. Configure the steps.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 611
 a. Configure the Review step:
● Display an overview of the steps performed, with read only controls and transparent tables.
● Disable the Next button.
● Enable the Finish button and configure it such that on click it shows the Confirmation step.
b. Configure the Confirmation step:
● Hide the Cancel and Finish buttons.
● Show the Close button.
● Add a section group to the form region; with the header, What do you want to do next?
● Add Links to the section group and configure the navigation.
For example, the links could be to Create another business object instance or Edit
business object instance.
c. Configure the floorplan title, action buttons and create an OBN Inport similar to a quick activity
configuration.
For more information, see Model a Quick Activity Floorplan [page 603].
5. Save and activate your changes.

9.3.2.7 Model a Work Center View

Prerequisites
● The required OWL has been created.
● If you want to create a list of common tasks, then the corresponding target floor plans, which implement the
OBN operations used in this view, have to be declared as assigned objects.
● If there are common tasks and related links that cannot be specifically assigned to one view and belong to
every view of a work center, an Include View with these links is created.

Procedure
1. Create a work center view.
a. In the Solution Explorer, right-click your project and select Add New Item .
The Add New Item dialog box opens.
b. Select Work Center View.
c. In the Name field, enter a name for the work center view and click Add.
The work center view is added to your project.
d. Double-click the work center view.
The work center view opens in the user interface designer.
e. Check the following properties of the work center view in the Properties Explorer:

Property Description

Configuration — Help ID ID of the related help resource

Configuration — Support Used in ITSAM, for example to propose a CSN component for an incident
Area Code

SAP Cloud Applications Studio – Version May 2018 (1805)

612 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 Configuration — View Type of the view, for example, Overview, Application, IncludeView
SubType

Extensibility — Anchor Associated flexibility anchors

Misc — Name Name of the User Interface Component

RBAM Data — Classifies the RBAM start authorization behavior. For normal views, the entry
Authorization should always be ApplicationContainer.
Classification Code

2. Embed an OWL.
a. Drag and drop the OWL from the Configuration Explorer to the Designer tab.
b. Click Bind.
c. In the Embedded component binding dialog box, bind the OWL to the work center view.
For more information, see Model an Embedded Component [page 618].
3. Define the assigned objects.
All the assigned objects together define the complete authorization granted to a user assigned to the view.
Assigned object also specify the collection of valid navigation targets for a view and the elements that should
appear in the Reports view of a work center.
a. In the Properties Explorer, select WorkCenterView.
b. Under RBAM Data — Assigned Objects, click ....
c. In the Add Assigned Objects dialog box, click Add and then click … to select the required Component
Id.
d. Select the required Assigned Object Type:
● Navigation Target: To specify the UI components that should be reachable from this view.
● WocViewInclude: To include views of type Include View.
● TaskList View: A collection of BTM task types that should be supported by the view.
● Reports view: To allow the view to show a list of reports in the work center.

The reports are assigned in the Business Analytics work center.

e. If you want to define the dependency of the assigned objects, define the scope rules.
f. If there are a set of navigation targets that belong to many views of a work center, create an Include
View and assign the Include View as an assigned object to this view.
An Include View is built like any other view with a few exceptions like:
1. You cannot include Embedded Components.
2. The View sub-type has to be Include View.
3. An Include View cannot have another Include View.
4. Access context cannot be maintained for Include View.
5. An assigned object of type Include View does not have scope rules.
g. Click OK.
4. Specify the common tasks and related links specific to this view.
a. In the Properties Explorer, select WorkCenterView.
b. Under Links — CommonTasks, click ....
c. In the NavigationListItem Collection Editor, click Add.
d. Under Data — Link, click ... .

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 613
 e. In the Model Navigation … dialog box, select an existing OBN navigation or create a simple navigation.
For example, you can select an existing OBN navigation for the common task Create a Sales Order.
f. You can also create the required event handlers for the common tasks.
For more information, see Create an Event Handler [page 644].
g. If you want a list of related links in the work center view, repeat the above steps under Links — Related
Links.
5. Define the enterprise search objects.
a. In the Properties Explorer, select WorkCenterView.
b. Under RBAM Data — Enterprise Search Objects, click ....
c. In the Enterprise Search Objects Editor, assign the required enterprise search controller objects to the
view and click OK.
The users assigned to this view are authorized to use Enterprise Search and the assigned objects are
available in the drop down list of available enterprise searches.
6. Define the external applications.
a. Under RBAM Data — External Application Data, click ... .
b. In the Select External Application Data dialog box, assign the external applications and click OK.
The service interfaces in the assigned external applications can now be used by this view.
7. Specify the access context.
If the view supports instance restrictions, you can maintain access contexts.
a. Under RBAM Data — Access Context Code, select the required access code of the view.
8. Save and activate your changes.

9.3.2.8 Model a Work Center

Overview
You can model a work center floorplan to display the various work center views.

Prerequisites
You have created the required work center views.

Procedure
1. Create a work center with default views.
a. In the Solution Explorer, right-click your project and select Add New Item .
The Add New Item dialog box opens.
b. Select Work Center.
c. In the Name field, enter a name for the work center and click Add.
The work center is added to your project.
d. Double-click the work center.
The work center opens in the user interface designer.
e. Check the following properties of the work center in the Properties Explorer:

SAP Cloud Applications Studio – Version May 2018 (1805)

614 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 Property Description

Configuration-Help ID ID of the related Wektra help resource

Extensibility-Anchor Associated flexibility anchors

Misc- Name Name of the User Interface Component

RBAM Data-Authorization This indicates how the component is handled for startup authorization. If there is
Classification Code an embedded work center view the entry should always be Application Container.

2. Assign work center views to the work center.

a. On the Designer tab, click on the folder icon.
b. In the Properties Explorer, select OberonCenterStructure.
c. Under Misc-ViewSwitches, click ... .
d. In the View Switch Collection Editor, add a new view switch for each of the work center views as follows:
1. Click Add.
2. Click on the work center views you have added and under Misc- Name, enter a name for the view
switch.
3. Click OK.
e. To add a sub view:
1. In the View Switch Collection Editor, select the view switch.
2. Under Misc-SubViewSwitches, click ... .
3. In the Sub ViewSwitch Collection Editor, click Add.
4. Click on the sub views you have added and under Misc-Name, enter a name for the sub view switch.
5. Repeat the steps for the required number of sub views.
f. To assign a work center view to a view switch:
1. In the Designer tab, select the view switch.
2. From the Configuration Explorer drag and drop the work center view, to the Designer tab.
3. Repeat the steps for all the view switches and sub view switches.
3. Configure the work center.
a. Specify the scope rules for the work center and the view switches:
1. In the Properties Explorer, select the work center.
2. Under Configuration-ScopeRules, click ... .
3. In the Scope Rules Editor, assign the required scope rules and click OK.
4. Repeat the steps for all the view switches.
4. Save and activate your changes.

9.3.2.9 Create a Port Type Package

Overview
You can create a port type package in the studio and modify its attributes in the user interface designer.
A port type package is a component that hosts one or more port types. A port type is a blueprint for an inport or an
outport. Navigation between components that have inports and outports within the same port type package can be
facilitated without any mapping effort.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 615
Prerequisites
You have created a solution in the studio.

Procedure
1. In the Solution Explorer, right-click your project and select Add New Item .
2. The Add New Item dialog box opens.
3. Select Port Type Package.
4. In the Name field, enter a name for the port type package.
5. Click Add.
The port type package is added to your project.
6. Double-click the port type package.
The port type package opens in the user interface designer.
7. Create the required structure, as follows:
● To add a port type, select the root node and then click +.
● To add a parameter, right click on the port type and choose Add Parameter.
● To add a List Parameter, right click on the port type and choose Add List Parameter.
You can add parameters under a list parameter.
● To set a parameter as a key parameter, right click on the parameter and choose Set as Key.
8. To rename any entity in the port type package, right click on the entity and choose Rename. Type the required
name and press Enter .
9. Save and activate your changes.

9.3.2.10 Model a Modal Dialog

Overview
You can model a modal dialog to create a dialog box that is triggered by an event action. You can model a reusable
modal dialog and then bind it to a floorplan, or you can model a modal dialog that is specific to a floorplan and that
can be called by an event handler.

Prerequisites
You have created a solution in the studio.

A. Model a reusable modal dialog.

Procedure
1. In the Solution Explorer, right-click your solution and select Add New Item .

SAP Cloud Applications Studio – Version May 2018 (1805)

616 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 The Add New Item dialog box opens.
2. Select Modal Dialog Floorplan and click Add.
The modal dialog is added to your project.
3. Double-click the modal dialog.
The modal dialog opens in the user interface designer.
4. Select the identification region.
5. In the Properties Explorer, under Misc – Window Title, click the arrow button.
6. In the Dependent Property Editor, enter the title and click OK.
7. On the Designer tab, drag the required controls from the Toolbox to the panes.
8. On the Data Model tab, bind each of the fields to the required business object element.
For more information, see Bind Data Elements to Business Object Elements [page 630].
9. Create the required event handlers.
For more information, see Create an Event Handler [page 644].
10. Create the bindings in the modal dialog as follows:
a. On the Controller tab, right-click Bindings and add a binding.
b. Select a field or a structure for the binding.
c. Enter a Binding Name.
d. Click Bind.
11. In the parent component, do the following:
a. On the Controller tab, right click Modal Dialog and add a modal dialog.
b. In the Repository dialog box, navigate to the modal dialog that you have created.
c. Click OK.
The modal dialog is added to the parent component.
12. On the Controller tab of the parent component, click the new modal dialog and then under Binding
Configuration do the following:
a. In the Parent data model, select the field for the binding.
b. In the Controller Interface for Embedded Component, select the binding.
c. Click Bind.
The modal dialog is now bound to the parent component. This facilitates the synchronous passage of
data from the parent component to the modal dialog.
13. Save and activate your changes.

B. Model a modal dialog specific to a floorplan

Procedure
1. In the Solution Explorer, double-click the floorplan where you want to add a new modal dialog.
The floorplan opens in the user interface designer.
2. From the Toolbox – Panes, drag and drop a ModalDialog onto the Designer tab.
3. In the new modal dialog, do the following:
a. In the Properties Explorer, under Text Information – Title, click the arrow button.
b. In the Dependent Property Editor dialog box enter the required title in the Overridden text field.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 617
 c. Click OK.
d. On the Designer tab, drag the required controls from the Toolbox to the panes.
e. On the Data Model tab, bind each of the fields to the required business object element.
For more information, see Bind Data Elements to Business Object Elements [page 630].
4. On the Controller tab, right-click Event Handler and add a new event handler.
5. For that event handler do the following:
1. Select operation type as Show Modal Dialog.
2. Under Configure the Operation-Modal Dialog name select the modal dialog you have created.
6. Assign the event handler to a button or link.
For more information, see Create an Event Handler [page 644].
7. Save and activate your changes.

9.3.2.11 Model an Embedded Component

Embedded components are reusable sub screens that facilitate:

● Inport and outport navigation between the parent component and the embedded component.
● Bindings to reference data from the parent component.
● Configuration to let the parent component influence the behavior of an embedded component.

An embedded component can be integrated with its parent component as follows:

● Tight coupling: This is handled by referencing a parent data model either explicitly by creating bindings in the
embedded component interface, or implicitly by node reference binding. For example, tight coupling is used
in custom panes, address maintenance, and business cards.
● Loose coupling: Embedded components are triggered in an inport context mapping, for example, by passing
an ID. An embedded component can pass back parameters to a parent component using outport context
mapping. For example, mashups and information snippets displayed in a fact sheet. If an embedded
component is loosely coupled, it should be self-contained and the data binding and controller logic needs to
be defined in the embedded component.

You can delete the embedded component when your solution is in maintenance mode. For more information, see
Maintenance Mode [page 170].

Procedure
1. Create an Embedded Component.
a. In the Solution Explorer, right-click your project and select Add New Item .
The Add New Item dialog box opens.
b. Select Embedded Component.
c. In the Name field, enter a name for the embedded component and click Add.
The embedded component is added to your project.
d. Double-click the embedded component.
The embedded component opens in the user interface designer.

You can model an embedded component just like any other UI component. The main difference is in the
controller interface binding, controller configuration and node reference binding.

SAP Cloud Applications Studio – Version May 2018 (1805)

618 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 2. Prepare to tightly couple an embedded component with its parent component.
a. To tightly couple an embedded component by explicit binding, in the embedded component do the
following:
1. In the Controller tab, right-click on Bindings and choose Add Binding.
2. Select the newly created binding.
3. Select a field or a structure for the binding.
4. Click Bind.
5. In the Binding field, enter a name.
6. Save and activate your changes.
b. To tightly couple an embedded component by node reference binding, in the embedded component
do the following:
1. Drag the required fields to the Designer tab.
2. On the DataModel tab, select an embedded component node, for example, Root.
3. In the Properties Explorer under Node Reference Binding, set Virtual Binding to true.
4. On the Controller tab, right-click on Bindings and choose Add NodeReference Binding.
5. Select NodeReference and select the node on which the Virtual Binding property was set to true.
6. Click Bind.
7. Save and activate your changes.
3. Bind the embedded component.
a. Explicit binding
1. Open the parent component.
2. In the Configuration Explorer, navigate to the embedded component you created.
3. Drag and drop the embedded component to the Designer tab.
4. Click Bind.
5. In the Embedded component binding dialog, in the Bindings Configuration tab, select an attribute
or structure from the Parent Data Model and select a binding under the Controller Interface of
Embedded Component.
b. Node reference binding
1. Open the parent component.
2. In the parent component, create a data structure.
3. In the Configuration Explorer, navigate to the embedded component you created.
4. Drag and drop the embedded component to the Designer tab.
5. Click Bind.
6. Bind the data structure created in the parent component to the node reference binding created
in the embedded component.
4. Configure the embedded component.
An embedded component can expose configurations, to let the parent component influence the behavior of
the embedded component, through configuration parameters and configuration list parameters.
a. Add the required configuration parameters:
1. In the Controller tab, under Configuration, right-click Parameters select Add ConfigParam
2. Choose either Value or Value Help.
Data is passed from the parent component to the embedded component. Value is the default
value to be used by the embedded component in case it is not specified by the parent component.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 619
 Value Help is used when the options to be selected by the parent component are known and fixed.
A default value can be selected in Value Help too.
For example, if the configuration parameter is LayoutType, then the options such as TableLayout,
NewsPaper Layout could be added as value help and the table layout could be set as default. In
the Parent component you can change it to NewsPaper Layout.

You can group a few configuration parameters in a configuration parameter structure.

3. Create a configuration parameter list under Configuration, by right-clicking on Parameter List.

The MinOccurs field property has a fixed value of 1 in the case of a Configuration Parameter List .
4. Specify the minimum and maximum amount of entries allowed in the list, by setting the
minOccursField and maxOccursField properties of the configuration parameter list.

A data model entity is created for each configuration parameter, structure and parameter
list. You can configure their properties in the Properties Explorer.

5. Configure the parent component.

a. To use the configuration parameters of the embedded component, open the parent component.
b. Select the embedded component.
c. In the Properties Explorer, under Parameters — StructureParameters, click ... .
d. In the StructureParameter Collection Editor, to add values for structure parameters do the following:
1. Click Add.
2. Select the added structure parameter and under Misc-Name enter the name.
3. Under Parameters-Parameter click the arrow button.
4. In the ECParameterValueEditor enter or choose the parameter value and click OK.
5. In the StructureParameter Collection Editor click OK.
e. Save and activate your changes.

Alternatives
You can also loosely couple an embedded component to a parent component.
1. Create an embedded component.
2. In the Controller tab, model the inports, in the followings manner:
a. Right-click on Inports and add a new inport.
b. Add a new parameter and bind this to a data field in the data structure.
3. Model the outports to pass back values in a similar manner as the inports.
4. Open the parent component.
5. In the Controller tab, model the outports, to access the embedded component.
6. Model the inports to pass back values.
7. In the Configuration Explorer, drag the embedded component to the Designer tab and click Bind.
8. In the Embedded component binding dialog, in the Simple Navigation tab, right-click on Navigation and select
Add Navigation.
9. Map the parent component outport with the embedded component inport and bind the parameters.
10. Right-click on Navigation and select Add Navigation.
11. Check Reverse Navigation.

SAP Cloud Applications Studio – Version May 2018 (1805)

620 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 12. Map the embedded component outport with the parent component inport and bind the parameters.
13. Click OK.
14. Save and activate your changes.

Result
You should note that once an embedded component is used in a parent component, any interface changes may be
incompatible.

9.4 Modify Your Floorplans

9.4.1 Floorplan Modification Quick Guide

This document gives you an idea about the various modifications and enhancements you can make to the floorplans
created by you using the user interface designer.
For more information about creating floorplans, see the Floorplan Modeling Quick Guide [page 599].

Business and technical background

SAP’s User Interface Style Guide

You can learn how to build user interfaces according to this style guide.

Transformations
A business object (BO) is modeled generically, and not for a specific user. The BO structure and node attributes,
therefore do not always fit the needs of a specific user interface.
A transformation allows the conversion of a BO node attribute into a form that can be used on the user interface.
For more information, see here [page 624].

Tasks
Fields

Bind Data Elements to Business Object Elements

You can bind the data elements you have added to your floorplans, with the business object elements in the backend,
so that data can be derived from the backend when a particular data element is used at runtime.
For more information, see here [page 630].

Define Dynamic Behavior of a Field

A dynamic expression is used to define the behavior of a field within a specific context. You can for example, define
the visibility of a field or a group of fields depending on the content of another field on the screen.
For more information, see here [page 630].

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 621
Buttons

Configure a Button
You can add any required button on the application toolbar. The Cancel and Close buttons are configured in the
system. If you add these buttons, the system automatically associates the event handler, to close the floorplan. If
you want to any other button, you need to write the required event handler. You can also configure a button to open
a floorplan by configuring an object based navigation between floorplans.
For more information, see Configure a Button [page 631].

Create a Preview Button for a Print Form

You can create a Preview button and link it to a print form. Clicking the Preview button allows you to preview the form
as a PDF file and provides options to either save or print the form.
For more information, see Create a Preview Button for a Print Form [page 632].

Translate a Mandatory Button

When you create a solution in a language other than English, you can translate the labels of mandatory buttons in
the UI designer.
For more information, see Translate a Mandatory Button.
Screen Sections

Create a Pane in a Floorplan

You can create a pane to display different types of controls on a screen.
For more information, see here [page 635].

Create a Preview Pane

You can create a preview pane to preview information about a business object listed in a table.
For more information, see here [page 636].
Screen Layout and User Interface Texts

Change the Title of a Component

You can change the text of any component visible on the user interface.
For more information, see here [page 637].

Hide a User Interface Component

1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. Select the user interface component you want to hide, for example, a section group, or a field.
3. In the Properties Explorer, under Behavior — Visible, set the value to False.
4. Save and activate your changes.

Create a Text in the Text Pool

For more information, see here [page 638].
Object Worklists (OWLs)

SAP Cloud Applications Studio – Version May 2018 (1805)

622 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
Configure a Query
You can create and configure a query to view specific instances of a business object in a floorplan.
For more information, see here [page 639].
Tables

Reorder Columns in a List or a Table

1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. In the Properties Explorer, under Child Elements – List Columns, click ... .
3. In the Column Collection Editor, select the column you want to move.
4. Use the up and down arrows to move the column to the required position.
5. Save and activate your changes.

Navigation between floorplans

Configure an Object-Based Navigation in a Target Floorplan

You can use object-based navigation (OBN) to navigate between floorplans and pass parameters between floorplans.
For more information, see here [page 640].

Configure an Object-Based Navigation in a Source Floorplan

You can use object-based navigation (OBN) to navigate between floorplans and pass parameters between floorplans.
For more information, see here [page 641].
External Navigation

Add a Link to Trigger an External URL

You can add a link that opens an external URL in your floorplans.
For more information, see here [page 643].
Transformations

Configure a Dedicated Field

You can add a dedicated field to a data model and use a field transformation to calculate the value of this dedicated
field from existing business object (BO) node attributes.
For more information, see here [page 647].

Configure a Default Set Parameter using Transformations

You can use a transformation to calculate the value of a default set parameter .
For more information, see here [page 647].
Additional Tasks

Write a Script
You can write front-end scripts while creating an event handler and while defining a calculation rule.
For more information, see here [page 289].

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 623
Create an Event Handler
You can create an event handler to respond to user actions on the screen.
For more information, see here [page 644].

Configure an Action Form

You can create action forms to use the action parameters of a business object (BO) node or an enhanced controller
object (ECO) node. Action forms are always bound to a BO/ECO node’s ESI action that has parameters. The binding
is done within the BO Action operation of an event handler. Action forms belong to a user interface component and
cannot be reused in other user interface components.
For more information, see here [page 645].

Configure an Object Value Selector

You can configure an Object Value Selector (OVS) control to open an OVS dialog box.
For more information, see here [page 646].

Add a Report List View to a Work Center

You need to assign standard report list views, for example the List and Gallery standard reports list views, to a work
center in the user interface designer.
For more information, see here [page 648].

Define an Anchor for a Floorplan

You can define anchors for your floorplans to allow end users to make changes to the floorplans provided by you.
For more information, see here [page 650].

Save and Activate Your Changes

After you have created any of the changes listed above, you have to save and activate the changes.
1. From the File menu, choose Save.
2. From the File menu, choose Activate.
3. In the Activate Worklist dialog box, select the check boxes beside the relevant components and click OK.

9.4.2 Business and Technical Background

9.4.2.1 Transformations

Overview
A business object (BO) is modeled generically, and not for a specific user. The BO structure and node attributes,
therefore do not always fit the needs of a specific user interface.
For example, in the Purchasing contracts BO , a specific value needs to be entered to ensure the unlimited validity
of contracts. So a date like 31/12/9999 is used for this purpose. On the user interface however, a checkbox to indicate
unlimited validity is needed and not a set date.

SAP Cloud Applications Studio – Version May 2018 (1805)

624 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
A transformation allows the conversion of a BO node attribute into a form that can be used on the user interface.
You can use transformation rules to calculate the value of fields or parameters in the user interface data model that
do not have direct counterparts within the BO node structure.
Examples of transformation rules include:
● Period-to-Indicator
● Code-to-Indicator
● Concatenation of attribute values
● Time-to-Duration
● Age from date

A transformation has one or many inbound parameters. The input for a transformation can either be a constant
value, a binding against a field of a BO node structure, or an already existing data field from the user interface. The
resulting outbound value is assigned to a target field or a parameter inside the user interface data model.
The type of transformation rule used depends on whether the value being generated is for use in a dedicated field
or in a default set parameter.
For each namespace, a predefined set of transformation rules are available.

See Also
Configure a Dedicated Field [page 647]
Configure a Default Set Parameter using Transformations [page 647]

9.4.2.2 Operation Types

Overview
Operation types in the user interface designer allow you to assign an activity to an event handler.
When creating an event handler [page 644], you can select from one or more operation types.
Following are the various operation types:

BOAction [page 625] ContainerExit FireEventHandler OpenLink [page 627] WindowAction

[page 626] [page 627] [page 628]

BOOperation DataOperation FireOutport ShowModalDialog Controller

[page 626] [page 627] [page 627] [page 628] [page 628]

CheckAndDetermine DocumentOutput List [page 627] SynchDataContainer RestartClient

[page 626] [page 627] [page 628] [page 628]

Condition [page 626] ExecuteDefaultSet MessageBox ValueHelp QCAfterSaveAction

[page 627] [page 627] [page 628] [page 628]

BOAction
The BOAction can be used to invoke a special function exposed by an ESR action.
BOAction parameters can be bound to data fields in the data model to pass values to parameters. To enter values
for the action parameters, you can configure an action form in the BOAction. Add the controls to the action form
and bind the action parameters to the data fields bound to controls. On executing the event handler, the action form
is displayed. Enter the action parameter values and click OK to execute the BOAction.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 625
You can configure the following additional parameters for the BOAction:
● Instance Binding is the binding of an action against the node instance(s). It is required for list-binding.
● Save Before Execution indicates whether or not a save before the execution of the action is required, for
example for one-click actions.
● Save After Execution indicates whether or not an immediate save is required.
● Continue on Reject allows the execution to continue even when the BOAction fails. If this flag is not checked,
the event handler is stopped.
● Special Reference Action supports copy and paste for lists. The list operation CutCopy stores the selected
instances in the buffer. To use this selection for the next reference action, pasting in this case, you can model
a special reference BOAction by checking this flag. Then, the selected instances in the first operation, CutCopy
in this case, are passed as parameters for this second reference action.

BOOperation
The BOOperation is an implicit ESI-Action. This operation is supported by all business objects even though it is not
explicitly modeled in ESR as an action. It is used to perform Read, Create, DelayedCreate and ValueHelp.
You can configure the following additional parameters for the BOOperation:
● Set Suppress Messages to true to suppress all messages invoked by triggering this operation in the backend.
Otherwise, all ESI and backend messages will be displayed.
● Select Namespace and Select BO describe the BO on which the operation is performed.
● BO Operation parameters are defined by the user and not derived from ESR metadata.
For example, for a read operation, you need to pass the ID value to indicate with which ID you want to invoke
the read.
There are the following parameter types:
○ the keyNavigation parameter is passed with special metadata, here the key flag and GDT metadata.
○ With nodeID, the value of the node id is passed
○ The alternativeKey is modeled for some BOs as number ranges, for example. In the backend, they need
special treatment before a read/retrieve can be done.
The value of the alternative key node is converted to node ID. The type of alternative key is indicated by
the data field bound to the path attribute. This value is used at runtime to identify the type.

CheckAndDetermine
The CheckAndDetermine offers a generic function for checking BOs, without the need for an explicit, modeled BO
action. A check carried out with this operation triggers the validation of a whole BO instance, or a specific node with
subnode tree. Error or warning messages are sent to the client if there are any inconsistencies.
This operation is generally used for Guided Activity floorplans, but may also be used in other applications where you
want to implement a check button.

Condition
Condition is used as a branch control to call different operations based on a data model value or constant. You can
specify a default option, as well as configure multiple select options with different compare types and values; and
nested condition operations.

ContainerExit
ContainerExit is an action defined on the exitClass and should only be used in special situations, namely, wherever
a data structure has an exit class assigned.
You can configure any one of the actions in the action field, or create new ones manually. If you use an existing action,
the system automatically sets the exit class property of the structure you have selected as path.

SAP Cloud Applications Studio – Version May 2018 (1805)

626 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
DataOperation
DataOperation allows you to modify the value of data model fields.
● Assign the value of a text pool entry to the target data field with assignText.
● Assign the value of the source data field to the target data field with assign.
● Assign a constant value to the target data field with assignConstant.
● Clear the value of the target data field with clear.

DocumentOutput
DocumentOutput configures Microsoft Excel and Microsoft Word downloads. The group ID is used by the Excel/
Word export to identify the assigned template group.

ExecuteDefaultSet
ExecuteDefaultSet executes an ESI query. Set Blocking to block access to the UI during query execution.

FireEventHandler
FireEventHandler allows you to invoke other event handlers.

FireOutport
FireOutport is used to fire and pass data to the outport. Set TakeOverMessagesToNewWindow to carry forward
messages from the previous save to a new window in Save and New scenarios.

List
List triggers operations related to the data list such as Add Row and Remove Row. Set Blocking to block access to
the UI during the operation.

MessageBox
MessageBox configures decision pop-ups, for example Are you sure you want to delete? A deletion template
is available, as well as other parameters to customize your configuration.
Use List Binding to enable plural text and list count for multi-selection.

OpenLink
OpenLink opens a link in an external browser. The link value can be bound to a data field and URL.
Set the browser target features as follows:
● Default = empty
● Status = yes
● Toolbar = yes
● Menubar = yes
● Resizable = yes

Set Process Protocol to explicitly switch off the protocol handling for the OpenLink operation. In this way, you ensure
that file:// or https:// remains in the URL.
Script allows you to define front-end script for dynamic expressions. Set Blocking to block access to the UI during
script execution.
In the Scope Fields section, you can configure data fields that trigger script execution. When a field value changes,
the script is executed.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 627
ShowModalDialog
ShowModalDialog allows you to display an in-component modal dialog as pop-up To configure it, drag and drop
Modal Dialog from the toolbox to the user interface designer or create one from the selection proposal in this
operation.

SynchDataContainer
SynchDataContainer forces a backend round trip and flushs the data container at runtime. You can use this operation
instead of, for example, provoking a round trip by flagging a dummy field with requiresRoundTrip and setting a value
in this field.
When the Finalize flag is set, DoPostProcessing is invoked which results in the evaluation and sending of messages.

ValueHelp
ValueHelp should be configured if an object value selector (OVS) component is involved.
● Set the Use Query flag to trigger the query configured as query attribute.
● Query Name is the query in the OVS to be called.
● For Operation Type, Get is for retrieving DefaultSets, and Set for passing to the parent component.
● Use Suppress Messages to suppress messages coming in the value help round trip.
● Parent Component Id and Parent Path are the parent component node information for the RetrieveValueSet
call.
● Select Namespace and Select BO Model describe the OVS controller name.

WindowAction
In WindowAction, set TakeOverMessageInCallingWindow to Yes to show messages of the current operation in the
calling window.
For Success Notification Port, configure the outport to be fired on save. The outport and inport at the source should
be configured with the same local event name. In this way, when a quick activity is opened from a work list, then
saved and closed, the system informs the port that the save is successful and the work list is refreshed.
Set Continue on Reject to continue with the execution even if the window action fails.

Controller
Controller should be used to create Actions on BO in case of new Controller Infrastructure. From a functional
perspective a controller acts like a BO Action in a new controller infrastructure.

RestartClient
RestartClient clears details from the DataModel and reloads the screen from the backend. In this way, if you open a
screen, make a change, then cancel the operation, the screen reverts to its state before the edit operation was
performed. There is no configuration for this operation.

QCAfterSaveAction
QCAfterSaveAction is configured in the Quick Create (QC) component after a WindowAction operation. You can
configure the action type to open the Thing Inspector after the save operation, or open a new Quick Create screen.

SAP Cloud Applications Studio – Version May 2018 (1805)

628 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
9.4.2.3 Message Mapping

Overview
A message is the text shown at the bottom of the user interface (UI) during runtime. It presents the user with a piece
of information, an instruction, or a warning in a given situation. In SAP cloud solutions messages are sent to the UI
from the business object (BO) that the UI is based on. The messages are part of the infrastructure delivered by SAP
or can be part of a custom BO.
In some cases, the original messages of the BO that are shown during runtime do not fit the context of the UI. For
example, they have the wrong terminology or the terms used are not specific enough. In those cases, you can
exchange messages or change the behavior of messages on the UI by using the message mapping offered by the UI
designer. If the original message contains parameters you can also display a different message for each individual
parameter value.
You map messages only within the context of a specified UI and not across the system. This means, if a message is
shown in the context of two different UI models, you can map it for one UI model and this mapping does not affect
the message in any other UI model.

Prerequisites
Message mapping in the UI designer is only available for BOs that contain messages.

Structure
In the UI designer, message mapping is located on the Controller tab of those UI components that directly
communicate with the BO or the backend. On the Controller tab, the following sections deal with the messages of a
BO:
● Messages
In this section, the UI designer displays all messages associated with the BO that the currently selected UI
component is based on.

● Message Mappings
In this section, you can see the original messages associated with the BO and you can do the actual mapping.
For more information, see Map a Message [page 650].

● Message Mapping Overview

In this section, you see the original messages together with the mapped messages.

In the UI designer, you can use the following rules to deal with messages:
● Replace
The original message is replaced by a new message. During runtime, the system displays the new message
on the UI instead of the original message.
● Ignore
The system ignores the original message and does not show it during runtime on the UI.
● Original
The system displays the original message during runtime.
● Aggregate

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 629
 Any number of messages can be combined into one new message. The system displays this new message
on the UI during runtime instead of the original messages.

9.4.3 Tasks

9.4.3.1 Bind Data Elements to Business Object Elements

Overview
You can bind the data elements you have added to your floorplans, with the business object (BO) elements in the
backend, so that data can be derived from the backend when a particular data element is used at runtime.

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. In the Data Model tab, under the Root structure, add the necessary data fields, data structures, and data lists.
3. Bind the data structures and the data fields under the Root structure to the BO structure nodes and the BO
elements.
To bind a data element, select the required data element from the left list and select the required business
object element from the right list and click Bind.
4. In the dialog box that opens, click Yes if you want the system to automatically use the text maintained for the
BO element as the field label.
5. If you want to manually enter a field label in the user interface designer, in the Designer tab do the following:
a. Double-click the user interface control.
The Dependent Property Editor dialog box opens.
b. Enter the field label in the Overridden Text field.
6. Save and activate your changes.

9.4.3.2 Define Dynamic Behavior of a Field

Overview
A dynamic expression is used to define the behavior of a field within a specific context. You can for example, define
the visibility of a field or a group of fields depending on the content of another field on the screen.

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. Select the required field.
3. In the Properties Explorer, under Behavior – Visible, select Advanced.

SAP Cloud Applications Studio – Version May 2018 (1805)

630 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 4. In the Dependent Property Editor, select the variant Calculation Rule.
5. Under Calculation Rule, define the formula as a Boolean expression.
For example, if the formula is the following:
($Data.DiscountType == 2 ),
return true
else
return false
Then, this field is displayed only when the Discount Type field has the value 2.

To define the formula, you can use every field that is defined in the DataModel. The fields available in
the DataModel are listed under the collection pattern Invalidation Trigger.

For more information, see Write a Script [page 643].

6. Under Invalidation Trigger, mark each of the fields you have used within the formula and add it using the arrow
buttons.
7. Click OK.
8. Save and activate your changes.

Example
There are many discount types available in the system. If the user selects the Discount Type Christmas, you want
the Minimum Bill Amount field to be visible on the screen. This field is otherwise not visible if the user selects any
other discount type. In such a case, you can define a dynamic expression for the Minimum Bill Amount field.

9.4.3.3 Configure a Button

Overview
You can add any required button to the application toolbar of your floorplan. The Cancel and Close buttons are
configured in the system. If you add these buttons, the system automatically associates the event handler to close
the floorplan. If you want to add any other button, you need to create the required event handler. You can also
configure a button to open a floorplan by configuring an object-based navigation between floorplans.

Prerequisites
You have created a floorplan.

Procedure
1. In the studio, double-click the floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. Open the Configure Toolbar as follows:
a. In the Properties Explorer, select the AdvancedListPaneVariant to which you want to add a button.
b. Under Toolbar Information - Use Toolbar, select True.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 631
 c. Under Toolbar Information - ListPaneToolbar, click ... .
3. Add the required button in the Configure Toolbar dialog as follows:

Task Action

To add a Under Available list, select Close or Cancel button and click the right arrow button. The button is now
configured available in the Current list.
button

To add an 1. Under Available list, select the required button or the Application Specific button and then click
application- the right arrow button.
specific
2. Under Events - OnClick, select New Event Handler.
button and
For more information, see Create an Event Handler [page 644].
configure it
manually

To add a 1. Under Available list, select the required button or the Application Specific button, and then
button and click the right arrow button.
configure an
2. Configure OBN navigation in the source and target floorplans.
object-based
For more information, see Configure an Object-Based Navigation in a Source Floorplan
navigation
[page 641] and Configure an Object-Based Navigation in a Target Floorplan [page 640].
(OBN)

4. Click OK.
5. Save and activate your changes.

See Also
Translate a Mandatory Button

9.4.3.4 Create a Preview Button for a Print Form

You can create a Preview button and link it to a print form. Clicking the Preview button allows you to preview the form
as a PDF file and provides options to either save or print the form.

Prerequisites
● An activated floorplan exists for the business object.
For more information, see Model an Object Instance Floorplan [page 605], steps 1–3.
● An activated print form is associated with the business object.
For more information, see Create a Print Form [page 438].

Procedure
1. Open the floorplan in the user interface designer (UI designer) and create an outport.
a. In the studio, double-click the floorplan in the Solution Explorer.
The floorplan opens in the UI designer.
b. On the DataModel tab, right-click on Root and select Add Data Field.

SAP Cloud Applications Studio – Version May 2018 (1805)

632 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 c. In the Properties Explorer, set the following properties of the data field:
● Initial Value: True
● Type: Boolean
● Name: bool_true
d. On the Controller tab, right-click on Outports and then select Add Outport.
e. To rename the outport, right-click the outport and select Rename. Enter a name, for example,
PreviewOutport.
2. Add the outport parameters.
a. In the Outport Configuration: OutPort view, click the Add Parameter button.
b. In the ParameterName field, enter GroupCode.
c. In the Constant field, enter the group code.

You can find the group code in the studio. In the Solution Explorer, double-click the .ftgd file.
The group code is displayed as shown in the figure below.

Group code displayed in the studio

d. Click the Add Parameter button again.

e. In the ParameterName field, enter ForceFrontendPreview.
f. Next to ParameterBinding, click ... . The Parameter Binding dialog box opens.
g. Select the data field bool_true and OK, then save your changes.
The output parameters have been entered as shown in the figure below.

Outport parameters entered in the Parameters Binding dialog box

3. Bind the outport and inport parameters.

a. On the Controller tab, right-click on Modal Dialogs and then select Add ModalDialog.
b. In the Repository Browser dialog box, navigate to the modal dialog named Preview by selecting
SAP_BYD_APPLICATION_UI —> Reuse —> OutputManagement —> Preview and click OK.
c. Under Modal Dialogs, click Preview.
The Bindings Configuration/Simple Navigation dialog box opens as shown in the following figure.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 633
 Bindings Configuration/Simple Navigation dialog box

d. On the Bindings Configuration tab, bind Root to NodeReferenceBinding:

Click Root and NodeReferenceBinding and then click Bind.
e. On the Simple Navigation tab, right-click on Navigations and select Add Navigation.
f. In the Navigation Details, select the outport you created (for example, PreviewOutport) as
Outport and select InPreview as Inport.
g. Bind each of the Source Outport parameters with the corresponding Target Inport parameter and save
your changes.
4. Create an event handler to fire the outport.
a. On the Controller tab, right-click Event Handlers and select Add EventHandler.
The new event handler is displayed under Event Handlers.
b. Right-click the new event handler and select Rename; then enter a new name for the event handler,
for example, PreviewHandler.
c. Under EventHandler: Operations, click the Add Operation button.
d. Under Type, click in the field and then select FireOutport.
e. Under Configure the operation, select the outport you have created (for example, PreviewOutPort)
as OutPort and save your changes.
5. To ensure that the user can use the preview button, associate the new event handler with the OnClick event.
a. On the Designer tab, select the navigation region.
b. In the Properties Explorer, click in the Toolbar field and click ... next to Configure.
The Configure Toolbar dialog box opens
c. Under Available, StandardButtons, select Preview.
d. Add the button to Current by clicking the arrow pointing to the right.
e. On the right, under Events, select OnClick and then the event handler you have created (for example,
PreviewHandler) and click OK.
The Preview button has been added to the navigation region.
f. Save your changes.
6. Test the Preview button in the SAP cloud solution.
a. Select the Preview tab next to the Controller tab.
b. Log on to the SAP cloud solution.
The SAP cloud solution opens and the Preview button you have added is displayed as shown in the
following figure.

SAP Cloud Applications Studio – Version May 2018 (1805)

634 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 The Preview button in SAP Business ByDesign

c. Click Preview.
The Preview window opens.

See Also
Print Forms Quick Guide [page 437]

9.4.3.5 Create a Pane in a Floorplan

Overview
You can create a pane to display different types of controls on a screen.

Prerequisites
You have created the floorplan to which you want to add the pane.

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. Select the pane, for example, the pane above which you want to add new fields.
The pane is highlighted with a red border.
3. You have the following options:
● To insert or delete a row or a column , right-click on the pane, select Layout and then choose the
appropriate option.
● To expand the pane over two columns, click the arrow button on the right side of the pane.
● To move the pane to the next row, select the pane and drag the pane to the required row.
4. Drag and drop the required controls from the Toolbox into the new pane.
5. Bind each of the fields to the required business object element.
For more information, see Bind Data Elements to Business Object Elements [page 630].
6. Save and activate your changes.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 635
9.4.3.6 Create a Preview Pane

Overview
You can create a preview pane to preview information about a business object listed in a table.

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. On the Designer tab, select the advanced list pane.
3. In the Properties Explorer, under Misc – List Pane Variants, click the arrow button.
The List Pane Variant Collection Editor opens.
4. Under Appearance, set Use Preview Pane to True.
The list pane selected, is now expanded with two rows. The system also allows you to add controls in those
rows.
5. Drag the required controls from the Toolbox Controls to the preview panes.
When you drag and drop a control, a Section Group is automatically created. You can add multiple controls
to a section group and give a name to the section group. For example, the name of the section group can be
Invoice Address.
6. In the Properties Explorer, under Text Information – Field Group Header, enter the required section group
name.
7. Bind each of the fields to the required business object element.
For more information, see Bind Data Elements to Business Object Elements [page 630].
8. Save and activate your changes.

Example
You have created an Object Work List (OWL) which shows a list of customers. You now want to create a preview
pane, to view the following invoice address details of a selected customer, without leaving the OWL:
● Number
● Street
● City
● Pin Code
● Phone Number

You also want to view the number of orders that have not been shipped or delivered yet.
For each customer, you can configure a preview pane and add various fields to display the above information.

SAP Cloud Applications Studio – Version May 2018 (1805)

636 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
9.4.3.7 Change the Title of a Component

Overview
You can change the text of any component visible on the user interface. For example, you can change the following:
● Field label or tab text
● Group Header: Heading given to a group of fields.
● Roll Over Explanation Text: For field names that are not easy to understand, you can provide an explanation
text. The system underlines fields with explanation texts in green and the explanation is visible on mouse over.
● Tooltip: In cases where a field name is abbreviated or is an icon, you can provide a tooltip for the field.
● Explanation Text: A sentence or two that is displayed on the user interface with details such as how to perform
a task.
● Title of a floorplan, for example, a work center view.

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. Double-click the text that you want to change.
The Dependent Property Editor dialog box opens.

You can also change the text in the Properties Explorer, For example:
● You can change the explanation text visible on the user interface under Text Information –
Explanation Area Text.
● You can provide a rollover explanation text under Text Information – Explanation.

3. Enter the required text in the Overidden text field.

All text options that can be changed for a particular component are displayed at the bottom of the
Dependent Property Editor dialog box.

4. Click OK.
5. Save and activate your changes.

9.4.3.8 Hide a User Interface Component

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. Select the UI component you want to hide, for example, a section group, or a field.
3. In the Properties Explorer, under Behavior — Visible, set the value to False.
4. Save and activate your changes.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 637
See Also
Change the Title of a Component [page 637]

9.4.3.9 Create a Text in the Text Pool

Overview
You can create text pools in order to collect all texts that you want to use for a particular user interface component,
such as a floorplan.
The system-generated and the user-specific text are visible in the TextPool option in the Controller tab. The system-
generated text is created by the tool. It is associated with a particular component, is marked in red and cannot be
edited in the textpool.
The user- specific texts can be entered by the user and are mostly used in scripts. They are marked in black. You
can reuse these texts when you are selecting a label for a control using the Reuse Text option. Based on the context,
the texts with the correct text category are displayed on the user interface.

Prerequisites
You have created the floorplan for which you want to create the text pool entry.

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. On the Controller tab, click TextPool.
3. Select the required language.
4. To add a new text to the text pool:
a. Click Add Text.
The UUID is automatically generated.
b. Select a Text Category based on where you would like to reuse this text.
X indicates short text that is less than 120 characters and Y indicates long text.
5. To enter the reusable text click … .
The Text Block Entry Editor dialog opens.
6. In the Text Block Entry Editor, you can do the following:
● Edit the static text: Change the text and click OK.
● Reuse the static text: Click on Reuse Text and select one of the texts shown in the list and click OK.
● Add an advanced concatenation of static and dynamic text parts. Dynamic parts inside the text are
bound to data fields and are calculated during runtime.
a. Click Advanced.
b. To add a dynamic part to the text to the static text, click ... in a new row.
c. In the Select Data Field dialog, select the required data field and click OK.
7. Save and activate your changes.

SAP Cloud Applications Studio – Version May 2018 (1805)

638 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
9.4.3.10 Configure a Query

Overview
You can create and configure a query to view specific instances of a business object in a floorplan.
For example, in the Contracts OWL, the Show drop down list has entries such as Contracts in Preparation,
and Released Contracts. These are the default sets under a query and are used to display a filtered set of
contracts. You can create a query and default sets under that query. These default sets are then added to the drop
down list.

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. Add a data field to create a reference to your data type, as follows:
a. On the Data Model tab, right-click on root and then add a data structure.
b. Right-click on the structure and then add a data field.
3. Configure the query, as follows:
a. On the Controller tab, right-click on Queries and then choose Add Query.
b. In the Query Configuration, select the required Namespace and BO.
c. The queries modeled under the BO are displayed in a hierarchical manner.
Expanding the query node in the tree will show all the query parameters.
d. Select the required query and click Bind.
e. Add the query parameters and select the data field that you created as the required value.
4. Configure the default set, as follows:
a. Right-click on the query and then choose Add Default Set.
b. To rename the default set, right-click on the default set and then choose Rename.
c. In the Default Set Configuration, enter a Title for the default set.
This value is displayed in the Show field.
d. Select the query parameter you have added and define how you want the parameter to be used, by
choosing the required Select Options and values.
You can now use the default set in the OWL.
5. Select a default query, as follows:
a. In the Properties Explorer, select the Advanced List Pane.
b. Select the required default set, under Misc — Default DefaultSet.
c. Under Misc — Default Set Mapping, click ... .
d. In the Default Set Mapping dialog box, move the default sets to the Binding area and click OK.
6. Save and activate your changes.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 639
9.4.3.11 Reorder Columns in a List or a Table

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan is opened in the user interface designer.
2. Select the list.
3. In the Properties Explorer, under Child Elements – List Columns, click ....
4. In the Column Collection Editor, select the column you want to move.
5. Use the up and down arrows to move the column to the required position.
6. Save and activate your changes.

9.4.3.12 Configure an Object-Based Navigation in a Target Floorplan

Overview
You can use object-based navigation (OBN) to navigate between floorplans and pass parameters between floorplans.
The following instructions are to be performed in the floorplan that you would like to display on the click of a button.
For example, the target floorplan can be the Product floorplan that is displayed when you click the Product ID link.

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. On the Data Model tab, add a data field.
3. If required, rename the data field.
4. On the Controller tab, right click Inports and select Add Inport.
5. Check the OBN Inport check box.
6. Select the required namespace and business object (BO) model.
7. Under the BO, select the node for which the inport is being configured. If no node is selected, by default the
root node will be chosen by the system.
8. Create an operation.
9. Select a PortTypepackage and PortTypeReference .
The combination of business object, business object node, and the operation identifies the navigation target.
10. You can select one of the following port type references:
● OpenByKey: Used at instance when you want to open the target floorplan for more information about
an object in a read only mode. For example, the target floorplan is a customer fact sheet to view
information about a customer.
● CreateWithRef: Used at instance when you want to create an object with reference to the source
floorplan. For example, the target floorplan is a Purchase Order OIF that is called from a Contract
floorplan, to create a purchase order with reference to a contract.
11. Bind the data field you just created as the parameter for Key.

SAP Cloud Applications Studio – Version May 2018 (1805)

640 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 12. Bind the parent of the data field as the parameter for KeyList.
13. On the Controller tab, right-click on Event handlers and select Add Eventhandler.
14. If required, rename the event handler.
15. Select the Operations - Type as BOOperation.
16. Define the following BO Operations Parameters:
a. Enter a name.
b. Select the Type as keyNavigation .
c. Select the data field that you created as Bind.
17. Select the inport you created.
18. In the Properties Explorer, under Events – OnFire, select the event handler you created.
19. Save and activate your changes.

Example
You are on the Products object work list (OWL) that displays a list of products, and you want to view the details of
a selected product in the Edit Product OIF.
In the Products OWL, when a user does one of the following, you want to open the Edit Product OIF:
● Select a Product ID
● Selects a row and click View or Edit

To do this, you should configure an OBN in the source (OWL) and the target (OIF) floorplan.

9.4.3.13 Configure an Object-Based Navigation in a Source Floorplan

Overview
You can use object-based navigation (OBN) to navigate between floorplans and pass parameters between floorplans.
Perform the following steps in the floorplan where you click a UI control to open the target floorplan.

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. Right-click the user interface control that should open the target floorplan and choose Add OBN using
Wizard.
3. The Configure OBN dialog box opens.
4. Under Select BO details , do the following:
a. You can enter the name of the OBN being configured or the default name will be used.
b. Select the namespace.
c. Select the BO model.
d. Select the node under the BO for which you want to configure the OBN. If no node is selected, the root
node is chosen by default.
e. Click Next.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 641
 5. Under Select Operation, do the following:
a. From the list given, select the operation which needs to be executed. Each operation will have an
associated PortTypePackage and PortTypeReference which get configured when you choose that
particular operation. The combination of business object, business object node and the operation
identifies the navigational target.
b. Click Next.
6. Under Configure Outport Data, do the following:
a. You can enter the name for the Outport being configured or the default name will be used.
b. Add the Context Attribute details.
Navigation can be made specific for a particular target floorplan by defining the context attributes,
distinguishing it from a floorplan from the same business object, business object node and having the
same operation configured for it.
c. Define the parameters you want to pass on to the target floorplan. The event handler is automatically
created and bound to the outport.
You can also rename the event handler which is being created.
d. Click Finish.
7. To edit a already configured OBN, right-click on the User Interface control for which the OBN was previously
configured and choose Edit OBN Using Wizard.
8. Save and activate your changes.

Alternatives
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan is opened in the user interface designer.
2. Select the button that should open the target floorplan.
3. In the Properties Explorer, under Menu Information – Navigation, click ... .
4. In the Model Navigation dialog box, do the following:
a. Select the target business object.
b. Select the BO node defined in the target floorplan.
c. Select the Operation defined in the target floorplan.
d. Click OK.
5. On the Controller tab, select the outport that was automatically created.
6. Define the parameter you want to hand over to the target floorplan.
The event handler is automatically created and bound to the outport.
7. To open the target floorplan on click of a link in a table, do the following:
a. Select a column.
b. In the Properties Explorer, select the Display Type as Link.
c. Under Events – OnClick, define an event handler that is configured with FireOutport, to open the target
floorplan.
8. Save and activate your changes.

SAP Cloud Applications Studio – Version May 2018 (1805)

642 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
9.4.3.14 Add a Link to Trigger an External URL

Overview
You can add a link that opens an external URL in your floorplans.

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. Drag the Link control from the Toolbox to the Designer tab.
3. On the Designer tab, select the Link user interface control.
4. In the Properties Explorer, under Events - onClick, select New Event Handler.
5. In the Configure Event Handler dialog box, select the Operation Type OpenLink.
6. Enter the required URL in the Uri field.
7. Click OK.
8. Save and activate your changes.

9.4.3.15 Write a Script

Overview
You can write front-end scripts while creating an event handler and while defining a calculation rule.

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. In the Designer tab, select the user interface control to which you want to associate this script.
3. To write a script in an event handler, for example, to trigger an action on the click of a button, do the following:
a. In the Properties Explorer, under Events - onClick, select New Event Handler.
b. In the Configure Event Handler dialog, select the Operation Type as Script.
4. To write a script in a calculation rule, for example to control the visibility of a user interface control, do the
following:
a. In the Properties Explorer, under Behavior – Visible, select Advanced.
b. In the Dependent Property Editor, select Calculation Rule.
5. Write the front-end script and click OK.
In the script, you can:
● Use the data elements defined in the Data Model tab.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 643
 ● Use the scope fields or the invalidation trigger fields to model the dependency between user interface
controls.
● Use the IntelliSense feature. For example you can select the data elements that are defined in the
floorplan as you type the script.
● Click ZoomOut to expand the editor for a bigger view.
● Click Check Syntax to check if the script is syntactically correct.

For information, see Front-End Script Reference [page 289].

6. Save and activate your changes.

9.4.3.16 Create an Event Handler

Overview
You can create an event handler to respond to user actions on the screen. For example, if you want to close the
window when the user clicks on the Close button, you can create an event handler for the Close button. You can do
either of the following:
● Create the user interface control, for example, a button, and then create an event handler.
● Create the event handlers first and then associate the event handler to the required user interface control.

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. Select the control for which you want to add an event handler.
3. In the Properties Explorer, under Events – OnClick select New Event Handler.
4. Enter a name for the event handler.
5. Select the type of operation.
You can add more than one operation, for example, a ListOperation for an AddRow button, a BOAction
for a Save button and a WindowAction for a Close button.
For more information, see Operation Types [page 625].
6. Click OK.
7. Save and activate your changes.

Alternatives
You can also create an event handler first and then associate it with the required user interface control.
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan is opened in the user interface designer.
2. On the Controller tab, under the Tree view, right-click on EventHandlers and then choose Add EventHandler.
3. Enter a name for the event handler.
4. Select the type of operation.
5. On the Designer tab, select the UI control with which you want to associate the event handler.
6. In the Properties Explorer, under Events – OnClick, select the event handler you have created.

SAP Cloud Applications Studio – Version May 2018 (1805)

644 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 7. Save and activate your changes.

9.4.3.17 Configure an Action Form

Overview
You can create action forms to use the action parameters of a business object (BO) node or an enhanced controller
object (ECO) node. Action forms are always bound to a BO/ECO node’s ESI action that has parameters. The binding
is done within the BO Action operation of an event handler. Action forms belong to a user interface component and
cannot be reused in other user interface components.
You can either create an action form and then configure an event handler for it, or you can create an action form for
an existing event handler.

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. In the Toolbox, under Panes, drag ActionForm to the Designer tab.
3. Double-click the action form.
4. Set the following properties:
● Events – onCancelActionForm: Create an event handler to handle the Cancel action in the action form.
For more information, see Create An Event Handler [page 644].
● Misc– Title: Enter a title for the action form.
● Misc – PreventDisplay: It is usually set to False . You can display the action form, even if all the required
parameters are not available at run time. In such a case, set it to True.
5. Drag the controls from the Toolbox to the action form.
6. Bind the controls to the fields which are bound to the action parameters.
7. Save and activate your changes.

Alternatives
You can also create an action form while configuring the event handler, which calls the corresponding ESI action.
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan is opened in the user interface designer.
2. In the Controller tab, select the event handler that triggers the ESI action.

If there is no operation that calls an ESI action, create a new operation of type BO Action and map the
operation to the corresponding ECO/BO action.

3. If the action parameters are not yet bound to data model attributes, bind these attributes in the Selected
Action Parameters section.
4. Under Action Form, select the new action form.
The action form with all the ESI action parameters will be created.
5. In the Designer tab, double-click on the action form.
6. If you want to display additional information, add the required fields.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 645
 7. Save and activate your changes.

9.4.3.18 Configure an Object Value Selector

Overview
You can configure an Object Value Selector (OVS) control to open an OVS dialog box.

Prerequisites
You have created the required OVS dialog box.
For more information, see Create an Object Value Selector Dialog Box [page 608].

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. Do one of the following:
● To add a new field, insert an ObjectValueSelector from the Toolbox controls.
● To modify an existing field, select the required field, for example Employee. In the Properties
Explorer under Appearance, set DisplayType to ObjectValueSelector.
3. In the Properties Explorer, under Value Help - OVSComponent, click ... .
The Select OVS Component dialog is displayed.
4. Click Browse to display the Repository Browser.
5. Select the Target Component from the tree.
6. If you want to reuse the SAP delivered OVS, click Public OVS and select an OVS component from the list.
7. Click OK.
8. Bind the ID attribute to the value.

The CCTS type must be the same as defined in the outport of the OVS dialog box

9. Bind the description attribute to the text.

The CCTS type must be the same as defined in the outport of the OVS dialog box
The value for the text is not passed on automatically from the OVS box. You use the AfterModify
script files to ensure that the texts are retrieved.

10. Save and activate your changes.

Example
You are creating a sales order and want to assign an employee responsible for that order. In the Sales Order floorplan,
there is an Employee field, which is an OVS control. If you click this control, the OVS dialog appears where you can
search for the required employee. The selected employee is displayed in the Sales Order floorplan.

SAP Cloud Applications Studio – Version May 2018 (1805)

646 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
9.4.3.19 Configure a Dedicated Field

Overview
You can add a dedicated field to a data model and use a field transformation to calculate the value of this dedicated
field from existing business object (BO) node attributes.
For more information, see Transformations [page 624].

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. On the DataModel tab, right-click on Root and add a dedicated field.
3. On the Controller tab, right-click on Field Transformations and add a new Field Transformation.
4. For the Field Transformation, under Target Field, select the dedicated field that you created.
5. Select the Namespace.
6. Under Transformation, select the type of transformation rule you want to use.
The parameters for that transformation rule are displayed. Each parameter section displays the parameter
name and an indication if it is a mandatory field.
7. Each parameter can be configured by creating a data binding to the BO model or by assigning a constant
value to it.
● To configure a data binding, do the following:
a. Select the BO binding checkbox.
b. In the BO configuration area, click ….
c. In the Select Data Field dialog box, select the BO node to be bound.
d. Click OK.
● To assign a constant value, select the Constant checkbox and, in the Constant field, enter a value.
8. Save and activate your changes.

9.4.3.20 Configure A Default Set Parameter Using Transformations

Overview
You can use a transformation to calculate the value of a default set parameter.
Different default sets are listed under a query.
For example, in the Contracts OWL, the Show drop down list has entries such as Contracts in Preparation, and
Released Contracts. These are the default sets under a query and are used to display a filtered set of contracts. You
can create a query and default sets under that query. These default sets are then added to the drop down list.
For more information, see Transformations [page 624].
You can have two types of transformations to calculate default set parameters:

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 647
 ● An example of the first type would be a transformation where no input parameters are needed. The
transformation calculates the value needed using the login ID (sy-uname) and the identity UUID is the
output.
● An example for the second type would be a transformation where the input parameters can only be constants
0 or 1 and the output is placed in the Low Value field of the Default set parameter row.

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. Add a data field, as follows:
a. On the Data Model tab, right-click on Root and then add a data structure.
b. Right-click on the structure and then add a data field.
3. Configure a query, as follows:
a. On the Controller tab, right-click on Queries and then choose Add Query.
b. In the Query Configuration, select the required Namespace and BO.
The queries modeled under the BO are displayed in a hierarchical manner. Expand the query node in
the tree to show all the query parameters.
c. Select the required query and click Bind.
d. Add the query Parameters and select the data field that you created as the required Value.
4. Configure the default set for the query, as follows:
a. Right-click on the query and then choose Add Default Set.
b. To rename the default set, right-click on the default set and then choose Rename.
c. In the Default Set Configuration, enter a Title for the default set. This value is displayed in the Show
field.
d. Select the query parameter that you have added and click Add Option.
e. In the new row that appears, under Transformation click ….
f. In the Configure Field Transformation dialog box, select the Namespace.
g. Under Transformation, select the type of transformation rule you want to use.
The parameters for that transformation rule are displayed. Each parameter section displays the
parameter name and an indication if it is a mandatory field.
Each parameter can be configured by assigning a constant value to it.
For some transformation rules, there is no provision for entering input parameters.
h. In the Constant field, enter the value of the constant.

5. Save and activate your changes.

9.4.3.21 Add a Report List View to a Work Center

Overview
You need to assign standard report list views, for example the List and Gallery standard reports list views, to a work
center in the user interface designer.
In the customer's production system (SAP cloud solution), an Analytics administrator assigns the report to the work
center view to make it available for business users.

SAP Cloud Applications Studio – Version May 2018 (1805)

648 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 Only SAP cloud solution administrators working in a customer's production system can assign a report that
you have created to a work center view. To assign a report to a work center view, the solution that contains
the report must therefore be implemented in the customer's production system.
We recommend that you provide information about the work center views to which customers need to assign
reports in your Solution Documentation. For more information, see Documentation Types in Cloud Solutions
from SAP [page 709].

Procedure
1. In the studio, double-click the required work center in the Solution Explorer.
The work center opens in the user interface designer.
2. On the Designer tab, right-click on BusinessObject and select WorkCenterItem.
3. In the Properties Explorer, under Misc-ViewSwitches click ….
4. In the ViewSwitch Collection Editor dialog box, do the following:
a. Click Add to add a new view.
b. Select the newly added view.
c. In the Properties Explorer, under Misc-SubViewSwitches, click ….
The SubViewSwitch Collection Editor dialog box opens.
5. In the SubViewSwitch Collection Editor dialog box do the following:
a. Click Add twice to add two new subviews.
b. Click OK.
6. In the ViewSwitch Collection Editor dialog box, click OK.
7. On the Designer tab, select WorkCenterView.
8. Under WorkCenterView Views, select the first WorkCenterSubView that you added.
9. In the Configuration Explorer, navigate to SAP_BYD_TF Analytics AnalysisPattern
ana_reports_view_wc.WCVIEW.uiwocview .
10. Drag and drop this work center view onto the Designer tab.
11. In the dialog box that opens, click Yes to overwrite the work center view floorplan title with the view switch
name.
12. Under WorkCenterView Views, select the second WorkCenterSubView that you added.
13. In the Configuration Explorer, navigate to SAP_BYD_TF Analytics AnalysisPattern
ana_reports_carousel_view.WCVIEW.uiwocview .
14. Drag and drop this work center view onto the Designer tab.
15. In the dialog box that opens, click Yes to overwrite the work center view floorplan title with the view switch
name.
16. On the Designer tab, select WorkCenterView.
17. In the Properties Explorer, under Misc-Text click the arrow button.
18. In the Dependent Property Editor dialog box, do the following:
a. Change the text in the Overridden Text field to Reports.
b. Click OK.
19. Save and activate your changes.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 649
See Also
Create a Report [page 460]

9.4.3.22 Define an Anchor for a Floorplan

Overview
You can define anchors for your floorplans to allow end users to make changes to the floorplans provided by you.

Procedure
1. In the studio, double-click the required floorplan in the Solution Explorer.
The floorplan opens in the user interface designer.
2. Select the region in floorplan for which you want to define the anchor.
For example, you can define the anchor for the floorplan as a whole or for a section group, pane container,
outport, and so on.
3. In the Properties Explorer, under Extensibility–Anchors, click ....
4. In the Anchor Modelling dialog box, click + to add an anchor.
5. Click OK.
6. Save and activate your changes.

You can view the anchors you have added only in the display mode.

9.4.3.23 Map a Message

Overview
You can map a message in order to change the terminology in messages appearing on the UI or to change their
behavior on the UI. For more information see Message Mapping [page 650].

Procedure
1. In the Solution Explorer, click on the UI component and choose Open in UI Designer.
The UI Designer opens with the selected UI component in a new window.
2. On the Controller tab, select Messages –> System Messages.
The Messages Editor opens.
3. Select Add Messages.
A new line in the Message Mappings Editor is displayed.
4. For the new message text that you want to be displayed on the UI instead of the original text do the following:

SAP Cloud Applications Studio – Version May 2018 (1805)

650 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 a. In the Message Key column enter a key for the new message, instead of <MESSAGETEX>. The message
key consists of alphanumeric characters.
b. In the Message Text column enter the new message text for <message text>.
5. Save and activate your changes
6. Select Messages –> Message Mapping.
The Message Mapping Editor opens.
7. Select Add Messages and in the first free line of the Messages Editor select ... to look for the message that
you want to replace on the UI.
A new window opens listing all the messages that are associated with the UI component.
8. Select the message that you want to replace and choose OK.
The window closes and the message that you want to replace is displayed as a new line in the Message
Mappings Editor.
9. In the Message Mappings Editor, select the rule that you want to apply in your message mapping.
● To replace an original message with a new message, select Replace.
● To keep the original message without any change, select Original.
● To combine two or more original messages into one new single message, select Aggregate for each
original message and select the same message key for each of them in the field New Message Key.
.
● To prevent a message from being shown on the UI during runtime, select Ignore.

To show different mapped messages based on parameter values in one original message, proceed as
follows:
In the Details section of the Message Mappings Editor, in the field Message Parameter, select the
parameter and in the field Parameter Value, enter the parameter value that you want the mapping to
be based on.

10. On the Details screen in the field New Message Text, select the message text that you want to appear instead
of the original message text.

If you want to aggregate two or more original messages, make sure that always select the same new
message for those original messages.

11. Save and activate your changes.

9.5 Modify an SAP Floorplan

9.5.1 Change Transactions Quick Guide

This document gives you an overview of the changes you can make to SAP floorplans in the studio. These changes
are termed as change transactions and need anchors to be executed.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 651
Business and technical background

Change Transactions
Change transactions allow you to make changes to SAP delivered floorplans in the studio. You can create, save, and
publish the change transactions using the Extensibility Explorer of the user interface designer, which is integrated
into the studio.
Change transactions can only be made to SAP floorplans that contain stable anchors. For more information, see
Anchors [page 654].
For more information, see here [page 654].

Anchors
Anchors are stable extension points to which any user interface modifications that you make to SAP floorplans are
attached. This prevents life-cycle issues during updates or upgrades to the user interface. You can also add anchors
to your own floorplans.
For more information, see here [page 654].

Tasks

Add a View to a Work Center

You can add a view to an SAP work center.
For more information, see here [page 656].

Hide a View from a Work Center

You can hide a view that is no longer required from an SAP work center.
For more information, see here [page 656].

Add an Assigned Object to a View

You can assign an object, for example, a navigation target or user interface component, to an SAP work center view.
For more information, see here [page 657].

Remove an Assigned Object from a View

You can remove unwanted objects from an SAP work center view.
For more information, see here [page 658].

Add an Embedded Component to an Overview View

You can add an embedded component such as an embedded report (ICP) to an SAP work center view of type
"Overview".
For more information, see here [page 658].

Add an Embedded Component to a Floorplan

You can add an embedded component to an SAP floorplan.
For more information, see here [page 659].

SAP Cloud Applications Studio – Version May 2018 (1805)

652 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
Add an Embedded Component to a New Tab in a Floorplan
You can add an embedded component to a new tab in an SAP floorplan.
For more information, see here [page 660].

Add an Extension Field to a Screen

You can add an extension field to a screen. For more information see here [page 383].

Add an Extension Field to the Enterprise Search

You can add an extension field to the enterprise search. For more information see here [page 388].

Remove a Button
You can remove a button or navigational item from an SAP floorplan.
For more information, see here [page 661].

Modify the Order of Work Centers

You can modify the order in which the work centers are displayed in the UI Settings XML file.
For more information, see here [page 661].

Add a User Interface Dependency

User Interface (UI) dependencies govern the assignment of views to a user. Three types of dependencies between
views can be maintained.
For more information, see here [page 662].

Save and Activate your Change Transactions

After you have made any of the changes listed above, you have to save and activate the change transactions.
1. Make your changes and then click Apply/Add.
A list of unsaved change transactions is displayed in the Unsaved Change Transactions section of the
Extensibility Explorer.
2. From the File menu, choose Save.
A list of saved change transactions is displayed in the Saved Change Transactions section of the Extensibility
Explorer.
3. From the File menu, choose Activate.
In the Activate Worklist dialog box, select the check boxes beside the relevant components and click OK.
The change transactions are activated and displayed in the Published Change Transactions section of the
Extensibility Explorer.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 653
9.5.2 Business and Technical Background

9.5.2.1 Change Transactions

Overview
Change transactions allow you to make changes to SAP delivered floorplans in the studio. You can create, save, and
publish the change transactions using the Extensibility Explorer of the user interface designer, which is integrated
into the studio.
Change transactions can only be made to SAP floorplans that contain stable anchors. For more information, see
Anchors [page 654].
When you create change transactions they are stored in the associated solutions created by you.
You can use a change transaction to add a view to a work center delivered by SAP. For example, you can add a new
view to the Liquidity Management work center (CashLiquidityManagement_WCF).

9.5.2.2 Anchors

Overview
Anchors are stable extension points to which any user interface modifications that you make to SAP floorplans are
attached. This prevents life-cycle issues during updates or upgrades to the user interface. You can also add anchors
to your own floorplans.
Any user interface adaptations made by you, as an SAP partner, to SAP floorplans, are retained unchanged in future
releases even after the upgrades provided by SAP due to the presence of anchors.

Features
A stable anchor has a system-wide unique ID and a reference entity. All stable anchors created during a particular
release will also exist in later releases.
Anchors are essential when making changes to a floorplan that is from a layer lower than the layer you are working
on. You can only view the anchors added in a lower layer. For example, when you are working on a SAP floorplan you
can view the anchors provided by SAP. You can view the anchors added by you only when a floorplan is opened in
the display mode.
Stable anchors in the floorplans are defined for a logical set of fields placed on the user interface, for example a
section group or a list.

Use
All change transactions can only be applied if there is a stable anchor defined on the SAP floorplan.

Requirement Required anchor Link to document

SAP Cloud Applications Studio – Version May 2018 (1805)

654 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 Add a View to a WoCViewSwitchAnchor Add a View to a Work Center [page 656]
Work Center

Hide a View From a WoCViewSwitchAnchor Hide a View from a Work Center [page 656]
Work Center

Add an Assigned AssignedObjectAnchor Add an Assigned Object to View [page 657]

Object to View

Remove an AssignedObjectAnchor Remove an Assigned Object from View [page 658]

Assigned Object
from View

Add an Embedded OverviewPageAnchor Add an Embedded Component to an Overview View

Component to an [page 658]
Overview Page

Add an Embedded OutportAnchor and Add an Embedded Component to a Floorplan [page 659]
Component to a PaneContainerAnchor
Floorplan

Add an Embedded PaneContainer Anchor or Add an Embedded Component to a New Tab in a Floorplan
Component to a ViewSwitchNavigationAnchor or [page 660]
New Tab in a TabStripAnchor
Floorplan

Remove a Button ButtonGroupAnchor Remove a Button [page 661]

Modify the Order Of WorkCenterListAnchor Modify the Order of Work Centers [page 661]
Work Centers

Adding a User UIDependecyAnchor Add a User Interface Dependency [page 662]

Interface
Dependency

Add a Mashup to a OutportAnchor Add a Mashup to Your Floorplan [page 513]

Floorplan FloorPlanAnchor.
OverviewPageAnchor

See Also
Define an Anchor for a Floorplan [page 650]

9.5.2.3 Flexible UI

Overview
In the SAP cloud solutions, a UI is modeled generically and not for a specific user or specific user groups, therefore
it looks the same for all users of a solution. Sometimes it might be necessary to simplify or reduce the appearance
of a view at runtime so that it shows, for example, fewer fields or sections depending on which user or user group is
working with a UI. UI switches in the UI designer allow to hide or restrict the usage of fields on one or more UIs. Note
that you can use UI switches only to restrict the usage or appearance of fields on a UI that has been developed by
SAP. You cannot use UI switches, for example, to change read-only fields into fields that can be edited.
For more information see Create a Role-Based Flexible UI Using a UI Switch [page 666].
It is also possible to change the behavior of fields depending on the status of other fields.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 655
For more information see Example: Create a Status-Based Flexible UI [page 664].

9.5.3 Tasks

9.5.3.1 Add a View to a Work Center

Overview
You can add a view to an SAP work center.

Prerequisites
The SAP work center to which you want to add a view has a WoCViewSwitchAnchor. For more information, see
Anchors [page 654].

Procedure
1. In the studio, open the user interface designer.
2. In the Configuration Explorer, navigate to the work center where you want to add the view.
3. Double-click the work center.
4. In the Extensibility Explorer, select WoCViewSwitchAnchor.
5. Click Add and then choose AddWoCView.
6. In the Add Work Center View dialog box, click Target Component to select the required view. You can only
select components of type uiwocview (work center view) and subtype Application.
7. Select the required position:
● Top places the new view as the first view in the work center. If an Overview view exists in the work
center, then the new view is positioned after the Overview view.
● Bottom places the new view as the last view in the work center. If a Reports view exists, then the new
view is positioned before the Reports view.
8. If you want to control the scope dependency of the view in the work center, click Add Scoping Rules.
9. In the Scope Rules Editor dialog box, choose the scoping rule from the list on the left and use the arrow buttons
to move it to the list on the right.
10. Click OK, to apply your changes to the view.
11. Click Apply.
12. Save and activate your changes.

9.5.3.2 Hide a View from a Work Center

Overview
You can hide a view that is no longer required from an SAP work center.

SAP Cloud Applications Studio – Version May 2018 (1805)

656 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
Prerequisites
● The work center has a WoCViewSwitchAnchor.
For more information, see Anchors [page 654].

Procedure
1. In the studio, open the user interface designer.
2. In the Configuration Explorer, navigate to the work center in which you want to hide a view.
3. Double-click the work center.
4. In the Extensibility Explorer, select WoCViewSwitchAnchor.
5. Click Add and then choose HideWoCView.
6. In the Hide Work Center View dialog box, select the title of the view you want to hide.
7. Click Apply.
8. Save and activate your changes.

9.5.3.3 Add an Assigned Object to a View

Overview
You can assign an object, for example, a navigation target or user interface component, to an SAP work center view.

Prerequisites
The SAP work center view, to which you want to assign an object, has an AssignedObjectAnchor.
For more information see, Anchors [page 654].

Procedure
1. In the studio, open the user interface designer.
2. In the Configuration Explorer, navigate to the work center view where you want to assign the object.
3. Double-click the work center view.
4. In the Extensibility Explorer, select AssignedObjectAnchor.
5. Click Add and then choose AddAssignedObjectToView.
6. In the Add Assigned Object dialog box, select the type of object you want to assign.
7. Click Target Component to select the object.
8. Depending on the type of assigned object, you have the following options:
● If the assigned object is of type Navigation Target, you can add scoping rules:
1. Click Add Scoping Rules.
2. In the Scope Rules Editor dialog box, choose the scoping rule from the list on the left.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 657
 3. Use the arrow buttons to move the selected scoping rule to the list on the right. Click OK to apply
your changes.
● If the assigned object is an object work list, then you can mark the view as Expose to Overview. The
object work list will then be visible in the Overview view.
9. Click Apply.
10. Save and activate your changes.

9.5.3.4 Remove an Assigned Object from a View

Overview
You can remove unwanted objects from an SAP work center view.

Prerequisites
The work center view has an AssignedObjectAnchor.
For more information, see Anchors [page 654].

Procedure
1. In the studio, open the user interface designer.
2. In the Configuration Explorer, navigate to the work center view in which you want to remove an assigned object.
3. Double-click the work center view.
4. In the Extensibility Explorer, select AssignedObjectAnchor.
5. Click Add and then choose RemoveAssignedObjectToView.
6. In the Remove Assigned Object dialog box, select the object you want to remove.
7. Click Apply.
8. Save and activate your changes.

9.5.3.5 Add an Embedded Component to an Overview View

Overview
You can add an embedded component such as an embedded report (ICP) to an SAP work center view of type
"Overview".

Procedure
1. In the studio, open the user interface designer.
2. In the Configuration Explorer, navigate to the Overview view where you want to add an embedded component.
3. Double-click the floorplan.
4. In the Extensibility Explorer, select the OverviewPageAnchor.
5. Click Add and then choose AddContenttoOverview.

SAP Cloud Applications Studio – Version May 2018 (1805)

658 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 6. In the Add Component dialog box, do the following:
a. Select the floorplan type, for example, an object work list.
b. Click ... under Component and select the floorplan.

If you select the floorplan type as ICP, select the required report.

c. Select the required Title, Position and Alignment of the embedded component.
7. If the embedded component is of the generic type ICP, you have to select the parameters associated with the
ICP under the option View.
8. Click Add.
9. Save and activate your changes.

9.5.3.6 Add an Embedded Component to a Floorplan

Overview
You can add an embedded component to an SAP floorplan. You can add the embedded component to either an
OutportAnchor or a PaneContainerAnchor.

Prerequisites
● The floorplan has an OutportAnchor.
For more information, see Anchors [page 654].
● The floorplan has a PaneContainerAnchor.
The embedded component (EC) will be placed behind the pane container.
● The embedded component has an inport.
The RequestAutoRefire and RequestFireOnInitialization properties of the embedded component are set to
True.

Procedure
1. In the studio, open the user interface designer.
2. In the Configuration Explorer, navigate to the floorplan in which you want to add an embedded component.
3. Double-click the floorplan.
4. In the Extensibility Explorer, do one of the following:
● To add the embedded component to an OutportAnchor:
a. Select the OutportAnchor, click Add and then choose Add Embedded Component.

The outport selected has an OutportAnchor and the PaneContainerAnchor set as the
referenced anchor.

b. In the Add Embedded Component dialog box, click Select Embedded Component and select the
required embedded component.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 659
 c. In the Add Embedded Component dialog box, if the referenced pane container for which the
PaneContainerAnchor has been defined, contains a tab strip, you can enter a Tab Title.
1. At runtime, a new tab is created with this title, and the embedded component appears in the
tab.
2. If the referenced pane container does not contain a tab strip, the embedded component
appears in a new row below the referenced pane container.
d. Click Define Mapping and select the inport of the embedded component.
e. If the inport has any parameters, map the parameters.
f. If the embedded component is of the generic type ICP, you are prompted to provide a title for the
ICP.
● To add the embedded component to a PaneContainerAnchor:
a. Select the PaneContainerAnchor, click Add and then choose Add Embedded Component.
b. In the Add Embedded Component dialog box, if the referenced pane container, for which the
PaneContainerAnchor has been defined, contains a tab strip, you can enter a Tab Title.
1. At runtime, a new tab is created with this title, and the embedded component appears in the
tab.
2. If the referenced pane container does not contain a tab strip, the embedded component
appears in a new row below the referenced pane container.
c. Click Select Embedded Component and select the required embedded component.
d. If you want to bind the embedded component to the floorplan, click Bind.
e. In the dialog box that opens, select the outport and inport for the embedded component. The
outport selected has an OutportAnchor.
5. Click Apply.
6. Save and activate your changes.

9.5.3.7 Add an Embedded Component to a New Tab in a Floorplan

Overview
You can add an embedded component to a new tab in an SAP floorplan.

Prerequisites
● The floorplan has either the ViewSwitchNavigationAnchor or the TabStripAnchor.
For more information, see Anchors [page 654].
● The embedded component has an inport.

Procedure
1. In the studio, open the user interface designer.
2. In the Configuration Explorer, navigate to the floorplan in which you want to add an embedded component.
3. Double-click the floorplan.
4. In the Extensibility Explorer, select the ViewSwitchNavigationAnchor or the TabStripAnchor.
5. Click Add and then choose Add Embedded Component.

SAP Cloud Applications Studio – Version May 2018 (1805)

660 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 6. In the Add Embedded Component dialog box, enter a Tab Title.
7. Click Select Embedded Component and select the required embedded component.
8. If you want to bind the embedded component to the floorplan, click Bind.
9. In the dialog box that opens, select the outport and inport for the embedded component. The outport selected
has an OutportAnchor associated with it.
10. Click Apply.
11. Save and activate your changes.

9.5.3.8 Remove a Button

Overview
You can remove a button or navigational item from an SAP floorplan.

Prerequisites
The SAP floorplan from which you want to remove a button or navigational item has a ButtonGroupAnchor.
For more information, see Anchors [page 654].

Procedure
1. In the studio, open the user interface designer.
2. In the Configuration Explorer navigate to the required floorplan.
3. Double-click the floorplan.
4. Select a button group in the floorplan.
5. In the Extensibility Explorer, select the ButtonGroupAnchor.
6. Click Add and then choose RemoveButton.
7. In the Remove Button dialog box, select a button or navigational item that you want to remove from the
floorplan.
If the button or navigational item cannot be removed, the Apply button is disabled.

The removal of mandatory buttons like Cancel, Close, and Print is restricted.

8. Click Apply.
9. Save and activate your changes.

9.5.3.9 Modify the Order of Work Centers

Overview
You can modify the order in which the work centers are displayed in the UI Settings XML file, the path to which is
given below.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 661
Prerequisites
The UI Settings file has a WorkCenterListAnchor.
For more information, see Anchors [page 654].

Procedure
1. In the studio, open the user interface designer.
2. In the Configuration Explorer, go to SAP_BYD_UI_CCOW Main root uisetting .
3. Double-click the file.
4. In the Extensibility Explorer, select the WorkCenterListAnchor.
5. Click Add and then choose WorkCenterReordering.
6. You can do the following in the Work Center Reordering dialog box:
● Add work centers to the list of Ordered WorkCenters.
○ Select the required work center from the list of Unordered WorkCenters and use the right arrow
button to add the work center to the list of Ordered WorkCenters.
The required work center is added to the list of Ordered WorkCenters, below a work center
selected in the list.
● Remove work centers from the list of Ordered WorkCenters.
○ Select the required work center from the list of Ordered WorkCenters and use the left arrow button
to move the work center to the list of Unordered WorkCenters.
● Change the position of the work center.
○ Select a work center and use the up and down arrow buttons to change its position in the list of
Ordered WorkCenters.
○ To place the selected work center at the top of the list of Ordered WorkCenters click Top.
○ To place the selected work center at the bottom of the list of Ordered WorkCenters click
Bottom.
7. Click Apply.
8. Save and activate your changes.

9.5.3.10 Add a User Interface Dependency

Overview
User interface (UI) dependencies govern the assignment of views to a user. Three types of dependencies between
views can be maintained.

Types of Dependencies

Dependency Description

Prerequisite Ensures that if one work center view is assigned to a user, then the other work center
view in the dependency is automatically assigned to the user.

SAP Cloud Applications Studio – Version May 2018 (1805)

662 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 Technical Conflict Ensures that the user is not assigned two work center views that conflict with each other
from a technical point of view. When there is a technical conflict, an error message is
displayed and assignment of views is not allowed . For example, if both the Postings and
Master Data views of the Fixed Assets workcenter are assigned to a user, then an error
message appears and the assignment is not carried out.

SoD Conflict (Segregation of Duty) Ensures that the user is not assigned two views (chosen while defining the dependency)
that conflict with each other from a best practice point of view. For example, if the user
has two views assigned that enable the user to both place an order and to approve the
order. These functions should be performed by different users. When a user assignment
generates a SoD conflict, a warning message is displayed .

These user interface dependencies will govern the assignment of views in the User and Access management view.
For more information, see the relevant documentation in the SAP cloud solution.
The existing dependencies are listed in the UIDependency XML file, the path to which is given below.

Prerequisites
The UIDependency XML file has a UIDependencyAnchor.
For more information, see Anchors [page 654].

Procedure
1. In the studio, open the user interface designer.
2. In the Configuration Explorer, go to SAP_BYD_UI_CCOW Main root uidependency .
3. Double-click the UIDependency XML file.
4. In the Extensibility Explorer, select the UIDependencyAnchor.
5. Click Add and then choose UI Dependency.
6. You can add three kinds of UI dependencies: Prerequisite, Technical Conflict , and SoD Conflict.
● If you want to add a prerequisite dependency:
a. In the UI Dependency dialog box, click the Prerequisites tab.
b. Click + to add a new prerequisite.
c. Select the desired views for Target Partner WoC View and Prerequisite WoC View.
● If you want to add a technical conflict dependency:
a. In the UI Dependency dialog box, click the Technical Conflict tab.
b. Click + to add a new technical conflict.
c. Select the desired views for Target Partner WoC View and Technical Conflicting WoC View .
d. In the Reason field, enter the reason why a user should not be assigned both views at the same
time.
● If you want to add a SoD conflict dependency:
a. In the UI Dependency dialog box, click the SoD Conflict tab.
b. Click + to add a new SoD conflict.
c. Select the desired views for Target Partner WoC View and SoD Conflicting WoC View .

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 663
 d. In the Reason field, enter the reason why a user should not be assigned both views at the same
time.
e. In the Resolution field, enter the solution to the issue.
7. Click Apply.
8. Save and activate your changes.

9.5.3.11 Example: Create a Status-Based Flexible UI

Overview
The following section provides a detailed example of how to create a business object extension of the business object
Opportunity and the corresponding UI that shows an additional field depending on the status of the field value.
In the example, the business object extension contains the additional field Reason Text, which is shown on the UI
when an opportunity exceeds a certain value. The user must enter a text in the field Reason Text in order to be
able to save the opportunity. If the user does not enter anything in the field and tries to save the opportunity, the UI
displays an error message and the user cannot save the opportunity. If the value of the opportunity is below the
stated threshold, the field Reason Text is not displayed on the UI.

Prerequisites
You have created a solution.

Procedure
1. In the Solution Explorer, expand your solution, right-click your project file, and select Add New Item .
The Add New Item dialog appears.
2. Select Business Object Extension.
3. Enter a Name for your business object extension, in our example it is OpportunityExtension and click
Add.

You cannot use a name that is already used for a business object or business object extension in your
solution.

The Business Object Selection dialog appears.

4. Select the namespace, in our example http://sap.com/xi/AP/CRM/Global, the business object that you
want to extend, in our example, Opportunity, and select OK.
The business object extension item with the name OpportunityExtension.xbo is added to your project.
This file contains a template for the business object extension, including the extendable nodes.
5. In the Solution Explorer, double-click the business object extension to open the file in the editing pane.
6. Enter the required coding in the business object extension. In our example, the coding consists of an element
Reason, an element IsBig, which serves as an indicator, and a message that is displayed on the UI, when a
certain value of an opportunity is exceeded.
import AP.Common.GDT;
import AP.CRM.Global;
[Extension] businessobject AP.CRM.Global:Opportunity

SAP Cloud Applications Studio – Version May 2018 (1805)

664 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 raises MessageEnterReason
{

// You must activate this business object before you can access the extension
fields
// or messages in script files, forms, and screens.

message MessageEnterReason text "Enter reason for 'big' opportunity";

[Label("Reason text")] element Reason : LANGUAGEINDEPENDENT_EXTENDED_Text;
element IsBig : Indicator;
node Item {
}
node Party {
}
}
7. Save and activate the business object extension.
8. In the Solution Explorer, right-click the business object extension and select Create Script Files.
The Create Script Files dialog window opens.
9. Scroll to the SalesForecast node, in the Create column, set the checkbox for Event:AfterModify, and
click OK.
The Event-AfterModify.absl object is created and listed in the Solution Explorer.
10. Enter the necessary ABSL coding. In our example, the threshold for the opportunity value is 100000.
import ABSL;
if (this.ExpectedRevenueAmount.content > 100000) {
this.ToRoot.IsBig = true;
}
else {
this.ToRoot.IsBig = false;
}
11. In the Solution Explorer, double-click the Event-AfterModify.absl to open the file in the editing pane.
12. Enter the necessary ABSL coding. In our example, the threshold for the opportunity value is 100000.
import ABSL;
if (this.ExpectedRevenueAmount.content > 100000) {
this.ToRoot.IsBig = true;
}
else {
this.ToRoot.IsBig = false;
}
13. Save and activate your changes.
14. In the Solution Explorer, right-click the business object extension and select Enhance Screen.
The Enhance Screen dialog window opens.
15. Select the required floorplan, in our example, the COD_Opportunity_TI and select OK.
The .xuicomponent file is created and added to your solution.
16. In the Solution Explorer, right click the .xuicomponent and select Open in UI Designer.
17. Select the header, in this example the second header, and in the Extensibility Explorer, select Add Extension
Field to Section Group.
The Add Extension Field dialog window opens.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 665
 18. In the Add column, select the Reason text and select e Apply. Save and Activate your changes.
The field Reason Text in now visible on the UI.
Save and activate your changes.
19. Select the second header again, and in the Extensibility Explorer, select Adjust Properties.
The Adjust Properties dialog window opens.
20. Select the Reason text control and in the Visible column, select Bound.
The BO Field Selector dialog window opens.
21. In the BO Field Selector dialog, select IsBig and click OK. The dialog window closes.
22. In the Adjust Properties dialog window, select the Reason text control again and in the Mandatory column,
select Bound.
23. The BO Field Selector dialog window opens.
24. In the BO Field Selector dialog window, select IsBig and click OK.
The BO Field Selector dialog window closes.
In the Adjust Properties dialog window, select Apply. Save and activate your changes.
25. In the Solution Explorer, right-click the business object extension and select Create Script Files.
The Create Script Files dialog window opens.
26. Scroll to the Root node, in the Create column, set the checkbox for Validation:OnSave, and click OK.
The Validation—OnSave.absl object is created and added to your solution.
27. In the Solution Explorer, double-click the Validation-OnSave.absl file to open it in the editing pane and
enter the following coding:
if (this.SalesForecast.ExpectedRevenueAmount.content > 100000 &&
this.Reason.IsInitial()) {
raise MessageEnterReason.Create("E");
return false;

}
else {
return true;
Save and activate your changes.

9.5.3.12 Create a Role-Based Flexible UI Using a UI Switch

Overview
In the UI designer it is possible to hide or display extension or standard fields on the UI. It is also possible to make
them read-only or mandatory depending on your requirements. To do this, you can create an UI switch in the studio.

With an UI switch you can make the fields on the UIs provided by SAP more restrictive, but you cannot make
them less restrictive.

Prerequisites
You have created a solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

666 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
If you want to hide or display extension fields on the UI depending on the role that is assigned to a user, you have
created a business object extension and the fields that you require. You have added those fields to the section of the
UI where you want them to be shown.

Procedure
1. In the Solution Explorer, expand your solution, right-click your project file, and select Add New Item .
The Add New Item dialog appears.
2. Select UI Switch.
3. Enter a Name for the UI switch and click Add.

You cannot use a name that is already used for a UI switch in your solution.

The UI Switch Description dialog window appears.

4. Enter a description for the UI switch and select OK.
The UI switch is added to your project.
5. In the Solution Explorer, double-click the UI component where you want to use the UI switch to, for example,
hide or display fields based on a role.
The UI component opens in the UI designer.
6. In the Extensibility Explorer, select the entity of the UI where you want to, for example, hide or display fields
and select Adjust Properties.
The Adjust Properties dialog window opens.
7. In the Adjust Properties dialog window, you have the following options:
● If your settings are to apply to all roles that the UI switch is assigned to, for the UI Switch select
Equal and the UI switch that you have created.
● If your settings are to apply to all roles that the UI switch is not assigned to, for the UI Switch select
Not Equal and the UI switch that you have created.
● The following settings do not have any effect on how UI is displayed:
○ Equal and None

○ Not Equal and None

8. For any control on the UI, you have now the following options:
● Column Visible:
○ If you want the field and its behavior on the UI to be unchanged, select None
If you want to hide the field on the UI, select False.
If you want the field to be displayed depending on an indicator, select Bound and in the BO Field
Selector dialog window, the corresponding indicator.
If you want the field to be displayed in the case of a role that has 2 UI switches assigned, select
True.
● Column Mandatory:
○ If you want the field and its behavior on the UI to be unchanged, select None
If you want the field to be a mandatory field (that means, a field where the user has to enter
something), select True .

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 667
 If you set a field to be mandatory, this does not automatically prevent saving or any other
actions. It only marks the field as mandatory on the UI. In addition, you must create a
message in the BO extension file (.xbo) and raise the message in the related script coding
(Event-AfterModify.absl file or Validation-OnSave.absl file).

If you do not want the field to be a mandatory field, select False.

If you want the field to be mandatory depending on another field, select Bound and in the BO Field
Selector dialog window, the corresponding indicator.
○ Column Read Only:
If you want the field and its behavior on the UI to be unchanged, select None.
If you want the field to be read only, select True.
If you want the field not to be read-only, select False.
If you want the field to be read-only depending on another field, select Bound and in the BO Field
Selector dialog window, the corresponding indicator.
9. Select Apply.

To apply the UI switch to the UI, you have to assign it to a business role and assign this business role
to the users.
To read out the UI switches of a user, you can use the function
Context.GetCurrentUserUISwitches() in the script coding.

9.6 User Interface Modifications for Mobile Applications

9.6.1 Mobile Floorplans Quick Guide

This document gives you an overview of how you can adapt floorplans for use on mobile devices and the steps
involved in configuring navigation between floorplans.
For more information on creating the floorplans, see Generate Screens for a Business Object [page 370].

Business and Technical background

SAP’s User Interface Style Guide

You can learn how to build user interfaces according to this style guide.

Mobile Solutions
You can create solutions in the studio and make them available on mobile devices, such as the iPhone and Blackberry.
For more information, see Mobile Solutions [page 670].

Tasks

SAP Cloud Applications Studio – Version May 2018 (1805)

668 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
Modify an Object Work List for Use on a Mobile Device
You can modify an object work list (OWL) created for use on a mobile device.
For more information, see here [page 673].

Modify a Quick Activity for Use on a Mobile Device

You can modify a quick activity floorplan (QAF) created for use on a mobile device.
For more information, see here [page 674].

Modify a Fact Sheet for Use on a Mobile Device

You can modify an fact sheet (FS) created for use on a mobile device.
For more information, see here [page 676].

Configure a Fact Sheet for Use on a Mobile Device

You can configure a fact sheet (FS) so that you can navigate from an object work list (OWL) to a fact sheet rather
than navigating directly to a quick activity floorplan (QAF).
For more information, see here [page 677].

Assign a Mobile Fact Sheet to Work Center View

You can assign a mobile fact sheet to a work center view to make it visible in the work center view.
For more information, see here [page 678].

Create a Port to Navigate to a Mobile Fact Sheet

You can create a new port to facilitate navigation to a fact sheet for use on a mobile device.
For more information, see here [page 678].

Configure Navigation in a Mobile Fact Sheet

You can configure navigation in a fact sheet to facilitate the transfer of data between the fact sheet and a object work
list.
For more information, see here [page 679].

Configure Navigation in a Mobile Object Worklist

You can configure navigation in a object work list to facilitate data exchange to a fact sheet.
For more information, see here [page 679].

Configure Navigation Between a Mobile Fact Sheet and a Mobile Quick Activity
You can configure navigation between a fact sheet and a quick activity so that it is possible to transfer of data between
them.
For more information, see here [page 680].

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 669
9.6.2 Mobile Solutions

Overview
You can create solutions in the studio and make them available on mobile devices, such as the iPhone and BlackBerry.
The mobile solution is built using the same tools (the studio and UI designer) that you use for the browser application
of the SAP cloud solution. You just have to make sure that you build your mobile application according to the user
interface (UI) guidelines for mobile applications (for example, tables should not have more than three columns).

Supported Platforms
The mobile application is currently available for:
● Android
● Apple iPhone
● Apple iPad
● BlackBerry
● Windows Mobile
● Windows Phone 7

Device Tag
You can use the Device tag in the UI designer to specify on which devices a UI component can run. Possible values
are:
● Desktop
● Handheld - (Windows Mobile)
● Mobile - (iPhone, BlackBerry, Windows Phone 7)
● Tablet - (iPad and Android)
● All Devices

If no device tag is specified, the component is treated as having a Desktop device tag.
The following components can be tagged:
● work center views
● flooplans
● reusable components (such as an Object Value Selector)

You must consider the dependencies between floorplans when setting the Device tag. For example, you cannot set
a work center view (WCV) to Mobile if it has an embedded object work list (OWL) that is set to Desktop. In this case,
you would first have to set the OWL to Mobile, then set the WCV to Mobile.

Floorplan with Device tag Can use floorplan with Device tag

Desktop All Devices or Desktop or no device tag

Handheld All Devices or Handheld

Mobile All Devices or Mobile

SAP Cloud Applications Studio – Version May 2018 (1805)

670 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 Floorplan with Device tag Can use floorplan with Device tag

Tablet All Devices or Tablet

All Devices All Devices

no device tag All Devices or Desktop or no device tag

Device Cluster Tag

Where you have more than one view of a work center (for example, a desktop view and a mobile view), you can use
the Device Cluster tag in the UI designer to model the relationship between the views. You decide on one view that
is the “leading” view (usually the desktop view) and then associate the mobile device view with this leading view.
User assignment will only take place on the leading view. The view to render will be decided at runtime based on the
user client.
The leading work center view (WCV) has to have a ViewSubType of Application, InvisibleApplication, MyTasks or
Reports. You then create a Device Cluster and set the value to the Short Id of the WCV. To associate a mobile view,
you give it a ViewSubType of DeviceView and assign it to the same Device Cluster.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 671
The other possible value for the ViewSubType is InvisibleDeviceView. You would select this if you did not want the
view to be displayed on the UI, but wanted the view to serve as a carrier of authorizations only.

Mobile Scenarios
There are a number of scenarios to consider when developing a mobile solution.
● Mobile Only — SAP Business Objects
You can create a mobile solution, without a desktop variant, that displays a view of information that exists in
the SAP business objects (BOs). In this case, you could either create the screens individually from Solution
Explorer Add New Item Screens and then configure the navigation in the UI designer, or you could
create a blank BO, generate screens, and then edit the screens in the UI designer. If there is no desktop variant,
the ViewSubType of the WCV must be set to Application or InvisibleApplication (based on the use-case).
● Mobile Only — Partner Business Objects
In this case, you would generate the screens as normal in the SDK and configure the screens in the UI designer.
If there is no desktop variant, the ViewSubType of the WCV must be set to Application or InvisibleApplication
(based on the use-case).
● Mobile and Desktop Solution — Same Screens
In this case, you can set the device tag to All Devices for all of your screens.
● Mobile and Desktop Solution — Different Screens

SAP Cloud Applications Studio – Version May 2018 (1805)

672 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 In this case, you can create two sets of floorplans, one for desktop and one for mobile. You can then delete
the mobile WCF, create a Device Cluster with the Short Id of the desktop WCV, then add the mobile WCV to the
Device Cluster.

Testing your Mobile Solution

You can view the mobile variant of the SAP solution by appending &sapbyd-agent=mobile to the standard URL.
This will show you which work centers and floorplans are available. However, this will not give you a good idea of how
the UI will look on the mobile device, nor will it allow you to adequately test the functionality (such as tapping or
swiping the mobile device screen). Therefore, it is important to test on the mobile device that you are developing
for.
1. Develop your solution in the studio and make the work center view available to a mobile device.
2. In the SAP cloud solution, assign access rights to your business user so that they can access the new work
center.
3. Download and install the SAP cloud solution on your mobile device.
4. On the mobile device, enter the URL of the development system.
5. Log on to the SAP cloud solution on your mobile device and test your solution.

9.6.3 Tasks

9.6.3.1 Modify an Object Work List for Use on a Mobile Device

Overview
You can modify an object work list created for use on a mobile device, using the user interface designer, in the studio.

Prerequisites
● You have created and activated the business object (BO) and other components in the studio.
For more information, see Business Objects Quick Guide [page 346].
● You have created the object work list in the studio.
For more information, see Generate Screens for a Business Object [page 370].

Procedure
1. In the studio, double-click the object work list in the Solution Explorer.
The object work list opens in the user interface designer.
2. In the Properties Explorer, under Configuration-Tags click ….
3. In the Tags Editor dialog box, do the following:
a. Click Add Operation.
b. In the new row that appears:
● Under Attributes, select Device.
● Under Value, select Mobile.
c. Click OK.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 673
 4. On the Designer tab, select the first column of the object work list.
5. In the Properties Explorer, do the following:
a. Under Appearance- DisplayType, select Link.
b. Under Events- OnClickEvent, select Edit Handler.
6. On the Designer tab, in the toolbar, delete all the buttons except the New button.

The New button is linked to the + of the object work list on the mobile screen.

7. On the Designer tab, select the list.

8. In the Properties Explorer, under ChildElements-List columns click ... .
9. In the Columns Collection Editor dialog box , select all columns except the first, click Remove and then, click
OK.
10. In the dialog box that opens, click Yes to delete the data fields associated with the deleted columns.
11. In the Properties Explorer, under Appearance-ShowHeaderRow select False.
12. Save your changes.

Note that, for the use on mobile devices, you have to activate the user interface elements in the following
order:
1. Work center
2. Work center view
3. Floorplans

9.6.3.2 Modify a Quick Activity for Use on a Mobile Device

Overview
You can modify a quick activity floorplan created for use on a mobile device, using the user interface designer, in the
studio.

Prerequisites
● You have created and activated the business object (BO) and other components in the studio.
For more information, see Business Objects Quick Guide [page 346].
● You have created the quick activity in the studio.
For more information, see Generate Screens for a Business Object [page 370].

Modify a Quick Activity of a Business Object without Actions for Use on a Mobile Device
1. In the studio, double-click the quick activity floorplan in the Solution Explorer.
The quick activity floorplan opens in the user interface designer.
2. In the Properties Explorer, under Configuration-Tags click ….
3. In the Tags Editor dialog box , do the following:

SAP Cloud Applications Studio – Version May 2018 (1805)

674 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 a. Click Add Operation.
b. In the new row that appears:
● Under Attributes, select Device.
● Under Value, select Mobile.
c. Click OK.
4. On the Controller tab, under EventHandlers, rename the SaveHandler to SaveAndCloseHandler.
5. Under Configure the operation, change Action Type to SaveAndClose.
6. Save your changes.

Modify a Quick Activity of a Business Object with Actions for Use on a Mobile Device
1. In the studio, double-click the quick activity floorplan in the Solution Explorer.
The quick activity floorplan opens in the user interface designer.
2. In the Properties Explorer, under Configuration-Tags click ….
3. In the Tags Editor dialog box , do the following:
a. Click Add Operation.
b. In the new row that appears:
● Under Attributes, select Device.
● Under Value, select Mobile.
c. Click OK.
4. On the Designer tab, in the toolbar, delete all the buttons except the Close button.
5. Select the Close button, and in the Properties Explorer do the following:
a. Under Behavior-Enabled, select False.
b. Under Behavior-Visible, select False.
6. Select the contextual navigation region.
7. In the Properties Explorer, under Toolbar-Configure click ….
8. In the Configure Toolbar dialog box, do the following:
a. In the Available list of buttons, under ApplicationSpecific buttons select My Button.
b. Add My Button to the list of Current list of buttons using the right arrow button.
9. In the Properties Explorer, under MenuInformation-HasMenu select True.
10. In the Properties Explorer, under MenuInformation-SubMenu click ... .
11. The Button SubMenu Collection Editor dialog box opens.
12. To add a new navigational item to the button sub menu, click Add.
13. For each action that you want to be displayed on the mobile device, add one navigational item.
14. Select the first navigational item and in the Properties Explorer do the following:
a. Under Events-OnClick select SaveHandler.
b. Under Design-Title enter the title of the button as Save.
15. Select the second navigational item and in the Properties Explorer do the following:
a. Under Events-OnClick select Action<Name of Action in BO>Handler.
b. Under Design-Title enter the title of the button as <Name of Action>.
16. Repeat steps 15 and 16 for all other actions of the business object that you want to use.
17. Click OK.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 675
 18. In the Properties Explorer, under Text Information-Text enter the text Actions.
19. Save your changes.

Note that, for the use on mobile devices, you have to activate the user interface elements in the following
order:
1. Work center
2. Work center view
3. Floorplans

9.6.3.3 Modify a Fact Sheet for Use on a Mobile Device

Overview
You can modify a fact sheet created for use on a mobile device using the user interface designer in the studio.

Prerequisites
● You have created and activated the business object (BO) and other components in the studio.
For more information, see Business Objects Quick Guide [page 346].
● You have created a fact sheet in the studio.
For more information, see Generate Screens for a Business Object [page 370].

Procedure
1. In the studio, double-click the fact sheet in the Solution Explorer.
The fact sheet opens in the user interface designer.
2. In the Properties Explorer, under Configuration-Tags click ….
3. In the Tags Editor dialog box, do the following:
a. Click Add Operation.
b. In the new row that appears:
● Under Attributes, select Device.
● Under Value, select Mobile.
c. Click OK.
4. On the Designer tab, delete the View All button.
5. Select the Close button, and in the Properties Explorer do the following:
a. Under Behavior-Enabled, select False.
b. Under Behavior-Visible, select False.
6. Select the fields present in the pane container of the fact sheet, and for each, in the Properties Explorer,
under Appearance-DisplayType select Static text.
7. Delete the other pane containers in the fact sheet.
8. Select the section group and do the following:
a. Double-click the section group name.

SAP Cloud Applications Studio – Version May 2018 (1805)

676 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 b. In the Dependent Property Editor dialog box, clear the text used for SectionGroup Name.
c. Click OK.
9. Select the section group and in the Properties Explorer, under Text Information-Show Header select False.
10. Delete the extended identification regions (ExIdr) from the fact sheet.
11. Save your changes.

Note that, for the use on mobile devices, you have to activate the user interface elements in the following
order:
1. Work center
2. Work center view
3. Floorplans

9.6.3.4 Configure a Fact Sheet for Use on a Mobile Device

Overview
You can configure a fact sheet for use on a mobile device. For example, you can configure a fact sheet so that you
can navigate from an object work list to a fact sheet rather than navigating to a quick activity and then to a fact sheet .

Prerequisites
● You have created and activated the business object (BO) and other components in the studio.
For more information, see Business Objects Quick Guide [page 346].
● You have created the following in the studio:
○ Work center view
○ Port type package
○ Object work list
○ Quick activity floorplan
○ fact sheet

For more information, see Generate Screens for a Business Object [page 370].
● You have modified the fact sheet created for use on a mobile device, using the user interface designer, in the
studio.
For more information, see Modify a Fact Sheet for Use on a Mobile Device [page 676].

Process Flow
1. Assign the fact sheet to a work center view.
For more information, see Assign a Mobile Fact Sheet to a Work Center View [page 678].
2. Create a port to allow the transfer of data between the fact sheet and other floorplans.
For more information, see Create a Port to Navigate to a Mobile Fact Sheet [page 678].
3. Configure navigation in the mobile fact sheet to allow the transfer of data between the fact sheet and the
object work list.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 677
 For more information, see Configure Navigation in a Mobile Fact Sheet [page 679] and Configure Navigation
in a Mobile Object Work List [page 679].
4. Configure an event handler in the mobile fact sheet.
For more information, see Configure an Event Handler in a Mobile Fact Sheet [page 680].
5. Configure navigation between the mobile fact sheet and a mobile quick activity to allow the transfer of data
from the quick activity to the fact sheet.
For more information, see Configure Navigation between a Mobile Fact Sheet and a Mobile Quick Activity
[page 680].

9.6.3.5 Assign a Mobile Fact Sheet to a Work Center View

Overview
You can assign a fact sheet that has been modified for use on a mobile device to a work center view.

Procedure
1. In the studio, double-click the work center view in the Solution Explorer.
The work center view opens in the user interface designer.
2. In the Properties Explorer, under RBAM Data-AssignedObjects click … .
3. In the Add Assigned Objects dialog box, do the following:
a. Click Add to add a new assigned object.
b. In the new row, click … and select the fact sheet you have created from the list of repository items.
c. Click OK.
4. Save and activate your changes.

9.6.3.6 Create a Port to Navigate to a Mobile Fact Sheet

You can create a new port to facilitate navigation to a fact sheet for use on a mobile device.

Procedure
1. In the studio, double-click the port type package in the Solution Explorer.
The port type package opens in the UI designer.
2. Right-click the port type package and add a new port .
3. Rename the port as To_FS.
4. Save and activate your changes.

SAP Cloud Applications Studio – Version May 2018 (1805)

678 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
9.6.3.7 Configure Navigation in a Mobile Fact Sheet

Overview
You can configure navigation in a fact sheet to facilitate the transfer of data between the fact sheet and a object work
list.

Procedure
1. In the studio, double-click the mobile fact sheet in the Solution Explorer.
The fact sheet opens in the user interface designer.
2. On the DataModel tab, right-click on Root and add a new data field.
3. Rename the data field as Node ID.
4. On the Controller tab, right-click on Inports and add a new inport.
5. Under Inport Configuration do the following:
a. Select the port type package that you have created.
b. Set the port type reference to the port To_FS.
c. Add a parameter and bind it to the data field Node ID that you have created.
6. Save and activate your changes.

9.6.3.8 Configure Navigation In a Mobile Object Work List

Overview
You can configure navigation in a object work list to facilitate data exchange to a fact sheet.

Procedure
1. In the studio, double-click the object work list in the Solution Explorer.
The object work list opens in the user interface designer.
2. On the Controller tab, right-click on Outports and add a new outport.
3. Rename it as OutportToFS.
4. Under Outport Configuration do the following:
a. Select the port type package that you have created.
b. Set the port type reference to the port To_FS.
c. Add a parameter and bind it to the data field Node ID.

The parameter name should be the same in the fact sheet and the object work list.

5. On the Designer tab, select the column in the advanced list pane.
6. In the Properties Explorer, under Appearance-DisplayType select Link.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 679
 7. In the Properties Explorer, under Navigation Information-Navigation click ….
8. In the Model Navigation dialog box, do the following and click OK:
a. Click on Simple navigation.
b. Under Navigation Details, set the target as the fact sheet you have created.
c. Under Inport, choose the inport you created in the fact sheet.
d. Under Outport, choose the outport you created in the object work list.
e. Select the parameters under Outport Parameters and Inport Parameters and click Bind.
9. Save and activate your changes.

9.6.3.9 Configure an Event Handler in a Mobile Fact Sheet

Overview
You can configure an event handler in a fact sheet to display data from a quick activity.

Procedure
1. In the studio, double-click the fact sheet in the Solution Explorer.
The fact sheet opens in the user interface designer.
2. On the Controller tab, right-click on EventHandlers and add a new event handler.
3. Rename the event handler as ReadHandler.
4. For the ReadHandler, under ReadHandler : Operations, select the operation type BO Operation.
5. Set the BO Operation as Read.
6. Add a parameter, select nodeId as parameter type and bind it to the data field NodeId.
7. Bind the path of the parameter to the data field NodeId.
8. Select the inport you have created in the fact sheet.
9. In the Properties Explorer, under Events-OnFire select Readhandler.
10. Save and activate your changes.

9.6.3.10 Configure Navigation Between a Mobile Fact Sheet and a

Mobile Quick Activity

Overview
You can configure navigation between a fact sheet and a quick activity so that it is possible to transfer data between
them.

Procedure
1. In the studio, double-click the fact sheet in the Solution Explorer.
The fact sheet opens in the user interface designer.
2. On the Designer tab, select the Edit button.

SAP Cloud Applications Studio – Version May 2018 (1805)

680 © 2018 SAP SE. All rights reserved. • P U B L I C User Interface Designer
 3. In the Properties Explorer, under Misc-Name, rename the button as EditEH.
4. On the Controller tab, right-click on Outports and add a new outport.
5. Under Outport Configuration do the following:
a. Select the port type package that you have created.
b. Set the port type reference to the port To_<Floorplanname>_edit.
c. Add a parameter and bind it to the data field Node ID.
6. On the Designer tab, select the Edit button.
7. In the Properties Explorer, under MenuInformation-Navigation click ….
8. In the Model Navigation dialog box, do the following and click OK:
a. Click on Simple navigation.
b. Under Navigation Details, set the target as the quick activity you have created.
c. Under Inport, choose the inport OBNEditInport.
d. Under Outport, choose the outport you created in the fact sheet.
e. Change Style to inplace.
f. Select the parameters under Outport Parameters and Inport Parameters and click Bind.
9. On the Controller tab, rename the event handler generated by the simple navigation to EditEH.
10. Save and activate your changes.

SAP Cloud Applications Studio – Version May 2018 (1805)

User Interface Designer P U B L I C • © 2018 SAP SE. All rights reserved. 681
10 Style Guides and Reference Guides

10.1 Overview of Style Guides and Reference Guides

Style Guides and Reference Guides encompasses the following:

Check Out the Style Guides Check Out the Reference Guides

Style Guide for Writing System Message Texts [page 682] Reference Guide for Documentation of Cloud Solutions from
This style guide provides you with the standards and SAP [page 708]
guidelines for writing system messages to be displayed on the This reference guide provides an overview of the main
user interface (UI) of your solution. It also provides the reference documentation types specific to the SAP cloud
standards and guidelines for writing system messages that solution.
are relevant for SAP Support; these messages are not
displayed on the UI.
In addition, this style guide provides guidance on writing long-
text documents providing additional information to a system
message that helps the user to solve very complex error
situations. These long-text documents can be incorporated
into the Solution Documentation.

10.2 Style Guides

10.2.1 Style Guide for Writing System Message Texts

10.2.1.1 General Standards and Guidelines for Writing System

Message Texts

This style guide provides you with the standards and guidelines for writing system messages to be displayed on the
user interface (UI) of your solution. It also provides the standards and guidelines for writing system messages that
are relevant for SAP Support; these are not displayed on the UI.
In addition, this style guide provides guidance on writing long-text documents providing additional information to a
system message that helps the user to solve very complex error situations. These long-text documents can be
incorporated into the Solution Documentation.

Target Group
This style guide is aimed at solution partners and reseller partners, who develop solutions in the studio for SAP cloud
solutions.

SAP Cloud Applications Studio – Version May 2018 (1805)

682 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
Prerequisites
You are familiar with the following documents:
● User Interface Style Guide for Partners
● User Interface Style Guide
● Mobile Style Guide

Types of System Message Texts

System messages in an SAP cloud solution comprise the following message types:
● System message short texts
○ UI system message short texts
System messages written directly for the UI address the end user directly. They provide concrete
instructions on how to solve an error on the UI and contain terminology relevant to the SAP cloud solution.
○ Other system message short texts
System messages written for developers and SAP Support. These messages are not aimed at the end
user; they can be quite technical, describing the error situation and the reasons why an error occurred.
● Long-text documents with additional help to a UI system message short text.
For very complex error situations, where the user needs to be provided with detailed background information
about the error, a document can be written and provided as part of the solution documentation.

10.2.1.2 General Standards for Message Short Texts

Overview
This section of the style guide provides you with the general standards and guidelines for writing message short
texts.
Standard formulations for different categories of message short texts are contained in Standard Formulations for
Message Short Texts [page 686].

Content
1. Diagnose and describe the error.

For technical reasons, system messages are restricted to 73 characters. If there is not enough space,
for very complex error situations, where the user needs to be provided with detailed background
information about the error, a long text can be written and provided as part of the solution
documentation. For more information, see the section on General Standards and Guidelines for
Message Long Texts [page 701].

2. If possible, provide a reason for the error.

3. If required, provide instructions on how to solve the error.

● Correct: Currency missing

● Correct: Creation not possible, source object does not exist

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 683
Sentence Construction
1. Formulate simple messages that are easily understandable.
2. Use precise and unequivocal language. Provide a maximum of information in a minimum of space.

● Correct: Recipient supply planning area not active

● Incorrect: Recipient supply planning area has wrong status
Note: It is more precise to name the correct status.

3. Use sentence style.

Some of the messages that appear in application logs deviate from this standard. They are used as
headings (title case). For more information, see the section on Standards for Application Log Messages
[page 696].

4. Do not use a period or exclamation mark at the end of a message short text.
5. If the message text consists of two parts, separate them using a semicolon (;)

● Correct: Error during RFQ creation; submission deadline missing

● Incorrect: Error During RFQ Creation! Submission Deadline Missing.

6. Do not use an article at the start of a message.

● Correct: Hierarchy &1 already exists

● Incorrect: The hierarchy &1 already exists

7. Omit articles within the text unless this creates ambiguity.

● Correct: Buyer not authorized to display master data

● Incorrect: Buyer not authorized to display the master data

8. Use the tense that is appropriate to the context.

● Correct: Payment order creation failed

● Incorrect: Payment order creation fails
● Incorrect: Payment order creation will fail

Word Choice
1. Use terminology from the Public Solution Model for system messages that do not appear on the UI.

● Correct: RFQ request currency missing

● Incorrect: Sourcing request currency missing
Note: The business object is named RFQ Request. On the UI the term used is Sourcing
Request.

2. Use terminology from the SAP cloud solution for UI messages.

SAP Cloud Applications Studio – Version May 2018 (1805)

684 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
 ● Correct: Sourcing request currency missing
● Incorrect: RFQ request currency missing
Note: The business object is named RFQ Request. On the UI the term used is Sourcing
Request.

3. Avoid abbreviations wherever possible.

4. Do not use generic modeling terms such as type code.

● Correct: Operation of type &1 not permitted

● Incorrect: Operation category type code &1 not permitted

5. Do not use the word please.

● Correct: Activate the document

● Incorrect: Please activate the document

Special Characters and Placeholders

1. Do not use special formatting, for example, upper case letters for emphasis. In some languages, the use of
upper case can be construed as shouting.

● Correct: Error during customer invoice creation

● Incorrect: ERROR during customer invoice creation

2. Do not use quotation marks (“...”) to set off placeholders, statuses, or similar.
3. Do not use special characters such as angle brackets (<...>), dollar signs ($), or asterisks (*).
4. Use ampersands (&) only for variables. If you use more than one variable, number your variables (&1, &2, &3,
&4).
5. Do not write a message text that only consists of variables (for example, &1 &2 &3). Bear in mind that different
languages have different word order. A message short text that reads correctly in the source language may
be nonsensical in another language.
6. If a noun is preceded by a variable that is a placeholder for a cardinal number, do not set off the plural form
or the plural ending of noun and verb with parentheses (( … )) or a slash (/). Use only the plural form.

Adding the plural endings in parentheses or with a slash does not work with irregular plural forms and
with every language. Using the plural form may sometimes result in incorrect sentences, such as 1
documents not available, but in the majority of cases the variable will be replaced with a number
higher than 1.

7. In general, avoid using formulations that cause problems in translation, especially in texts containing
placeholders and ordinal numbers.

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 685
 ● Correct: Deletion of quantities not possible
● Correct: Line &1 deleted
Note: This message is displayed on the UI as, for example, Line 22 deleted.
● Correct: Enter a valid quantity
● Correct: Enter a valid value in the &1 field
Note: In this example, &1 stands for the Quantity field label (UI text). This message is displayed on
the UI as Enter a valid value in the Quantity field.
● Incorrect: Cannot &1 quantities
Note: Do not use a placeholder for a verb.
● Incorrect: &1th line deleted
Note: Do not use a placeholder for an ordinal number. This message is displayed on the UI as 22th
line deleted, which is incorrect in English.
● Incorrect: Enter a valid &1
Note: In this example, &1 stands for the Quantity field label (UI text). This message is displayed on
the UI as Enter a valid Quantity. The capitalization is incorrect in English, and the adjective
cannot be translated correctly into another language.

10.2.1.3 Standard Formulations for Message Short Texts

Overview
This section of the Style Guide and its subsections provides standard formulations for the most common message
short texts. They are listed and structured according to the error category to which they belong. Whenever you write
a message, analyze the error situation and decide to which category it belongs. If none of the categories listed here
fits the error situation of your message, follow the General Standards for Message Short Texts [page 683] to write
the message.

Error Categories

Errors and Failures ● Failure [page 687]

● Errors [page 687]
● Errors Due to Business Configuration [page 688]

Inability to Perform Action, Status and ● Inability to Perform Action [page 688]
Authorization Problems ● Inability to Perform Action Because Object is Locked [page 689]
● Inability to Display Data [page 689]
● Lack of Authorization [page 690]
● Inappropriate Status [page 690]
● Mandatory Step [page 690]

SAP Cloud Applications Studio – Version May 2018 (1805)

686 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
 Existence and Availability of Objects, Missing ● Existence of Objects [page 691]
Data, and Search Results ● Multiple Existence of Objects [page 691]
● Non-Existence of Objects [page 691]
● Availability of Objects [page 692]
● Missing Data [page 692]
● Search Results [page 692]
● Determination Problems [page 693]

Invalid Data and Value Problems ● Invalid Data [page 693]

● Value Problems [page 693]
● Assignment Problems [page 694]
● Role Problems [page 694]
● Date Problems [page 694]

Comparison Problems ● Missing Counterpart [page 695]

● Difference in a Comparison [page 695]

Object Selection Selecting Objects [page 696]

10.2.1.4 Standards for Errors and Failures

10.2.1.4.1 Failure — Standard Formulations

You use this standard formulation in cases where the execution of an action fails completely or where a general
failure occurs.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

... failed; <instruction or reason> Printing failed; install printer Error during printing

Printing failed; printer settings not Printing had a failure

correct
Internal error; internal data
inconsistency

Printing failed means that a document has not been printed at all.

10.2.1.4.2 Errors — Standard Formulations

You use these standard formulations in cases where the execution of an action has not failed completely, but can
only be completed with errors.

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 687
Standard Formulation Example of Correct Usage Example of Incorrect Usage

Error while <operation>; <instruction or Error while processing incoming e-mail; Errors were found
reason> check e-mail settings

Error during <operation>; <instruction or Error during RFQ creation; RFQ ID Error occurred during RFQ creation
reason> missing

Error while printing means that a document has been printed, but some pages are missing, for example.

10.2.1.4.3 Errors Due to Business Configuration— Standard

Formulations

You use these standard formulations in cases where an error occurs due to wrong or missing business configuration.

If possible, provide detailed information about what is wrong in the business configuration in a message long
text. For more information, see General Standards and Guidelines for Message Long Texts [page 701].

Standard Formulation Example of Correct Usage Example of Incorrect Usage

Error in business configuration for ... Error in business configuration for Business configuration error: Maintain
purchasing contract purchasing contract

Error in business configuration for Pricing not maintained in business

pricing procedure configuration
Note: For the message long text, an
example is The system could not
determine or assign the
Catalog for Pricing
field. ...

10.2.1.5 Standards for Inability to Perform Action, Status and

Authorization Problems

10.2.1.5.1 Inability to Perform Action — Standard Formulations

You use these standard formulations in cases where an action cannot be performed or is not permitted.
If the action is not followed by an object, use the technical action name, for example, Delete, Activate, and so on).

SAP Cloud Applications Studio – Version May 2018 (1805)

688 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
 Standard Formulation Example of Correct Usage Example of Incorrect Usage

<Action name> not permitted; Delete not permitted for user status; Function prohibited for user status
<instruction or reason> user not authorized to delete objects

<Action name> not possible; <instruction Create not possible; source object does Creation not possible, because source
or reason> not exist object does not exist

If the action is followed by an object, you may use the gerund or another verbal noun, for example, Deleting the
document, and so on.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

... <object> not permitted; <instruction or Deletion of quantities not permitted; Delete quantities not allowed; user not
reason> user not authorized to delete quantities authorized to delete quantities

... <object> not possible; <instruction or Creating the document not possible; Create document not possible; source
reason> source object does not exist object does not exist

10.2.1.5.2 Inability to Perform Action Because Object is Locked —

Standard Formulations

You use these standard formulations in cases where an action cannot be performed because the object is being used
by another user..

Standard Formulation Example of Correct Usage Example of Incorrect Usage

Operation not possible; <object> locked Operation not possible; hierarchy The operation cannot be performed
by <user> locked by user &1 because the hierarchy is locked by user
&1

Operation not possible; production Production order is locked by user &1

order locked by user &1

10.2.1.5.3 Inability to Display Data — Standard Formulations

You use this standard formulation in cases where the system cannot provide certain data to be displayed.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

Cannot display <object>; <instruction or Cannot display revision status; period You cannot display the revision status
reason> already completed here

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 689
10.2.1.5.4 Lack of Authorization — Standard Formulations

You use this standard formulation in cases where a party or a user does not have the authorization to perform a
certain step.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

... not authorized to ... Buyer not authorized to display master No authorization to display master data
data

User &1 not authorized to delete The user does not have change
purchase order authorization to delete the purchase
order

10.2.1.5.5 Inappropriate Status — Standard Formulations

You use these standard formulations in cases where an object does not have the appropriate status. As a
consequence, the user cannot change the object or use it in a transaction, for example.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

<Object> not <status> Business partner &1 not active Business partner &1 has not been
activated

<Object> <status> Bidder &1 not released Release of bidder &1 missing.
Note: The correct status name is not
released.

Delivery request inconsistent Delivery request is not consistent

Note: The correct status name is
inconsistent.

10.2.1.5.6 Mandatory Step — Standard Formulations

You use this standard formulation in cases where a certain step must be performed.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

... required for ... Mandatory step &1 required for phase Perform step &1 before you proceed
&2 with phase &2

Mandatory step &1 for phase &2 missing

SAP Cloud Applications Studio – Version May 2018 (1805)

690 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
10.2.1.6 Standards for Existence and Availability of Objects, Missing
Data, and Search Results

10.2.1.6.1 Existence of Objects— Standard Formulations

You use this standard formulation in cases where an object already exists in the system.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

<Object> already exists Hierarchy &1 already exists There is already a hierarchy &1

Open customer quote &1 already exists An open customer quote &1 exists for
for buyer &2 buyer &2

10.2.1.6.2 Multiple Existence of Objects — Standard Formulations

You use this standard formulation in cases where an object exists in the system more than once, which means it is
not unique.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

<Object> exists more than once Party &1 exists more than once Party &1 is not unique

There is more than one party &1

10.2.1.6.3 Non-Existence of Objects — Standard Formulations

You use this standard formulation in cases where an object does not exist at all in the system, which means it has
never been created or it has been deleted.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

<Object> does not exist Number range &1 does not exist Number range &1 not found
Note: Number range does not exist Note: This message is only correct if it is
means that the number range has never displayed after a user-initiated search.
been created.

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 691
10.2.1.6.4 Availability of Objects — Standard Formulations

You use this standard formulation in cases where an object exists in the system but is not available for a certain
action.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

<Object> not available Seller &1 not available for purchasing Seller &1 is not defined for purchasing
unit &2 unit &2
Note: Seller &1 not
available means that the seller
exists in the system, but it is not
available for a certain action, for
example, because it has not been
assigned for that action.

10.2.1.6.5 Missing Data — Standard Formulations

You use this standard formulation in cases where a mandatory field has not been filled or a required value has not
been transferred in an XML message.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

<Object missing> Currency missing Currency has not been defined

Unit of measure for the quantity in item Enter a unit of measure for the quantity
&1 missing in item &1

10.2.1.6.6 Search Results — Standard Formulations

You use these standard formulations in cases where, during a user-initiated search, a specific object was found,
could not be found, or no object was found at all.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

<Object> found &1 entries found &1 entries determined

<Object> not found Specified material &1 not found Specified material &1 could not be found

No <object> found No documents found No suitable entry was found

SAP Cloud Applications Studio – Version May 2018 (1805)

692 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
10.2.1.6.7 Determination Problem — Standard Formulations

You use this standard formulation in cases where the system cannot determine a certain object or value.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

<Object> not determined; <instruction or Product type for product &1 not The system could not determine the
reason> determined; add product type to product type for product &1
product

Buying organizational unit not Buying organizational unit not found

determined Note: This message would only be
correct if it was displayed after a user-
initiated search

10.2.1.7 Standards for Invalid Data and Value Problems

10.2.1.7.1 Invalid Data — Standard Formulations

You use these standard formulations in cases where a certain value is not valid in the current context or if a certain
value is not valid at all..

Standard Formulation Example of Correct Usage Example of Incorrect Usage

... not valid Inventory valuation level &1 not valid Inventory valuation level &1 is invalid

... not valid for ... Number &1 not valid for external interval Number &1 is invalid for external interval
&2 &2

10.2.1.7.2 Value Problems — Standard Formulations

You use these standard formulations in cases where a certain value is not permitted or wrong in a specific context.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

<Value> not permitted Unit of measure &1 not permitted Unit of measure &1 not allowed
Note: &1 is a valid unit of measure, but it
Unit of measure &1 not valid
is not permitted in the context of the
error message.

Only one <object> permitted Only one buyer permitted Enter exactly one party of role buyer

Only one quantity permitted as valuation Only one quantity can be the valuation
quantity quantity

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 693
Standard Formulation Example of Correct Usage Example of Incorrect Usage

<Value> greater than <value> Item value greater than limit &1 of Item value is higher than limit &1 of
purchase order &2 purchase order &2
Note: This indicates that the item value
Item value exceeds limit &1 of purchase
is greater than allowed.
order &2

<Value> less than <value> Purchase order net amount less than Purchase order net amount is lower than
minimum order value minimum order value
Note: This indicates that the item value
is less than allowed

<Value> must not be greater than Invoiced quantity must not be greater Invoiced quantity must be less than or
<value> than delivered quantity for item &1 equal to the delivered quantity for item
Note: This indicates that the invoiced &1
quantity must be smaller than or equal
to the delivered quantity.

10.2.1.7.3 Assignment Problems — Standard Formulations

You use this standard formulation in cases where a user or business partner has not been assigned.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

... not assigned to ... Contact person &1 not assigned to Assignment missing for contact person
bidder &2

10.2.1.7.4 Role Problems — Standard Formulations

You use this standard formulation in cases where a user or business partner does not have the appropriate role.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

... does not have ... role; <instruction or &1 with ID &2 does not have &3 role; role Bus partner role cat &3 not maintained
reason> must be assigned in master data for party &1 ID &2

10.2.1.7.5 Date Problems — Standard Formulations

You use these standard formulations in cases where there are problems with a date used in a business transaction.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

<... date> must be before <... date> Start date must be before end date Enter a start date that is before the end
date

SAP Cloud Applications Studio – Version May 2018 (1805)

694 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
 Standard Formulation Example of Correct Usage Example of Incorrect Usage

<... date> must be after <... date> Submission deadline must be after end Enter a submission deadline that is after
date the start date

<... date> must be the same as <... date> Posting date must be the same as run Enter a posting date that is the same as
date the run date

<... date> must not be after <... date> Source of supply date must not be after Date/Time From of SourceOfSupply is
supply quota arrangement date later than that of SQA
Note: This indicates that the source of
supply date must be before or the same
as the supply quota arrangement date.

<... date> must not be in the future Receipt date must not be in the future Enter a receipt date that is not in the
future

<... date> must not be before <... date> Source of supply date must not be Date/Time To of SourceOfSupply is
before supply quota arrangement date earlier than that of SQA
Note: This indicates that the source of
supply date must be after or the same as
the supply quota arrangement date.

<... date> must not be in the past Start date must not be in the past Enter a start date that is not in the past

<... period> must not start before <... Binding period must not start before Enter a binding period that starts after
date> submission deadline the submission deadline
Note: This indicates that the binding
period must start on or after the date of
the submission deadline

10.2.1.8 Standards for Comparison Problems

10.2.1.8.1 Missing Counterpart — Standard Formulations

You use this standard formulation in cases where the counterpart of a certain object cannot be found for a
comparison.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

No ... matches ... No accounting notification matches No accounting notification coincides

payment allocation &1 with payment allocation &1

No accounting notification matches The corresponding accounting

supplier invoice notification does not exist for supplier
invoice

10.2.1.8.2 Difference in a Comparison — Standard Formulations

You use these standard formulations in cases where the following applies:

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 695
 ● Two values in a comparison are not the same
● One value in a comparison is not the same as the other
● The type or category of an object in a comparison does not match the type or category of another object

Standard Formulation Example of Correct Usage Example of Incorrect Usage

... differ Transaction dates differ Transaction dates mismatch

Transaction dates do not coincide

... differs from ... Currency &1 in confirmation differs from Currency &1 in confirmation
currency &2 in purchase order mismatches currency &2 in purchase
order

Price of item &1 in confirmation differs Price difference between confirmation

from that in purchase order and purchase order in item &1

... and ... do not match Identified stock &1 and material &2 do Identified stock &1 and material &2 differ
not match

10.2.1.9 Standards for Object Selection

10.2.1.9.1 Selecting Objects — Standard Formulations

You use these standard formulations for error situations where the end user has to select an object.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

Select <object> Select the document to be deleted Choose the document to be deleted

Additional <objects> not selected Additional status profiles not selected Additional status profiles not
highlighted

10.2.1.10 Standards for Application Log Messages

10.2.1.10.1 Standards and Guidelines for Application Log Messages

Overview
This section of the style guide and its subsections provides standards and guidelines for application log messages.
Application logs belong to mass data run objects (MDROs) and support mass data runs. When a run is started, it
takes place in the background. At the end of the run, the application log is displayed on the user interface (UI) to
retrace the results.
Most of the message texts that are used in application logs are not really error messages. They are used to provide
texts for the different sections of the application log, such as headings or selection data.

SAP Cloud Applications Studio – Version May 2018 (1805)

696 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
Structure of the Application Log
Application logs consist of three sections that group the messages posted:
1. General
This section contains a summary of what happened during the mass data run and generic log statistics, for
example, the number of errors.

2. Settings
This section contains information on the parameters and settings that have been selected for the mass data
run.

3. Results
This section contains detailed information about the decisions taken and about the errors and warnings that
occurred during the mass data run in chronological order.

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 697
10.2.1.10.2 Number of Objects — Standards for Application Log
Messages

You use these standard formulations for messages used in application logs to display the number of objects that
were or were not processed correctly during an application log run.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

Number of ...: <number> Number of procurement planning &1 procurement planning orders have
orders changed: &1 been changed

Number of ... not ...: <number> Number of procurement planning &1 procurement planning orders were
orders not changed: &1 not changed

Number of production planning orders &1 production planning orders could not
not changed: &1 be changed

10.2.1.10.3 Headings — Standards for Application Log Messages

1. For messages used in application logs as headings, use title case.

2. Do not put a colon (:); semi-colon (;), or period (.) at the end of the message.

Example of Correct Usage Example of Incorrect Usage

Bank Statement &1 Bank Statement

Note: Under this heading, messages concerning bank
statement &1 are listed

Checking Parameters Checking parameters

Note: Under this heading, all relevant checking parameters are
listed

Selection Data Selection criteria:

SAP Cloud Applications Studio – Version May 2018 (1805)

698 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
 Example of Correct Usage Example of Incorrect Usage

Summary Summary Details:

10.2.1.10.4 Selection By — Standards for Application Log Messages

You use this standard formulation to specify the selection category that defines the elements to be included in or
excluded from an application log run.
You use title case to formulate the message.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

<Name of SelectionBy node with spaces> Selection by Purchase Order Selection by purchase order

Selection by Buyer Selection by BuyerParty

If the node name includes the word party, leave it out in the message.

10.2.1.10.5 Inclusion/Exclusion — Standards for Application Log

Messages

You use these standard formulations for messages used in application logs to specify the elements excluded from
or included in an application log run.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

Exclude all matches (with) <lower Exclude all matches with &1 &2 Exclusion code: &
boundary type code>; <lower boundary
ID>

Include all matches from <lower Include all matches from &1 to &2 Inclusion code: &1 &2
boundary> to <lower boundary>

10.2.1.10.6 Control Parameters— Standards for Application Log

Messages

You use this standard formulation for messages used in application logs to display the settings that are used for a
control parameter.

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 699
Standard Formulation Example of Correct Usage Example of Incorrect Usage

<Name of parameter element>: <Value of Employee time valuation period closure The employee time valuation period
parameter element> date: &1 closure date is &1

10.2.1.10.7 Application Log Run Start/End — Standards for

Application Log Messages

You use these standard formulations for messages used in application logs to specify when an application log run
has started or ended.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

... started Adjustment run started Adjustment run has been started

... ended Cleanup run ended Cleanup run has finished

10.2.1.10.8 Success or Failure Messages — Standards for Application

Log Messages

1. For messages that describe the result of an application log run, use sentence style.
2. Do not use the words successfully and unsuccessfully.
3. Do not put a period at the end of the message text

Example of Correct Usage Example of Incorrect Usage

&1 new period closure dates not created & new period closure dates created unsuccessfully

&1 of &2 orders created &1 of &2 order have been created successfully.

10.2.1.10.9 ID Messages — Standards for Application Log Messages

You use these standard formulations for messages used in application logs to display the ID of an object that has
been processed during an application log run.

Standard Formulation Example of Correct Usage Example of Incorrect Usage

... ID: <ID> Business transaction document ID: &1 The business transaction document ID
is &1

Customer requirement ID: &1 Customer Requirement ID: &1

SAP Cloud Applications Studio – Version May 2018 (1805)

700 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
10.2.1.11 General Standards for Message Long Texts

10.2.1.11.1 General Standards and Guidelines for Message Long Texts

Overview
This section of the Style Guide provides you with the general standards and guidelines for writing message long texts.

General
1. Add a section to the Solution Documentation for long texts that contain additional information on complex
system messages. These are messages in which you cannot explain within 73 characters what the user has
to do to resolve an error.
2. Name the section in the Solution Documentation Additional Information on System Messages.
3. Use the structure below for each message long text.
4. Separate the different message long texts by sub-sections.

Structure of System Message Long Texts

Keyblock: Title
1. This keyblock is mandatory. It links the long text to the short text in the system.
2. For the title, use the text of the message short text.
3. Do not use variables in the document title. If the system message contains variables, rephrase it to the
document title.

Example of Correct Usage Example of Incorrect Usage

Invoice may be a duplicate of another invoice Invoice may be a duplicate of invoice &1

Keyblock: What Happened?

1. This keyblock is optional. It advises the user what caused the error and what implications the error has.
2. Answer the following questions:
a. What is the cause of the error message?
b. In which context does the error occur?
c. What are the implications?

Keyblock: What Can I Do?

1. This keyblock is mandatory. It advises the user what they can do to resolve the error message.
2. Answer the question: What can the user do to solve the error?
3. If appropriate, use a numbered list.

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 701
Example

Message Short Text/Keyblock Sample Text

Message Short Text Invoice may be a duplicate of invoice &1

Message Long Text

Keyblock: Title Invoice may be a duplicate of another invoice

Keyblock: What Happened? The system was unable to post the supplier invoice or credit memo and created an
exception.

Keyblock: What Can I Do? Check your entry and proceed as follows:
1. Open the Supplier Invoice editor and go to the Exceptions tab.
Before resolving the exception, if you require further information from another
person, click Forward for Clarification.
2. Compare the invoice details with the similar invoice already posted in the
system.
a. If the invoice is not a duplicate, under Exception Details, click Treat as New
Invoice.
b. If the invoice is a duplicate, under Exception Details, click Treat as Duplicate
Invoice.

10.2.1.11.2 Standards for Message Long Texts for PAF BTM Tasks

Overview
Process Agent Framework Business Task Management (PAF BTM) tasks are used to inform a user about a manual
cleanup activity that has to be done to solve a process communication error that occurred in inbound error conflict
handling.
Each PAF BTM task has a task description, which provides detailed information on a fatal error that occurred and
instructions on how to solve the error.

The PAF BTM task description is structured as follows:

A fatal error occurred:
<PAF BTM Error Message Short Text>
<PAF BTM Error Message Long Text>

The message short text is used to briefly describe the fatal error that occurred. For this text (called PAF BTM error
message short text in this document), the General Standards for Message Short Texts [page 683] and the Standard
Formulations for Message Short Texts [page 686] apply.
The message long text provides detailed information and instructions on how to solve the error. For this text (called
PAF BTM error message long text in this document), follow the standards and guidelines listed below.

General Standards
1. Include these message long texts in the section of the Solution Documentation named Additional
Information on System Messages.
Create this section if it does not already exist.

SAP Cloud Applications Studio – Version May 2018 (1805)

702 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
 2. Formulate the message long text according to the keyblocks described below.
3. Use the SAP cloud solution terminology.
4. If you want to use a variable, use the following format: &v1&. Do not use the variable format that is usually
used for message short texts (&1).

Example of Correct Usage Example of Incorrect Usage

Open the &v1& project Open the &1 project.

5. Do not enter more than four variables.

6. Do not use abbreviations.

Keyblock: Context Information

1. This keyblock is optional.
2. Answer the following questions:
a. What is the cause of the error message?
b. In which context does the error occur?
c. What are the implications?
3. Only use this keyblock if the message short text does not provide enough context information on the error.

The status of the &v1& project and the &v2& task is On Hold, Stopped, or Closed. Therefore, no further
postings are permitted. As a result, a time confirmation related to the &v1& project and the &v2& task
could not be processed

Keyblock: Solution
General Standards
1. This keyblock is mandatory.
2. Answer the question: What can the user do to solve the error?
3. Use one of the following standard formulations:
● If there is only one solution, use the following:
To solve the error, proceed as follows:
● If there is more than one solution, use the following:
You have the following options to solve the error:
4. Describe the solution using a numbered list.
Use the standard formulations in the sub-section below, If the message refers to one of the following:
● Errors that refer to handling lock issues
● Errors that occur when an inbound XML message that has been sent via a third party interface cannot
be processed
5. In the second last step, describe how the system responds to the user action.
6. In the last step, describe what the user needs do on the Process Communication Error screen to finalize the
task. The user has the following options:
● Restart process
● Reject process

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 703
 ● Synchronize process
● Mass restart process
● Abort process

For more information, see the Keyblock: Result section below.

7. If there is more than one solution to solve the error, describe all of them and introduce each of them with the
following standard formulation:
Solution <number of solution>:
Use this solution if <describe why this solution should be used> ...

● Example of Only One Solution:

To solve the error, proceed as follows:
1. Click Open Business Document to navigate to the &v1& project.
2. Go to edit mode and navigate to the &v2& task.
3. Change the task as follows:
● If the project status is Stopped or Closed, change it to Released.
● If the On Hold flag is selected for the task, deselect the flag.
4. Save the changes.
5. The system sets the project status of the &v1& project and the &v2& task to Released, and
On Hold is no longer selected.
6. Restart the process by clicking Restart Process on the Process Communication Error screen.
● Example of More than One Solution:
You have the following options to solve the error:
Solution 1:
Use this solution if the quantity sent by the service confirmation appears to be incorrect.
1. Clarify with the responsible person for the service confirmation, whether incorrect data was
entered during service confirmation.
2. Ensure that the responsible person for the service confirmation corrects the data in the
service confirmation.
3. The system reprocesses the data, which is now correct.
4. Synchronize the documents by clicking Synchronize Documents on the Process
Communication Error screen.

Result: The system synchronizes the documents using the updated data of the service
confirmation.
Solution 2:
Use this solution if the stock update given for the outbound delivery is incorrect.
1. Find the corresponding outbound delivery.
2. Make adjustment confirmation on the outbound delivery.
3. The system accepts the reported quantity of the service confirmation.
4. Restart the process by clicking Restart Process on the Process Communication Error screen.

Result: The system updates the stock accordingly.

The message short text that belongs to this long text is “Negative stock not permitted in
custodian party”. This task is created if the quantity reported in a service confirmation
exceeds the allocated quantity of the material in the identified stock.

SAP Cloud Applications Studio – Version May 2018 (1805)

704 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
Standard Formulation for Handling Lock Issues
For message long texts that refer to handling lock issues, use the following standard formulations:

Keyblock: To solve the error, proceed as follows:

Solution 1. Open the Process Communication Error screen.
and Step:
2. In the Related Errors list, identify the user locking the business document.
Result
3. Ensure that the user closes the business document.
4. The system unlocks the document.
5. Restart the process by clicking Restart Process.

Result: The system updates the business document

The standard formulation of short texts for messages referring to handling lock issues is one of the
following:
● Operation not possible; <business document locked>
● <Operation> not possible, <business document> <business document ID> locked by <user
name>

Standard Formulation for Inbound Third Party Communication Errors

For message long texts that refer to errors that occur when an inbound XML message that has been sent via a third
party interface cannot be processed, use the following standard formulation:

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 705
Keyblock: You have the following options to solve the error:
Solution Solution 1:
and Step: Use this solution if a business document that you have received via a third party interface has to be changed by
Result the sender of the document.
1. Check the details of the error message on the Process Communication Error screen.
2. Contact the person responsible on sender side of the message to inform him or her about the issue:
Party: &v1&
Contact Person: &V2&
Phone Number: &v3&
Sender System: &v4&
3. Ask the person on sender side to perform the relevant changes (so that the message can be processed
in your system) and to send the business document again.
4. Abort the process by clicking Abort Process on the Process Communication Error screen.
5. Restart the process by clicking Restart Process.

Result: The system does not process the message, and the sender needs to resend a corrected message.
Solution 2:
Use this solution if you have to make changes to your system to enable the processing of a business document
that you have received via a third party interface.
1. Check the details of the error message on the Process Communication Error screen.
2. Adjust the data in your system, for example, master data or business configuration data, or edit the
payload, if allowed, on the Process Communication Error screen as required.
3. Restart the process by clicking Restart Process.

Result: The system updates the business documents.

For messages referring to errors that occur when an XML message that has been sent via a third party
interface could not be processed, he standard formulation of the message short text is:
Error while processing inbound third party communication

Step: Result
1. This step is mandatory.
2. Describe the result of the steps performed to solve the error:
3. Depending on the user's options, use one of the following standard formulations:

SAP Cloud Applications Studio – Version May 2018 (1805)

706 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
 User Option Standard Formulation

Restart Process Result: The system updates <object, including &v1&>.

● The standard formulation of the Result step for messages referring to handling
lock issues is:
Result: The system updates the business document
● For messages referring to errors that occur when an inbound XML message
that has been sent via a third party interface cannot be processed, the standard
formulation of the Result step is:
○ For Solution 1:
Result: The system does not process the message, and the sender needs
to send a corrected message.
Restart the process by clicking Restart Process.
○ For Solution 2:
Result: The system updates the business documents.

Reject Process Result: The system does not update <object, including &v1&>, and cancels the process
communication.

Synchronize Result: The system synchronizes the documents using the updated data of the <object,
Documents including &v1&>.

Mass Restart Process Result: The system updates <object, including &v1&> by restarting all related process
communication.

Abort Process Result: The system does not update <object, including &v1&>, and the process communication
is aborted.

Result: The system updates the &v1& project and the &v2& task with the time confirmation.

4. If there is more than one solution to solve the error, do one of the following:
● If the result of each is different, add a Results keyblock after each solution.
● If the result of all of them is always the same, only add one Results keyblock (after the last solution).

Keyblock: Further Information

1. This keyblock is optional.
2. If there are any follow-up activities required that are not directly related to the error solution, for example, to
avoid data inconsistencies, describe them here.
3. Do not describe the follow-up activities in detail.
4. Do not use a numbered list.
5. Use the following standard formulation:
Note: <follow-up activity> ...

Note: Check if it should be permitted to add further postings to the &v1& project and the &v2& task:
● If further postings are to be permitted, no further actions are required
● If further postings are not to be permitted, change the task data back to the previous project status
or set it to On Hold

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 707
10.3 Reference Guides

10.3.1 Reference Guide for Documentation for Cloud Solutions from

SAP

10.3.1.1 Introduction to Documentation for Cloud Solutions from SAP

This reference guide provides an overview of the main reference documentation types specific to SAP cloud
solutions. It covers the following:
● Business Configuration Documentation [page 712]
○ Business Adaptation Catalog
○ Activity List
○ Basic Data
● Work Center Documentation [page 716]
○ Analytics
○ Data sources: multidimensional analytical views (MDAVs), key figure structures, and key figure
grids
○ Reports
○ Key performance indicators
○ Dashboards
○ Business Task Management
○ Business Background Documentation
○ Concept Documents
○ Process Documents
○ Task-Based Documentation (How-To Documents)
○ Org Functions
○ Quick Guides
○ Work Categories
● Health Checks and Support Case Library [page 714]
○ Health Checks
○ Case Documents (Troubleshooting
● Release Information [page 721]
○ Business Configuration Delta Documentation
○ What's New Documentation

SAP Cloud Applications Studio – Version May 2018 (1805)

708 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
10.3.1.2 Documentation Types in Cloud Solutions from SAP

Overview
This document provides a brief overview of the main reference documentation types specific to the SAP cloud
solutions.

Business Configuration Documentation

The reference documentation for business configuration covers documentation for the Business Adaptation Catalog
(BAC).
● Business Adaptation Catalog
This reference documentation provides information about scope selection. All scope selection topics and
activities to configure the system before and after go live are reflected in elements of the Business Adaptation
Catalog (BAC). These elements are business areas, business packages, business topics, and business
options. BAC elements require reference documentation if they have one of the following visibility options:
○ Always
○ Scoping Visible
○ Hidden with option type Blueprint Only
● Activity List
This reference documentation provides information about configuring the system before and after go live. In
the activity list, reference documentation covers fine-tuning activities and basic data activities.
○ Fine-Tuning
These documentation types provide users with the information they require to perform activities in the
Fine-Tune phase of the Activity List. These documents can also include information relevant to before
and after the completion of a fine-tuning activity. Depending on the complexity of the activities and the
activity type, there are three types of documents that can be written for these activities:
○ Fine-Tuning Business Background
This documentation type describes the activity and guides the user through the activity by listing
the required steps and settings. This documentation type can be used for simple activities that lead
directly to a configuration screen.
○ Configuration Guides
This documentation type is suited to activities that are fact sheets. Fact sheets are a collection of
related links and texts for further navigation, for example to configuration screens.
○ Basic Data
This documentation type provides information about activities during the Integrate and Extend phase of
the Activity List in business configuration. These activities involve migrating or maintaining core master
data as a prerequisite for other fine-tuning, migration, or testing activities. The purpose of this
documentation type is to advise a user how to perform an activity and why an activity must be carried
out during the configuration phase. Detailed instructions for actually carrying out the steps within the
activity can come in the form of links to other existing documents.

For information on how this documentation is structured, see Structure of Reference Documentation for Business
Configuration [page 712].

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 709
Work Center Documentation
The reference documentation for work centers covers documentation for the following:
● Analytics
This reference documentation provides information about analytic content that is displayed on the user
interface. This includes the following types of objects:
○ Data sources: multidimensional analytical views (MDAVs), key figure structures, and key figure grids.
Overview of data sources documentation provides information about the multidimensional analytical
view (MDAV), key figure structures, and key figure grids that make data available for reports in an area,
such as Customer Relationship Management. This type of documentation is available in the guided quick
activity for creating reports and is linked in documentation related to reports.
○ Reports
Report documentation provides information about a compilation of data for evaluation that can be
presented in the form of a table, list, text, graph, or combination of these. It is used in detailed scoping
and fine-tuning, as well as by users in the application. In scoping, the Overview keyblock of the
documentation is displayed. In application Reports work center views, the full report documentation is
displayed.
Overview of reports documentation provides information about the reports that are available in an area,
such as Customer Relationship Management by report category. It also contains information about
relevant variables in the area. The embedded reports available in the super area are also listed. Overview
of Reports documentation is available in the Reports View of work centers.
● Business Task Management
This reference documentation provides information that enable them to understand and process a particular
business task management (BTM) task type effectively. Each task type document explains the purpose and
business process context of a particular task type in the system, why a particular user receives the task, what
kind of response is required, what the follow-up process steps are, and which elements can be configured.
● Business Background Essentials
This reference documentation covers the concepts and processes that form the SAP cloud solution.
Therefore, a differentiation is made between the following types:
○ Concept
Concepts cover a general business concept or technical concept that has a particular implementation
in the SAP cloud solution. A concept can be specific to one view or can span several views, business
areas, or even application areas.
○ Process
Processes cover a sequence of logically related events or steps that have a specific outcome or result
in the SAP cloud solution. A process can be specific to one particular view or can span several views,
business areas, or even application areas.
● Tasks (How-To Documentation)
This reference documentation provides a user with the step-by-step information they require to be able to
perform a task in the SAP cloud solution. Typically, it also includes information that the user needs to know
before and after the completion of a task.
● Org Functions
An org function is a predefined entity in the SAP cloud solution that denotes functional responsibility for
aspects of one or more business processes. In Organizational Management (OM), the solution administrator
assigns org functions to org units in order to define the role of each org unit within the context of the
organization’s overall business operation. The org function assignment for a given org unit influences work
center proposals for users assigned to this org unit. Each org function document describes a specific org
function in terms of the associated business processes, business documents, and work centers. The purpose

SAP Cloud Applications Studio – Version May 2018 (1805)

710 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
 of org function documentation is to support the OM administrator who is responsible for modeling the org
structure and assigning org functions to the org units.
● View Quick Guide
A quick guide provides a user with a “quick” overview of a view. It is also the central entry point for accessing
more detailed information related to the view. That is, for a more in-depth understanding, the user has the
option of reading the documents linked from the quick guide. It provides the following key elements:
○ Summary of what the view is used for
○ Business background
○ Tasks that can be performed
● Work Categories
A work category (also known as responsibility) represents a type of work related to an org function. It contains
rules that determine which set of work items is distributed to which org unit or employee. This is known as
the process of work distribution, where a work item can be any business document or a task in Business Task
Management (BTM).
The distribution of work items is usually defined by the access rights that are given to a user. However, using
work categories, work items can be directly assigned to a specific org unit or employee. Each work category
provides a set of parameters that can be used to define work distribution rules for the related work items.
The SAP cloud solution provides specific work categories for organizational work distribution and employee
work distribution.
Each work category document describes a specific work category in terms of the associated business
process, business documents, tasks, parameters, and work distribution rules. The primary purpose of work
category content is to support solution administrators who are responsible for effective distribution of work
in the system.

For more information on how this documentation is structured, see Structure of Reference Documentation for Work
Centers [page 716].

Health Checks and Support Case Library

This reference documentation covers the following:
● Health Checks
A health check is an incident generated by the system when functions or applications are not operating
properly. The reference documentation provides information about the cause of the incident and the
information required to resolve the issue.
● Support Case Library (Troubleshooting)
This reference documentation provides information about the symptoms, cause, and resolution of system
issues that are reported as incidents in the support cockpit. Each case document covers one specific issue
which may in turn be relevant to one or more related incidents.
Case documents provide a practical, searchable medium for quickly identifying solutions to system issues
and answers to questions raised by customers. Their purpose is to reduce the number of reported incidents
by making solutions readily available.
Case documents address the following types of issues:
○ How-to explanations
○ Assistance with changes to business configuration or master data
○ Workarounds
○ Explanations of system behavior

For more information on how this documentation is structured, see Structure of Reference Documentation for Health
Checks and Support Case Library [page 714].

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 711
Release Information
This reference documentation includes the following:
● Business Configuration Delta Documentation
Business Configuration (BC) Delta documentation provides information on all changes that have taken place
since the last release in the configuration of the SAP cloud solution that impact customer settings.
The changes usually refer to settings that the customer performed during scoping and to settings made from
the Activity List. These scope selections and activities are reflected in elements in the business configuration
catalog (BAC). The BAC elements are known to the as business configuration elements.
● What's New Documentation
What’s New documentation is a series of documents that, taken as a whole, describes what is new and what
has been changed or deleted in a particular version of the SAP standard cloud solution. The first document
in the series describes system-wide changes. Depending on the level of change within each area and its parts,
other documents may be created for specific areas (for example, Customer Relationship Management),
topics (for example, Organizational Management), or views (for example, Opportunities).

For more information on how this documentation is structured, see Structure of Release Information
[page 721].

10.3.1.3 Structure of Reference Documentation for Business

Configuration

Overview
The reference documentation for business configuration covers Business Adaptation Catalog (BAC) documentation
and Activity List documentation:

Business Adaptation Catalog Documentation

This documentation provides information about scope selection. All scope selection topics and activities to configure
the system before and after go live are reflected in elements of the Business Adaptation Catalog (BAC). These
elements are business areas, business packages, business topics, and business options. BAC elements require
reference documentation if they have one of the following visibility options:
● Always
● Scoping Visible
● Hidden with option type Blueprint Only

Structure of BAC Reference Documentation (Excluding Business Options for Reports)

Keyblock Answers the Following Questions

Title What is the title of the BAC element?

Overview What function does this element provide?

What are the benefits of using this element?

SAP Cloud Applications Studio – Version May 2018 (1805)

712 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
 Keyblock Answers the Following Questions

Relevance When or why should the user select this element?

What are the implications of selecting or not selecting this element?
Has this element been selected by constraint?

Structure of BAC Reference Documentation — Business Options for Reports

Keyblock Answers the Following Questions

Title What is the title of the report?

Overview What can the user do with the report?

Why should the user use the report?

The documentation for business options for reports matches that of the related report documentation. For
more information, see Structure of Reference Documentation for Work Centers [page 716].

Activity List Documentation

This reference documentation provides information about configuring the system before and after go live. In the
activity list, reference documentation covers fine-tuning activities and basic data activities.
Fine-Tuning Documentation
These documentation types provide users with the information they require to perform activities in the Fine-Tune
phase of the Activity List. These documents can also include information relevant to before and after the completion
of a fine-tuning activity. Depending on the complexity of the activities and the activity type, the following types of
documents can be written for these activities:
● Activity Documentation
This documentation type describes the activity and guides the user through the activity by listing the required
steps and settings. This documentation type can be used for simple activities that lead directly to a
configuration screen.

Structure of Activity Documentation

Keyblock Answers the Following Questions

Title What is the title of the configuration activity?

Overview What does this configuration activity involve (in summary)?

What are the implications for the user's business?

Prerequisites What other configuration activities have to be performed before this activity?

Steps What are the steps that the user must carry out to perform the activity?

Follow-On What other configuration activities have to be performed after this activity?
Activities

● Configuration Guide Documents

This type of document provides a starting point for completing activities contained in an activity details screen
(otherwise known as a fact sheet). It is also the central entry point for accessing more detailed information
related to the activity. That is, for a more in-depth understanding, the user has the option of reading the
documents linked from the configuration guide.

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 713
Structure of Configuration Guide Documentation

Keyblock Answers the Following Questions

Title What is the name of the configuration activity, followed by “- Configuration Guide”? For example, “Suppliers
— Configuration Guide”.

Overview What are the purpose and result of this configuration activity?
Where is this activity located in the system?

Prerequisites What prerequisites must be fulfilled before completing this activity?

Are there any other activities which must be completed before this activity can be completed?

Business What are the key concepts related to this activity?

Background

Tasks For each individual configuration activity:

● What is the title of the configuration activity?
What specific action do I need to take to perform this configuration activity?
In which sequence should I perform these steps? (If applicable, also explain what the result of each
successive action is.)

Follow-Up What other configuration activities have to be performed after this activity, if any, and where do they take
Activities place?

Basic Data Documentation

This documentation type provides information about activities during the Integrate and Extend phase of the Activity
List in business configuration. These activities involve migrating or maintaining core master data as a prerequisite
for other fine-tuning, migration, or testing activities. The purpose of this documentation type is to advise a user how
to perform an activity and why an activity must be carried out during the configuration phase. Detailed instructions
for actually carrying out the steps within the activity can come in the form of links to other existing documents.

Structure of Basic Data Documentation

Keyblock Answers the Following Questions

Title What is the title of the Basic Data activity?

Overview What does this activity involve (in summary)?

Why must the user perform this activity during configuration?

Prerequisites What other activities have to be performed before this activity?

Steps What are the steps the user has to perform in this activity?

Follow-Up What other activities have to be performed after this activity?

Activities

10.3.1.4 Structure of Reference Documentation for Health Checks

and Support Case Library

Overview
This document provides a brief overview of the reference documentation types specific to Health Checks and the
Support Case Library (troubleshooting documentation).

SAP Cloud Applications Studio – Version May 2018 (1805)

714 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
Health Check Documentation
A health check is an incident generated by the system when functions or applications are not operating properly.
The reference documentation provides information about the cause of the incident and the information required to
resolve the issue.

Structure of Health Check Documentation

Keyblock Answers the Following Questions

Title What is the name of the error/incident?

Description What happened in the system/application?

Recommended What steps need to be taken to solve the problem?

Action

Support Case Library (Troubleshooting) Documentation

This reference documentation provides information about the symptoms, cause, and resolution of system issues
that are reported as incidents. Each case document covers one specific issue which may in turn be relevant to one
or more related incidents.
Case documents provide a practical, searchable medium for quickly identifying solutions to system issues and
answers to questions raised by customers. Their purpose is to reduce the number of reported incidents by making
solutions readily available.
Case documents address the following types of issues:
● How-to explanations
● Assistance with changes to business configuration or master data
● Workarounds
● Explanations of system behavior

Structure of Support Case Library Documentation

Keyblock Answers the Following Questions

Title What is the name of the issue?

Short What is the issue?

Description

Description What are the symptoms of the issue?

What is the context of the issue?
What are the implications?

Reproducing the Can you outline the events or actions that led to the issue?
Issue How can the issue be reproduced?

Cause In administrator terms, what is the cause of the issue?

What is the technical background?

Resolution What can a support consultant or administrator do to address the issue?

See Also Where can the user find more information? (cross-reference)

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 715
10.3.1.5 Structure of Reference Documentation for Work Centers

Overview
The reference documentation covers documentation for the following:
● Analytics
● Business Task Management
● Business Background Essentials
● Tasks (How-To Documentation)
● Org Functions
● Work Categories

Analytics Documentation
This reference documentation provides information about analytic content that is displayed on the user interface.
This includes the following types of objects:
● Data sources: multidimensional analytical views (MDAVs), key figure structures, and key figure grids.
Overview of data sources documentation provides information about the multidimensional analytical view
(MDAV), key figure structures, and key figure grids that make data available for reports in a particular area,
such as Customer Relationship Management. This type of documentation is available in the guided quick
activity for creating reports and is linked in documentation related to reports.

Structure of Data Source Documentation

Keyblock Answers the Following Questions

Title For which super area is the overview of data sources? For example, Overview of Data Sources for
Customer Relationship Management

Overview What is the purpose of the document?

Available Data Sources What MDAVs are available in the super area?

Selected Data Sources Do any MDAVs, key figure structures, and key figure grids require detailed documentation?

Available Key Figure What key figure structures and key figure grids are available in the area?
Groups

Common Which basic characteristics and key figures are available that are used in multiple reports?
Characteristics and
Key Figures

See Also Which additional documentation exists? (cross-reference)

● Reports
Report documentation provides information about a compilation of data for evaluation that can be presented
in the form of a table, list, text, graph, or combination of these. It is used in detailed scoping and fine-tuning,
as well as by users in the application. In scoping in the business options for reports, the Overview keyblock of
the documentation is displayed. In the Reports views, the full report documentation is displayed.

SAP Cloud Applications Studio – Version May 2018 (1805)

716 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
Structure of Report Documentation

Keyblock Answers the Following Questions

Title What is the name of the report?

Overview What can the user do with the report?

Why should the user use the report?

Prerequisites Are there any prerequisites to running the report?

Views Which views are available with the report?

Features Are all of the following document subheadings relevant for the report?
● Running the Report: Which variables are most important?
● Analyzing the Report: What can the user see in the (initial state of the) report? Is the data
filtered? Which characteristics can the user use to filter and analyze the content of this report
further? Which elements of the report provide the possibility of opening or navigating to other
related reports or business object interfaces, such as Overviews (fact sheets)?

See Also Which additional documentation exists? (cross-reference)

● Overview of Reports
Overview of reports documentation provides information about the reports that are available in a particular
area, such as Customer Relationship Management by report category. It also contains information about
relevant variables in the area. The embedded reports available in the super area are also listed. Overview of
Reports documentation is available in the Reports view.

Structure of Overview of Reports Documentation

Keyblock Answers the Following Questions

Title For which area is the overview of reports? For example, Overview of Reports for Customer
Relationship Management

Overview What is the purpose of the overview?

Reports Which reports are associated with which report category?

Common Variables What are the basic variables relevant for reports?

Embedded Reports Are there any information consumer patterns (ICPs)?

See Also Which additional documentation exists? (cross-reference)

Business Task Management Documentation

This reference documentation provides information that enables users to understand and process a particular task
type effectively. Each task type document explains the purpose and business process context of a particular task
type in the system, why a particular user receives the task, what kind of response is required, what the follow-up
process steps are, and which elements can be configured.

Structure of BTM Task Type Documentation

Keyblock Answers the Following Questions

Title What is the name of this task type?

Overview What kind of task type is this and why was it created?

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 717
Keyblock Answers the Following Questions

Relevance Why has this task type appeared in the user's worklist(s)?
To which areas of business is it relevant?

Response What are the possible actions I can take in responding to this task?
What is the result of each possible action, and what are the business and workflow implications?

Configuration Is it possible to configure this task type?

See Also Where can the user find more information? (cross-reference)

Business Background Documentation

This reference documentation covers the concepts and processes that form the SAP cloud solution. Therefore, a
differentiation is made between the following types:
● Concept Documents
Concept documents cover a general business concept or technical concept that has a particular
implementation in the SAP cloud solution. A concept can be specific to one or more views or can span several
business areas or even application areas.

Structure of Concept Documents

Keyblock Answers the Following Questions

Title What is the name of the concept?

Overview When and why is the concept relevant for the target group?
What is the business context?
Is the concept country or industry-specific?
What does the target group need to know about the concept?

Prerequisites Are there any steps or settings (for example, business configuration activities) that need to be carried
out before execution of this concept is possible?

Freestyle Subheadings Which keyblock header(s) are needed to structure the document in a meaningful way?

See Also Where can the user find more information? (cross-reference)

● Process Documents
Process documents cover a sequence of logically related events or steps that have a specific outcome or
result in the SAP cloud solution. A process can be specific to one or more views, or can span several business
areas or even application areas.

Structure of Process Documents

Keyblock Answers the Following Questions

Title What is the name of the process?

Overview When and why is the process relevant for the target group?
What is the business context?
Is the process country or industry-specific?
What does the target group need to know about the process?
Is the process mainly user-driven or system-driven?

Prerequisites Are there any steps or settings (for example, business configuration activities) that need to be carried
out before this process can be executed?

SAP Cloud Applications Studio – Version May 2018 (1805)

718 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
 Keyblock Answers the Following Questions

Process Flow What are the steps involved in the process?

Are there any variants of the process?

See Also Where can the user find more information? (cross-reference)

How-To Documentation
This reference documentation provides a user with the step-by-step information they require to be able to perform
a task in the system. Typically, it also includes information that the user needs to know before and after the
completion of a task.

Structure of How-To Documentation

Keyblock Answers the Following Questions

Title What is the name of the task? Precede the activity name by a verb, for example Create Opportunity.

Overview What are the purpose and result of this task?

Why or when should the user perform this task?
Does the user need any additional background information to help them understand the concept
behind the task?

Prerequisites What does the user need to do before performing this task?
Which basic settings need to be in place before the user can perform this task?
What are the preceding processes or tasks, and where do they take place?

Steps What specific action does the user need to take to perform this task?
In which sequence should the user perform these steps? (If applicable, also explain what the result
of each successive action is.)

Result Does the completion of this task trigger further processes or tasks, or does it have an impact on
other processes or tasks?
If so, what are these follow-on processes or tasks?

Alternatives Is there an alternative way of performing this entire task?

Example Is there an example of this task?

See Also Where can the user find more information related to this task? (cross-reference)

Org Functions
An org function is a predefined entity in the system that denotes functional responsibility for aspects of one or more
business processes. In Organizational Management (OM), the administrator in the SAP cloud solution assigns org
functions to org units in order to define the role of each org unit within the context of the organization’s overall
business operation. The org function assignment for a given org unit influences work center/tab proposals for users
assigned to this org unit. Each org function document describes a specific org function in terms of the associated
business processes, business documents, and work centers. The purpose of org function documentation is to
support the OM administrator who is responsible for modeling the org structure and assigning org functions to the
org units.

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 719
Structure of Org Function Documentation

Keyblock Answers the Following Questions

Title What is the name of the org function?

Overview To which functional area is the org function related?

What are the associated business processes, business documents, and tasks?
What are the associated work centers/tabs?

Relevance From an organizational and operational point of view, when or why should the customer use this org
function?
What are the implications of not using it? What are the benefits?
Are there any unusual use cases?

Configuration What are the business configuration prerequisites for using this org function?

Constraints What constraints apply to the use of this org function within the context of the org structure?

Work Distribution Which work category or work categories are associated with this org function?

Example Is there an example that shows how this org function can be used?

See Also Where can the user find more information related to this org function? (cross-reference)

Quick Guide Documentation

A Quick Guide provides a user with a “quick” overview of a view. It is also the central entry point for accessing more
detailed information related to the view. That is, for a more in-depth understanding, the user has the option of reading
the documents linked from the Quick Guide. The Quick Guide provides the following key elements:
● Summary of what the view is used for
● Business background
● Tasks that can be performed

Structure of Quick Guide Documentation

Keyblock Answers the Following Questions

Title What is the name of the view followed by “Quick Guide”? For example, “Opportunities Quick Guide”.

NO HEADER What is the view used for in summary?

Business Background What are the key concepts and processes?

What are the related business scenario(s)?

Tasks To which business area does this belong?

What are the tasks that the user can perform?

Work Category Documentation

A work category (also known as responsibility) represents a type of work related to an org function. It contains rules
that determine which set of work items is distributed to which org unit or employee. This is known as the process of
work distribution where a work item can be any business document or a task in Business Task Management (BTM).
The distribution of work items is usually defined by the access rights that are given to a user. However, by using work
categories, work items can be directly assigned to a specific org unit or employee. Each work category provides a
set of parameters that can be used to define work distribution rules for the related work items.
The system provides specific work categories for organizational work distribution and employee work distribution.

SAP Cloud Applications Studio – Version May 2018 (1805)

720 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
Each work category document describes a specific work category in terms of the associated business process,
business documents, tasks, parameters, and work distribution rules. The primary purpose of work category content
is to support administrators who are responsible for effective distribution of work in the system.

Structure of Work Category Documentation

Keyblock Answers the Following Questions

Title What is the name of the work category?

Overview Is the work category relevant to organizational work distribution or employee work distribution?
What are the associated business processes and business documents?
What are the related work centers/view/tabs?

Prerequisites What are the prerequisites for using this work category?
Are there any configuration (fine-tuning) activities that are relevant for this work category?
Which org function must be assigned?

Work Category Which parameters are used to determine the responsibility?

Parameters

Work Distribution How does this work category support the distribution of work in the system?

Example Is there an example that shows how this work category can be used?

See Also Where can the user find more information related to this work category? (cross-reference)

10.3.1.6 Structure of Release Information

Overview
This document provides a brief overview of documenting release information covering changes to the system
between releases.

Business Configuration Delta Documentation

Business Configuration (BC) Delta documentation provides information on all changes that have taken place since
the last release in the configuration of the system that impact customer settings.
The changes usually refer to settings that the customer performed during scoping and to settings made from the
activity list. These scope selections and activities are reflected in elements in the business adaptation catalog (BAC).
The BAC elements are known as business configuration elements.

Structure of BC Delta Documentation

Keyblock Answers the Following Questions

Title What is the BC Delta called?

Use the following guidelines for the title:
● For a new BAC element, use “New: <Name of BAC Element>”
● For a changed BAC element, use “Changed: <Name of BAC Element>”
● For a deleted BAC element, use “Deleted: <Name of BAC Element>”

Relevance What elements did the customer select in order to include this element in their scope?

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 721
Keyblock Answers the Following Questions

Overview of What is the current setting?

Changes What is the issue or challenge that needs to be addressed?
What is the solution?

Details What are the new or changed features?

What is the affect of this change on the behavior of the system?
Is there additional information that may be relevant to the customer?

Required What are the activities that are required from the customer?
Actions

What's New Documentation

What’s New documentation is a series of documents that, taken as a whole, describes what is new and what has
been changed or deleted in a particular version of the standard system. The first document in the series describes
system-wide changes. Depending on the level of change within each area and its parts, other documents may be
created for specific areas (for example, for Customer Relationship Management), topics (for example,
Organizational Management), or views (for example, Opportunities).

Structure of What's New Documentation

Keyblock Answers the Following Questions

Title To which area of the solution does this information apply?

Overview To which version and area of the solution does this information apply?
Which topics are covered?

What Is New What is the new development or function?

What are the business benefits of using the new development or function for the customer?
How does the new development or function affect the user interface (for example, fields, menu paths, and
screen title)? Only mention implications that are relevant for the customer.
What actions must the customer take to use the new function (for example, in business configuration)?
How does the new development or function affect existing data such as master data or transactional data?
What is the impact of this new development or function on other areas of the solution (for example, on
business processes or scenarios)?

What Has What is the changed development or function?

Changed What are the business benefits of using the changed development or function for the customer?
How does the changed development or function affect the user interface (for example, fields, menu paths,
and screen title)? Only mention changes that are relevant for the customer.
What actions must the customer take to use the changed function (for example, in business configuration)?
How does the changed development or changed function affect existing data such as master data or
transactional data?
What is the impact of this change on other areas of the solution (for example, on business processes or
scenarios)?
Which relevant terms have been changed?

SAP Cloud Applications Studio – Version May 2018 (1805)

722 © 2018 SAP SE. All rights reserved. • P U B L I C Style Guides and Reference Guides
 Keyblock Answers the Following Questions

Country-Specific What is the new/changed development or function for a specific country?

Changes What are the business benefits of using the new/changed development or function for the customer?
How does the new/changed development or function affect the user interface (for example, fields, menu
paths, and screen title)? Only mention changes that are relevant for the customer.
What actions must the customer take to use the new or changed function (for example, in business
configuration)?
How does the new development or changed function affect existing data such as master data, or
transactional data?
What is the impact of this change on other areas of the solution (for example, on business processes or
scenarios)?
Which relevant terms have been changed?

See Also Where can I find further information about related topics (for example, related BC Delta documents)?

SAP Cloud Applications Studio – Version May 2018 (1805)

Style Guides and Reference Guides P U B L I C • © 2018 SAP SE. All rights reserved. 723
11 Copyright / Legal Notice

© 2017 SAP SE or an SAP affiliate company. All rights reserved.

No part of this publication may be reproduced or transmitted in any form or for any purpose without the express
permission of SAP SE or an SAP affiliate company.
The information contained herein may be changed without prior notice. Some software products marketed by SAP
SE and its distributors contain proprietary software components of other software vendors. National product
specifications may vary.
These materials are provided by SAP SE or an SAP affiliate company for informational purposes only, without
representation or warranty of any kind, and SAP or its affiliated companies shall not be liable for errors or omissions
with respect to the materials. The only warranties for SAP or SAP affiliate company products and services are those
that are set forth in the express warranty statements accompanying such products and services, if any. Nothing
herein should be construed as constituting an additional warranty.
SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or
registered trademarks of SAP SE (or an SAP affiliate company) in Germany and other countries. All other product
and service names mentioned are the trademarks of their respective companies. Please see http://www.sap.com/
corporate-en/legal/copyright/index.epx for additional trademark information and notices.

icon courtesy of W3C, see http://creativecommons.org/licenses/by/3.0/ .

SAP Cloud Applications Studio – Version May 2018 (1805)

724 © 2018 SAP SE. All rights reserved. • P U B L I C Copyright / Legal Notice
12 Glossary

This glossary defines terms that you will encounter while working in the studio and with the product documentation.

access control
A method of allowing and restricting user access rights for a work center view based on the access control list of a
business object. For example, instance-based access control can be used to allow access to company-specific data
only.

access control list

A list of access groups that is needed to perform authorization checks for business object instances.

action
A script file that executes business logic at a particular point in time within the business object’s lifecycle. Actions
can be triggered from the user interface or from events or other actions.

action code
A coded representation of an instruction to the recipient of an XML message. For example, 01 is the action code for
Create, 02 for Change, and so on.

activity list
A structured collection of mandatory and critical tasks, generated from the customer's scoping, that must be
completed either before the solution can go live for the first time or before changes can be implemented later in the
solution life cycle. The activity list may also include optional activities that can be completed at any stage.

add-on solution
A solution that enables the implementation of additional business logic in an SAP solution and the development of
enhanced functions for business users.

Administration toolbar
A set of functions that allows administrators to manage solutions.

administrator
A system user who has administrator rights in an SAP cloud solution. You use this user in the studio if you want to
define analytics content or create a mashup. To use the administrator user, you enable admin mode for a solution
in the studio.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 725
advanced search
A search that allows the user to combine free text search and attribute search. The user can specify the search,
display, and filter options to locate the item they require.

alert
A task with the highest available priority that requires immediate user action.

alternative key
An annotation with which you define a unique key of a business object node. You can it in an association and it is
stored as an additional key field in data searches and queries.

Analytics
Analytics provides you with the necessary infrastructure for the analysis of your enterprise. A set of predefined
reports from all business areas is available that cover the most important reporting needs.

anchor
A stable point to which any user interface modifications to SAP floorplans are attached.

Application and User Management

A work center that allows administrators to perform application administration tasks and to manage access rights.

application log
A support mechanism for mass data runs. Mass data runs run in the background. No direct feedback is provided to
the user on what exactly has happened is given, so the application log allows users to retrace the results.

application-to-application communication
A process by which messages containing information about updates to business documents are sent between
process components within the system. For example, when creating a sales order, the system updates related
business documents within the system.

approval notification
An electronic message sent to the requester to indicate that approval has been granted or rejected by the authorized
approver.

SAP Cloud Applications Studio – Version May 2018 (1805)

726 © 2018 SAP SE. All rights reserved. • P U B L I C Glossary
approval process
One or multiple steps by which a business document is addressed to one or more employees responsible for approval,
including any defined conditions.

Approval Processes
A work center view in which you can display, edit, copy, and delete versions of approval processes related to business
documents.

approval status
An indicator of the step reached in the approval workflow of an object, for example, an invoice that has to be reviewed
by an authorized approver could be listed as "waiting for approval".

approval task
A part of an approval process. Approval tasks are approval, approval/rejection notifications, and revision.

Approval Wizard
A guided activity for creating a default approval process for a custom business object in the studio.

assigned work centers

A work center which a user can access to do their work.

association
A relationship between two business object nodes.

asynchronous communication
A form of electronic communication that does not take place in real time. E-mail is an example of electronic
asynchronous communication.

availability
The capacity of a service or a component to fulfill its required function at a specific moment or over a set time period.
Usually, this is measured using an availability ratio, which compares the length of time that the service has been
available with the duration agreed with the customer.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 727
BAC element
A project item for business configuration such as a business option or a business topic that is required to activate a
solution in a customer system. In the standard SAP solution, a BAC element is a scoping element and can refer to
any level of the business adaptation catalog hierarchy, including business packages, business topics, and business
options.

BO Browser
Tab of the BO Browser/Data Model tool window in the UI designer. It displays a business object as a tree structure
with all available nodes and fields.

browser-based report
A type of report that can be viewed in a Web browser.

build
The version of a studio installation.

business adaptation catalog

A central structure that uses business language to describe and organize all the capabilities of SAP solutions. It
structures the capabilities into a hierarchy of business areas, packages, topics, and options. Customers and
prospects make selections from the catalog based on their specific business needs. The catalog enables change
both during the initial setup of the solution and throughout its life cycle.

Business Analytics
A work center that enables key users to create and assign reports, and to create and edit key performance indicator
evaluations.

business area
The first and highest level in the hierarchy of the business adaptation catalog. It represents the collective group of
functions that the solution supports in a specific part of the company. Examples are sales and human resources.
Each business area contains a number of business packages.

business configuration
The process of adapting the solution to the day-to-day business requirements of the customer at any time in the life
cycle of the solution without the need for technical skills.

SAP Cloud Applications Studio – Version May 2018 (1805)

728 © 2018 SAP SE. All rights reserved. • P U B L I C Glossary
Business Configuration
A work center where users can configure the solution to meet their specific business requirements. You can access
the Business Configuration work center both before and after initial go live, but different functionality is available to
you depending on what stage you are at in configuring your solution.

business configuration content

Project items that are anchored in the business adaptation catalog to allow key users to implement a solution in the
production system. Examples include business options and business topics, business configuration sets, and
business configuration views.

business configuration object

A project item for business configuration that represents a configuration table and is used to create business
configuration sets. A business configuration object is a business object category.

Business Configuration Object Wizard

A guided activity for creating a business configuration object that is then used to create a business configuration
set.

business configuration set

A technical container for the configuration settings and corresponding values that are associated with a business
option. The content in a BC set is deployed to the runtime environment where it is loaded into the underlying
configuration tables. Each configuration setting in a BC set has attributes that specify whether it is hidden, visible,
or changeable for customers.

Business Configuration Set Wizard

A guided activity for creating a business configuration set based on a business configuration object.

Business Configuration Wizard

A guided activity for creating business options and business topics and anchoring this business configuration content
in the business adaptation catalog.

business document
A representation of a business object that has a definite format and contains structured information necessary for
business transactions. Examples include invoices, quotes, proposals, requests, purchase orders, and production
orders.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 729
business object
A model of a real-world object, for example, an employee or a sales order in business application systems.

business object extension

An SAP business object that has been extended to include additional fields.

business object instance

A representation of the object type of a business object. For example, the sales order numbers 12345 and 56789 are
instances of the Sales Order business object type.

business option
The fourth level in the hierarchy of the business adaptation catalog. Business options can be hidden or can appear
in scoping, fine-tuning, and/or the solution proposal. It represents the most detailed decision level involved in defining
or adapting a solution capability. Each business option specifies a particular way to perform a function. It is based
on predefined content. Examples are General Ledger Accounting and Customers. Each business option belongs to
a business topic.

business package
The second level in the hierarchy of the business adaptation catalog. It covers the organization, processes,
management support and master data of a given application area. Each business package belongs to a business
area and contains a number of business topics.

Business Task Management

An integral part of the system which manages the prioritization and assignment of tasks to the appropriate users.

Business Task Management

A work center view that enables users to monitor unassigned items and automated tasks with errors.

business topic
The third level in the hierarchy of the business adaptation catalog. It relates to specific functions within an application
area. Examples are Account Management and Time Administration. Each business topic belongs to a business
package and contains a number of business options.

business user
A user that can log on to the system. You grant access rights to users by assigning work centers or work center views
to their business user.

SAP Cloud Applications Studio – Version May 2018 (1805)

730 © 2018 SAP SE. All rights reserved. • P U B L I C Glossary
business-to-business
Electronic transactions between one business and another, for example, between a supplier and a retailer. Business-
to-business transactions are typically high volume and involve a long-standing business relationship.

calculated key figure

A key figure that is determined using calculation rules or formulas.

change transaction
An action that allows you to modify an SAP floorplan. For example, you can use a change transaction to add a view
to a standard work center.

characteristic
A field according to which values are selected. Characteristics are alphanumeric, numeric, or text values. Examples
include Product ID, Supplier, and Purchase Order Status.

chart of accounts
A systematic listing of all general ledger accounts used by an organization of one or more companies, normally in
alphanumeric order.

clarification request
A manually created task used for asking another user for more information on an item.

cloud solution
Software hosted by SAP, for example, SAP Business ByDesign.

code list
A field with a set of predefined values that is of data type Code.

Code List Data Type Wizard

A guided activity for creating a static code list in the studio.

collection
A table that is defined on the basis of business object nodes or node elements, for example, a collection of sales
order items.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 731
combined data source
A type of data source that combines two or more data sources. The data sources of which the combined data source
consists usually have a set of common characteristics but semantically different key figures.

common task
A task that you perform frequently, such as creating a sales order.

communication arrangement
An agreement between an organization and a customer, supplier, or partner to exchange business documents
electronically.

communication scenario
A set of predefined services for a business process that can be used to create a communication arrangement.

Communication Scenario Definition Wizard

A guided activity for defining a communication scenario in the studio.

communication system
A system that is used for application integration between the solution and an internal or external system.
Communication systems can be, for example, external time recording or master data systems.

compliance
The process of conforming to a specification, standard or law, for example a law relating to data protection.

composition
A navigational relationship from a superordinate to a subordinate node and vice versa: Composition associations
point from the parent to a child node and from the child to the parent node. They are automatically part of the business
object model when a node is created.

condition
A predefined filter to restrict the data displayed to a specified characteristic and key figure. There are two types of
conditions: simple and ranked.

SAP Cloud Applications Studio – Version May 2018 (1805)

732 © 2018 SAP SE. All rights reserved. • P U B L I C Glossary
configurable code list
A code list whose values can be changed by the customer in the scoping phase of SAP's cloud solution. A configurable
code list is created by defining a BC set for a business configuration object and selecting the "Create Code List Data
Type" option.

Configuration Explorer
A tool window in the UI designer that displays the SAP repository content.

content area
The area of the application window for performing user tasks. The content area is visible on every page and changes
when the user navigates from one page to another.

continuous improvement
A commitment by SAP to regularly analyze all aspects of a customer system configuration and then identify
improvement potential and recommend actions. The analysis covers a range of issues including KPIs and
bottlenecks. Actions SAP can recommend include changing system settings and installing delivery patches.

control
A component of a floorplan such as an input field or a button.

Controller
A tab in the content area of the user interface designer. On the Controller tab, you define the interaction between
user interface components by creating event handlers, interfaces, navigations, and queries.

Core Component Technical Specification

Describes a methodology for semantic data modeling that achieves a common understanding of data message types
on a syntax independent level. Developed by UN/CEFACT and ISO Technical Committee.

Create Form Wizard

A guided activity for creating print forms, defining form properties, and defining country and language-specific form
variants.

custom business configuration object

A business configuration object created as part of a solution in the software development kit.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 733
custom business object
A business object defined as part of a solution in the software development kit.

custom control
A user interface control created in Microsoft Visual Studio using Microsoft Silverlight. The control can be used in the
studio to enhance screens in the SAP solution.

custom pane
A user interface pane created in Microsoft Visual Studio using Microsoft Silverlight. The control can be used in the
studio to enhance screens in SAP solutions.

custom query
A query created as part of a solution in the software development kit.

custom reuse library

A collection of user-defined functions. You can use a library to organize the code in your solution or to reuse code in
several script files.

customer-specific field
An extension field in a cloud solution.

customer-specific solution
A partner solution that the partner designs and develops for a specific customer.

Data Model
Part of the BO Browser/Data Model tool window and tab in the content area of the user interface designer. The Data
Model displays the data structure of the business object. You can edit the structure and bind the data model elements
to the business object elements.

data source
An object containing key figures and characteristics, which provides a multidimensional view of business data for
reporting.

SAP Cloud Applications Studio – Version May 2018 (1805)

734 © 2018 SAP SE. All rights reserved. • P U B L I C Glossary
Data Source Wizard
A guided activity for creating and defining a data source. In addition, you can define transformation rules, define
aggregation behavior for key figures, and reference other data sources.

default approval process

A process created in the studio for a custom business object for use in an SAP solution. A default approval process
has one approval step, no conditions, and unlimited validity.

dependent object
A reusable part of a business object that cannot stand alone but can only be used in the context of the business
object.

deploy a solution
Upload a solution to a customer system or to a test system.

deploy business configuration

Make business configuration content created in the studio available in the system.

deployment unit
A piece of software that can be operated on a separate system isolated from other pieces of software. All deployment
units can communicate directly with the Foundation deployment unit.

derived name
The default naming convention provided by the software development kit to name a message data type in a Web
service operation. A derived name is based on the names of the service operation and the business object element
on which the service operation is allowed to be performed.

Design Data Sources

A work center view in which you can create, edit, and delete data sources and create reports.

Designer
A tab in the content area of the user interface designer. On the Designer tab, you design the user interface of an
application with the controls available in the Toolbox.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 735
Design Reports
A work center view in which you can create, edit, delete, and assign reports to work center views.

details area
An area of the screen providing details about a user selection. For example, if a user selects a row in a work list, the
details area provides details about that row.

developer desktop
The user interface of the studio that presents and provides access to development tools in an integrated development
environment (IDE).

dialog box
A box on the screen that a user must respond to before resuming work. Sometimes the user prompts the dialog box
to display and sometimes it displays without prompting.

dimension
A criterion by which characteristics are categorized.

dropdown list
A list of entries that a user can display by clicking a down-facing arrow to the right of the first entry in the list.

element
A component of the business adaptation catalog. An element is a general term that can refer to any level of the
catalog hierarchy, for example, a business package, topic, or option.

element
Part of a business object. Elements are displayed as fields on the UI.

embedded component
A reuseable user interface component that can be added to other floorplans.

embedded report
A report that is embedded in a specific context, such as in an overview document.

SAP Cloud Applications Studio – Version May 2018 (1805)

736 © 2018 SAP SE. All rights reserved. • P U B L I C Glossary
Employee Work Distribution
A work center view that enables the key user to define users responsible for specific work items.

endpoint
A location for accessing a Web service using a specific protocol and data format.

enhanced controller object

A special business object created only for user interface scenarios. It is needed to implement certain functions and
message handling. It is also used when two business objects have to interact in a way that is not declarable using
existing tools.

enhancement implementation
An extension of an enhancement option that allows customers to apply business rules that meet specific
requirements such as country-specific requirements.

enhancement option
An entity provided by SAP to allow the standard behavior of a specific application, such as Financials, to be enhanced
without modifying the standard solution.

enhancement option type

An attribute that indicates whether an enhancement option is for single use or multiple use.

enterprise search
An application that allows you to locate and view data stored in your system. You can search for structured, for
example purchase orders, and unstructured data, for example Microsoft Word documents. This data is organized
into the following categories: Files, People, Reports, and Business Objects.

error message
A message informing a user about an error. The message typically explains what went wrong, why it went wrong,
and what the user can do about it. Most error messages display in the message area of the screen. However, if the
system requires that the user must respond to an error, the error message displays in a dialog box.

event
A script file that executes business logic at a particular point in time within the business object’s lifecycle, for example,
before save or after modify.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 737
exception
A deviation from a defined threshold value or interval. Exceptions can be applied to data, results, or a combination
thereof and can be displayed as an arrow, background color, or traffic light.

exception aggregation
Aggregation behavior, which deviates from standard aggregation (such as summation), for values of a calculated
key figure. The deviation is only valid for a specified characteristic.

extendable node
A node of an SAP business object that can be enhanced with additional fields, the so-called extension fields.

Extensibility Explorer
A tool window that displays the anchors attached to a floorplan.

extension field
A field that has been added to an SAP business object. Extension fields can be used, for example, in screens, forms,
reports, and search categories.

extension scenario
A representation of all business contexts that are part of a process flow in which an extension field may be involved.

External Web Service Integration Wizard

A guided activity for integrating an external Web service into the partner solution using SOAP or REST.

fact sheet
A fact sheet is a one-page read-only overview of an object. It displays the object properties, can have different views,
and can contain links for navigating to related objects. You can model this overview in the UI designer.

favorites
A location where hyperlinks to commonly viewed content (for example, reports and business documents) or Web
pages can be stored and easily accessed.

file input
A general method for uploading external data files on specific interfaces into an SAP solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

738 © 2018 SAP SE. All rights reserved. • P U B L I C Glossary
file input run
A mass data run that uploads data files from external applications into the SAP cloud solution, using existing service
interfaces.

filter
To retrieve data that matches user-defined filter criteria.

filter
A project item that belongs to an enhancement implementation that allows users to work with a specific set of data.

fine-tuning
The configuration of the solution to meet customer requirements that exceed the level of predefined content in the
software. It is based on input and selections made during scoping and occurs before the solution goes live.

fine-tuning project template

A project item for business configuration that contains predefined fine-tuning activities for a specific scenario that
is defined by SAP, such as Financials: Chart of Account.

flag
The marking of a business document for later reference, using a flag icon.

foreign key relationship

A relationship between two business object nodes for which the alternative key of the target node is specified.

form data type

A form-specific data type based on an existing data type.

form data type extension

An SAP form data type that has been extended to include additional fields.

Form Template Selection

A work center view that enables key users to create form template rules for business documents.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 739
Form Wizard
A guided activity for creating print forms, defining form properties, and defining country and language-specific form
variants.

front-end script
A programming language used in the User Interface Designer to define rules and logic that determine the behavior
of user interface (UI) controls. For example, you can write a front-end script that enables an Edit button only when
a user selects a field on the UI.

full-text search
Search on an index that contains all words that occur in the indexed documents instead of only abstracts or other
metadata.

Gallery
A work center view that allows you to browse reports.

Gantt chart
A graphical display of schedule-related information. Project elements are listed on the left of the chart, the timescale
is across the top, and activity durations are shown as date-based horizontal bars.

guided activity
A secondary window consisting of a series of interactive screens that guides you through each step of a particular
activity. For example, the New Invoice guided activity guides the user through the steps involved in creating a new
invoice.

Guided Activity Floorplan

A floorplan for an activity that can be divided into a logical sequence of steps. It consists of a series of screens that
guide the user through an activity to complete a specific task.

HTML mashup
A mashup that integrates HyperText Markup Language (HTML) or JavaScript content as embedded content.
Examples include an online map, a widget, or social networking information.

icon
A small pictorial or graphical image that represents an object, action, or status.

SAP Cloud Applications Studio – Version May 2018 (1805)

740 © 2018 SAP SE. All rights reserved. • P U B L I C Glossary
inbound service
A Web service that a partner creates based on an SAP business object or a custom business object.

incident trace
A trace that is attached to a support request.

Incidents
A work center view in which a key user resolves incidents or forwards them to the provider for resolution.

information icon
A symbol on the user interface that can be found next to entry fields. When you click on the icon, the system displays
useful text.

inport
A port configured to receive a navigation key from the source user interface. This key is used by the target user
interface to fill business data.

input field
Element of the user interface. An input field consists of a field name and an input area. You can enter and edit texts
in the input area.

installation key
A series of numbers generated by the partner for a multi-customer solution. The installation key enables the partner
to upload the solution to a customer tenant.

integrated solution
A solution that enables the integration of applications with SAP's cloud solution. An example is an external Web shop
application that creates sales orders in SAP's cloud solution.

IP address
A unique address used to identify a node in an IP network.

item
A business object, record, or piece of information in the system. Examples are Account, Contact, Lead, and feed
update.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 741
joined data source
A type of data source that joins two or more data sources. The joined data source consists of a subset of
characteristics that are the same in the data sources to be joined along with semantically different key figures.

key figure
A field according to which values are selected. Key figures are numeric values that have a unit of measure or currency
assigned. Examples include Invoice Net Value and Purchase Order Quantity.

key figure grid

A group consisting of a key figure structure and a characteristic structure for reporting on two axes.

key figure group

A key figure structure or key figure grid.

key figure structure

A group of predefined key figures for reporting on one axis.

local help
Context-sensitive studio documentation that is displayed in the MS Help Viewer where you can use a full-text search.

local trace
A trace that is run in the system in which it was created.

localization
The process of adapting a product to meet the needs and expectations of a specific country or region, with respect
to language, laws, business practices, or culture.

log out
To end a previously authenticated session of the application. When you log out, you can no longer use the application.
To use the application again, you must log in again.

maintenance mode
The status of a solution after it has been assembled. You can make changes to the solution in a patch but only
restricted changes to certain content types. With these change and delete restrictions, SAP wants to avoid loss of
data as well as inconsistencies and errors in the productive customer's solution.

SAP Cloud Applications Studio – Version May 2018 (1805)

742 © 2018 SAP SE. All rights reserved. • P U B L I C Glossary
mashup
A Web service or application that has been integrated into an SAP cloud solution. Mashups combine and transform
internal business data with information or services provided by external online service providers.

Mashup Authoring
A work center view in which key users or administrators can create and edit mashups.

mashup in-port
The incoming data connection between a screen and a mashup. The mashup in-port is used to input business data
from the system into the mashup. This data comes from the screen out-port and can contain multiple parameters.

mashup out-port
The outgoing data connection from a mashup to a screen. The mashup out-port is used to pass the result of the
mashup to the system. This is then mapped to the screen in-port.

mashup solution
A solution that enables the integration of Web-based applications or services into the user interface of SAP's cloud
solution. An example is the integration of a Web application for maps and route planning into a user interface
displaying the address of a business contact.

mashup type
The categorization of mashups by the technology on which they are based. Examples include a URL mashup or HTML
mashup.

mashup Web service

A third-party Web service that a key user or an administrator can integrate into an SAP cloud solution so that it can
be used by mashups.

Mashup Web Services

A work center view in which key users or administrators can integrate third-party Web services into an SAP solution
so that they can be used by mashups.

mass data run

The automatic mass processing of a business transaction. An invoice run is an example of a mass data run.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 743
mass data run object
A business object specifying an automatic mass processing of a business transaction. It contains the selection
criteria and the processing results.

Mass Data Run Wizard

A guided activity for creating a mass data run for a custom business object in the studio.

mass-enabled script file

An action or event that can be executed for multiple instances of a business object node.

message definition
A system notification and its attributes defined to assist customers who work with an enhancement implementation.

method tooltip
An on-screen explanation of a method and its parameter definition.

modal dialog
A small window that helps the user to perform a task. It is triggered from a calling application and has to be completed
before the user can continue to work in the calling application.

multi-customer solution
A partner solution that the partner can sell to multiple customers.

multiple-use enhancement option

Identifies an enhancement option that can be implemented more than once in the same solution.

My Solutions
A tool window in the studio in which you can create and access solutions in the repository of SAP's cloud solution.

navigation
The means by which a user can move around, within and between, screens. Navigation elements include menus,
links, and standard buttons such as Back, Forward, and Exit.

SAP Cloud Applications Studio – Version May 2018 (1805)

744 © 2018 SAP SE. All rights reserved. • P U B L I C Glossary
node
A group of elements in a hierarchical structure. For example, a business object can have several nodes that group
the business object elements.

non-extendable node
A node of an SAP business object that cannot be enhanced with additional fields, the so-called extension fields.

notification
Defined as part of the default approval process. Notifications are sent to the participants of an approval process to
inform them of a task to be carried out. In the studio, you can define an approval notification and a rejection
notification.

Notification Rules Wizard

A guided activity for enabling notification rules for a custom business object in the studio.

object-based navigation
A type of user interface interaction. When you create an object-based screen scenario, you create a work center with
an object work list, a quick activity floorplan and an object instance floorplan.

object instance floorplan

A combination of UI patterns arranged in a specific order that allows users to create, delete, view, and edit attributes
and associations of a business object.

object work list

A list pane that is embedded in a work center view.

online help
Built-in documentation for the studio that is displayed in the Web browser.

operand
A numeric value upon which an operation is performed.

operator
A symbol that describes an operation to take place between two or more values.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 745
outbound service
An external Web service that a partner integrates into the cloud solution.

outport
A port configured to pass the navigation key from the source user interface to the target user interface.

Output Channel Selection

A work center view that enables key users to create output channel rules for the process-integrated output of
business documents.

pane
A section of a floorplan.

parameter binding
Mapping of a URL parameter to a screen out-port.

partner solution
A business solution that is designed and developed by an SAP partner to enhance an SAP cloud solution.

password
A combination of alphanumeric characters used by a user to gain access to the system.

patch
Changes or corrections to a customer-specific solution after it has been assembled.

permissions
A set of policies describing whether an identity is allowed to access a certain program or piece of information. The
permissions, also called access rights, are grouped into work centers. The work centers can then be assigned to
identities, for example, to a user.

personalize
To change or customize something to suit your needs. For example, change the way that your desktop is configured
so that you have easy access to the applications you work with.

SAP Cloud Applications Studio – Version May 2018 (1805)

746 © 2018 SAP SE. All rights reserved. • P U B L I C Glossary
placeholder
A symbol or chain of symbols that, at runtime, is replaced by text or numbers.

port binding
A grouping of predefined screen out-ports and in-ports that can be used to create a mashup. The port binding defines
the type of information that can be used in the mashup and defines on which screens you can use the mashup.

port type package

A blueprint for an inport or an outport. A port type package hosts one or more port types.

process communication error

An error that occurs if the system cannot process a message sent from one business object to another during an
update of business data.

Process Communication Errors

A work center view that allows key users to monitor application-to-application and business-to-business
communication errors.

process extension scenario

A type of extension scenario that links the data from one business context to other related business contexts. You
create an extension scenario from a list of predefined extension scenarios.

production environment
A reserved space that is used by an individual prospect or customer to store all information needed to operate its
live solution and run its business. Since any changes that are made here have a direct affect on the running system,
the customer typically performs changes and any related testing activities in a separate environment before doing
so in the live production environment.

production system
A system used by the customer to work with the solution after it has gone live. This system contains all of the elements
required to run the customer's business processes using the SAP cloud solution and can be adapted in the Business
Configuration work center using immediate changes and change projects.

project
A container that is used to organize all items of a solution, for example, business objects, screens, and business
configuration content.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 747
project item
A file in a project, for example, a business object, a screen, or a form.

Property Explorer
The Properties tool window of the user interface designer. You can view and change properties for each element in
the user interface model.

provider
The party responsible for providing IT services or a product to a customer. This can be performed by an in-house
provider or a third party.

public solution model (PSM)

Contains all entities in SAP's cloud solutions that are released for external consumers. External consumers can be
partners who develop solutions on top of SAP's cloud solutions or administrators who create new reports.

Query Wizard
A guided activity for creating a query, selecting query fields, and defining query parameters.

quick activity
A secondary window consisting of a single interactive screen that allows you to complete a particular activity. For
example, the Create Incident quick activity allows you to request support from a key user.

quick activity floorplan

A screen layout that allows users to quickly perform a self-contained or short subtask of a larger task.

quick create floorplan

A preview of detailed information on a thing that a user can see without navigating away from the UI currently
displayed. Data shown in a quick create view cannot be edited.

quick view floorplan

A slide-in window, which allows users to edit data without navigating away from the UI currently displayed.

radio button
Element of the graphical user interface. A radio button consists of a round element and a descriptive text. You can
use a radio button to select one item only from a list of items.

SAP Cloud Applications Studio – Version May 2018 (1805)

748 © 2018 SAP SE. All rights reserved. • P U B L I C Glossary
radio button group
A control in the Toolbox that consists of a UI text and two radio buttons.

refresh
To update a screen, or part of a screen, so that it displays the most current information.

report
A compilation of data for evaluation where online analysis and drill-down is supported in every possible direction and
on a very detailed level. Analytical reports are ideal for detailed root cause analysis.

report category
A category by which reports are grouped from a business perspective.

report incident
A function that allows the user to report an incident from any screen within the application.

report wizard
A guided activity with which you can create or change your own reports.

Repository Explorer
A tool window that displays SAP content, such as business objects and data types, which is released with the public
solution model (PSM). It also displays the documentation for the different entities.

requester
A person who creates an approval process in SAP's cloud solution.

reset
A function that enables you to return to the original state of a document or application.

resolution
The action taken to solve an incident. Examples of resolutions include patches and work-arounds.

REST Web service

An HTTP-based Web service that is based on REST (Representational state transfer) architectural concepts.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 749
retention time
Period of time data are stored in a system.

reuse library function

A self-contained module of code that operates on values passed to it and typically returns a result.

revision
Task that is part of the approval process. It is sent to the person who created the approval process and informs him
or her that the approver has requested changes to the request.

revision task
The task created by the system requiring a user to change data entered because it contains errors or because a
change is necessary.

rollover explanation
A brief text that provides instructions or other explanatory information about UI elements, such as fields, buttons,
column headers, tab titles, radio buttons, and check boxes, in cases where the label is not self-explanatory. A rollover
explanation is displayed when the user points the mouse cursor on the UI.

RSS
A method for publishing content such as news headlines, blogs, or podcasts on the Web using an XML (Extensible
Markup Language) file format. The content is automatically updated on a regular basis, and alerts users to new
information.

RSS Feed
A document that is either the entire text or the summary of the content of an associated Web site.

RSS/Atom Web service

A Web feed using Really Simple Syndication (RSS) or Atom standards.

SAP Cloud Applications Studio

A software development kit (SDK) that enables SAP partners to adapt and enhance the solution capabilities of SAP's
cloud solution. The development tools provided are presented in an integrated development environment (IDE)
based on Microsoft Visual Studio.

SAP Cloud Applications Studio – Version May 2018 (1805)

750 © 2018 SAP SE. All rights reserved. • P U B L I C Glossary
SAP reuse library
A collection of functions provided by SAP that you can use to perform common tasks such as date conversion or
time calculation.

scoping
The process of matching business requirements to the capabilities of the solution, using the business adaptation
catalog.

scoping question
An important question the customer answers during scoping to select or deselect a business option from the
business adaptation catalog. An example of a scoping question for the Data Migration business topic is “Do you want
to migrate data using the built-in migration tool?”

screen out-port
The outgoing data connection from a screen to a mashup. This allows the data from the screen to be passed to a
mashup in-port.

script file
A project item that contains business logic for a solution.

scripting language
The programming language used in the studio to define business objects and business object extensions and to
implement the business logic.

scripting language compiler

A program that transforms code written in the studio into a language that can be used to execute the code.

search
To look for specific data in business documents, worklists, or the system.

search category
A group of objects with a similar theme that allows users to limit the scope of a search. Categories include Files,
Reports, Business Objects, and People, for example employees.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 751
search criteria
The specific values that you look for while doing a search. For example, if you search for all documents created on a
certain date, that date is the search criteria.

search result
A list generated after the user specifies the search criteria and executes a search.

section group
An area on the UI that contains information such as fields, links, or lists that belong together semantically.

segregation of duties
A measure used in the prevention of fraud by separating business processes so that more than one person is
responsible for completing a task. This is done by assigning access rights and distributing responsibility between
several users in the aim of reducing errors and preventing fraud.

service integration
Synchronous or asynchronous message-based communication between a business object and another
communication partner, such as a different system, by means of Web-service technology.

service integration definition

A project item containing service integration settings.

Service Integration Wizard

A guided activity for creating message-based communication between a business object and another
communication partner, such as a business object in a different deployment unit or a different system.

service level agreement

An agreement with the customer for the assurance of a specific service within a predefined period of time. Service
Level Agreements (SLA) define the attributes for service product (for example, maintenance, hotline) that have been
agreed upon with the customer in service contracts. The SLA confirms different parameters, such as response time,
availability time and system availability. The SLA effects the pricing for each contract item and the date calculation
in the service order, to which the relevant contract items refer.

service operation
A specification of a function with a set of message types assigned as signature exposed as a web service. It is grouped
by interfaces.

SAP Cloud Applications Studio – Version May 2018 (1805)

752 © 2018 SAP SE. All rights reserved. • P U B L I C Glossary
Session Administration
A tool window that displays active user sessions and provides functions for deleting sessions and item locks.

Session Administrator
A tool window that displays active user sessions and provides functions for deleting sessions and item locks.

shortcut
Quick access to a screen without using the common navigation path.

short ID
An identifier used to identify custom work center views in the UI designer and in the SAP cloud solution. You create
the short ID in the "Create Screens" dialog in the studio.

single-use enhancement option

Identifies an enhancement option that can only be implemented once in the same solution.

SOAP Web service

A Simple Object Access Protocol(SOAP)-based Web service.

solution
A container that is used to organize all items of a solution, for example, business objects, screens, and business
configuration content.

Solution Explorer
A tool window in which you can add, edit, and delete project items.

solution proposal
A document attached to an incident that describes a possible solution to the issue. The processor attaches one or
more solution proposals to an incident to provide the requester with information about how to solve the issue.

solution template
A container that is used to organize items that can be reused in customer-specific solutions.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 753
sort
To rearrange the content of a column in a table in ascending or descending order. The rest of the content in the table
is rearranged accordingly.

source language
The language from which text is translated. The source language supported by the studio is English.

static code list

A code list whose values cannot be changed by the customer. The static code list is created in the studio by using
the "Create a Code List Data Type" function.

step
A stage in a guided activity towards the completion of a task.

structure element
A characteristic, formula, or restriction in a characteristic structure.

Subject
A short description of an item, such as a task or notification.

subnode
A lower-level node in a hierarchical structure.

subview
A view that a user can open within a view.

system message
A short text that provides information about system feedback to the user. System message texts are displayed in
the message region as error messages, warnings, success, or information messages.

tab
A label that the user clicks to access content. Tabs display horizontally in a tab strip and are positioned above the
content that they describe.

SAP Cloud Applications Studio – Version May 2018 (1805)

754 © 2018 SAP SE. All rights reserved. • P U B L I C Glossary
tab strip
A horizontal row of tabs.

tag
A non-hierarchical keyword or term that is attached to an item. Tags are used to categorize or index items.

target language
The language to which text is translated. The target languages supported by the studio are German (DE), Spanish
(ES), French (FR), Portuguese (PT), and Chinese (ZH).

task
A unit of work that has to be performed by a user. Examples include Business Task Management tasks, IT Service
and Application Management tasks, and Activity tasks.

task description
Text that provides a brief explanation about a task.

task type
A predefined content type in the system. It has a set of properties such as task category and related business
document type which characterize the task. Each task type is related to one task category.

tax decision tree

A function that is created in the studio and used to automatically determine a tax event for a country that does not
have an SAP country version in SAP's cloud solution.

Tax Decision Tree Wizard

A guided activity for creating a tax decision tree.

technical user
A back-end process or service that is used to automate technical tasks in the system.

thing
The fundamental component of the current UI design concept and the conceptual entity with which end users work.
Things are smart and portable work objects such as a Material or a Business Partner. They embed attributes (data
or images), related objects, analytical data, and actions generated from metadata.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 755
thing inspector floorplan
Combination of UI patterns that allows the user to get a complete view of a thing. It shows all aspects of a thing and
is a compact summary of all primary attributes, the tags, and the actions that can be carried out.

thing type floorplan

Combination of UI patterns that describes the general UI properties of a thing, such as its name and various icons
on the UI, its binding against a business object, and its key.

thing-based navigation
A type of user interface interaction based on business objects defined as "things". This type of navigation is used in
SAP's cloud solutions (except for SAP Business ByDesign).

tooltip
A very short text that displays the name of a UI element when the label of the UI element cannot be seen or is only
partly displayed to the end user. A tooltip is displayed when the user points the mouse cursor on the UI element.

Toolbox
Tool window in the user interface designer. It provides the panes and controls that can be used to design the layout
of a user interface component on the Designer tab.

trace
A trace that is attached to an incident. Incident traces are tied to the life span of the incident.

Trace Explorer
A tool for gathering and analyzing diagnostic information.

trace sequence
The series of recorded method calls and evaluated trace messages that are created as a result of running a trace.

tracing
The process of creating and storing detailed information about runtime events in the system.

translatable text string

An element of a computer readable file that represents a text, such as a field label, a field value, or another user
interface text element. A translatable text string can be extracted from a file for translation into a target language.

SAP Cloud Applications Studio – Version May 2018 (1805)

756 © 2018 SAP SE. All rights reserved. • P U B L I C Glossary
translated text string
An element of a computer readable file that represents a text, such as a field label, a field value, or another user
interface text element, and that has been translated into a target language.

troubleshooting
A set of documents that provide solutions for typical problems or user errors. These documents are available in the
advanced search and in the search for incident reporting.

UI Designer
A tool that is part of the studio and that is used to design or enhance the user interface of the solution. You open the
UI Designer via the studio.

UI switch
A control in SAP's cloud solution that is used to restrict the visibility of UI changes.

unicode
A 16-bit character set that represents commonly used characters, for example letters and digits, in digital form.
Unicode has a distinct advantage over the 8-bit character set ASCII, in that it can render a much larger set of
characters. For example, Unicode can represent over 30,000 distinct coded characters, whereas ASCII can only
represent 128.

URL mashup
A mashup that sends data from the system to SAP's cloud solution to the Uniform Resource Locator (URL) of an
online service provider. The service provider uses the data, for example, to perform a search, and the results are
displayed in a new browser window.

user
A business object created for an employee or a service again who needs to log onto the system. It contains technical
information such as a password and access rights. Internal components also have user IDs assigned to them.

User and Access Management

A work center view that is used to edit and review user attributes and access rights. The User and Access
Management view is a superordinate view of the Business Users view and Support and Technical Users view.

user ID
A unique identifier for an individual who interacts with the services supplied by a system.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 757
user interface dependency
An action that governs the assignment of views to a user.

user interface designer

A tool used to design or enhance the user interface of the solution.

user management
The process of managing all users on the system. This involves applying basic settings such as user names and
passwords, assigning users to work centers, and placing restrictions on user access.

validation
A script file that returns either true or false based on a specified condition. Validations are triggered on the execution
of events or actions. A validation can raise a message or stop further processing of an event or action.

value selection
The value selected to which a characteristic is restricted. The data shown in a report is restricted to the values
selected so that not all data is displayed.

variable
A parameter of a report that restricts a characteristic to one or more specified value selections.

Web service
A Web-based application programming interface (API) that can be used to access external data provided by online
service providers. Using mashups, key users, and partners can integrate data provided by Web services with internal
data from SAP's cloud solution.

Web service authorization

The process of authorizing users to access a business object by using a service operation.

Web Services Description Language

An XML-based language that is used to describe the function of a Web service and how Web services can be accessed.

Web Services Inspection Language

A specification that supports you in searching for Web services that are available on a specific Web site. As a result
the Web services and their endpoints are listed in a Web Service Inspection document.

SAP Cloud Applications Studio – Version May 2018 (1805)

758 © 2018 SAP SE. All rights reserved. • P U B L I C Glossary
window
The element of the graphical user interface used for displaying data and applications.

work center
An area where a user can perform tasks or functions that they are responsible for within a company. Examples of
work centers are Purchase Requests and Orders and Personnel Administration.

work center proposals

A list of work centers proposed by the system based on the organizational assignment of the user.

work center view

A subdivision of a work center.

worklist
A list of items which may require user action.

XML Localization Interchange File Format

A standard XML-based file format used for exchanging bilingual content between systems during translation.

XML Schema Definition Language

An XML-based language that offers facilities for describing the structure and for constraining the contents of XML
documents.

SAP Cloud Applications Studio – Version May 2018 (1805)

Glossary P U B L I C • © 2018 SAP SE. All rights reserved. 759
13 Important Disclaimers on Legal Aspects

This document is for informational purposes only. Its content is subject to change without notice, and SAP does not
warrant that it is error-free. SAP MAKES NO WARRANTIES, EXPRESS OR IMPLIED, OR OF MERCHANTABILITY, OR
FITNESS FOR A PARTICULAR PURPOSE.

Coding Samples
Any software coding or code lines/strings (“Code”) provided in this documentation are only examples and are not
intended for use in a productive system environment. The Code is only intended to better explain and visualize the
syntax and phrasing rules for certain SAP coding. SAP does not warrant the correctness or completeness of the
Code provided herein and SAP shall not be liable for errors or damages cause by use of the Code, except where such
damages were caused by SAP with intent or with gross negligence.

Internet Hyperlinks
The SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a hint
where to find supplementary documentation. SAP does not warrant the availability and correctness of such
supplementary documentation or the ability to serve for a particular purpose. SAP shall not be liable for any damages
caused by the use of such documentation unless such damages have been caused by SAP's gross negligence or
willful misconduct.

Gender-Neutral Language
As far as possible, SAP documentation is gender neutral. Depending on the context, the reader is addressed directly
with "you", or a gender-neutral noun (such as “sales person” or “working days”) is used. If when referring to members
of both sexes, however, the third person singular cannot be avoided or a gender-neutral noun does not exist, SAP
reserves the right to use the masculine form of the noun and pronoun. This is to ensure that the documentation
remains comprehensible.

SAP Cloud Applications Studio – Version May 2018 (1805)

760 © 2018 SAP SE. All rights reserved. • P U B L I C Important Disclaimers on Legal Aspects
www.sap.com/contactsap

© 2018 SAP SE. All rights reserved.

No part of this publication may be reproduced or
transmitted in any form or for any purpose without the
express permission of SAP SE or an SAP affiliate
company.
The information contained herein may be changed
without prior notice. Some software products
marketed by SAP SE and its distributors contain
proprietary software components of other software
vendors. National product specifications may vary.
These materials are provided by SAP SE or an SAP
affiliate company for informational purposes only,
without representation or warranty of any kind, and
SAP or its affiliated companies shall not be liable for
errors or omissions with respect to the materials. The
only warranties for SAP or SAP affiliate company
products and services are those that are set forth in
the express warranty statements accompanying such
products and services, if any. Nothing herein should be
construed as constituting an additional warranty.
SAP and other SAP products and services mentioned
herein as well as their respective logos are trademarks
or registered trademarks of SAP SE (or an SAP affiliate
company) in Germany and other countries. All other
product and service names mentioned are the
trademarks of their respective companies. Please see
http://www.sap.com/corporate-en/legal/copyright/
index.epx for additional trademark information and
notices.

icon courtesy of W3C, see http://

creativecommons.org/licenses/by/3.0/ .