Table Of ContentSAP PRESS is a joint initiative of SAP and Rheinwerk Publishing. The know-how offered
by SAP specialists combined with the expertise of Rheinwerk Publishing offers the
reader expert books in the field. SAP PRESS features first-hand information and expert
advice, and provides useful skills for professional decision-making.
SAP PRESS offers a variety of books on technical and business-related topics for the SAP
user. For further information, please visit our website: http://www.sap-press.com.
Anil Bavaraju
SAP Fiori Implementation and Development (2nd Edition)
2017, 615 pages, hardcover and e-book
www.sap-press.com/4401
Goebels, Nepraunig, Seidel
SAPUI5: The Comprehensive Guide
2016, 672 pages, hardcover and e-book
www.sap-press.com/3980
Stefan Haas, Bince Mathew
ABAP Development for SAP S/4HANA: ABAP Programming Model for SAP Fiori
2018, 461 pages, hardcover and e-book
www.sap-press.com/4766
Paul Hardy
ABAP to the Future (3rd Edition)
2019, approx. 800 pp., hardcover and e-book
www.sap-press.com/4751
Carsten Bönnen, Volker Drees, André Fischer, Ludwig Heinz,
Karsten Strothmann
SAP® Gateway and OData
Dear Reader,
Few things inspire appreciation for the interconnectedness of our world like public
transportation. I admit that during my daily commute on the Boston MBTA, I’m not
exactly in awe of the intricate web of rails stretching across the city—I tend to be
impatient, or half asleep. These states of mind, however, demonstrate our reliance on,
and expectation of, a network of connections that allows us to get where we need to
go. Subway stations are one of many hubs of transportation connecting us to other
places, and they’re only becoming more essential.
It’s a similar story for data. If your SAP and non-SAP systems are the stations, then SAP
Gateway is your train that connects them. Your travel guide? This book, and the excellent
team of authors who’ve combined their SAP Gateway expertise to create this updated
and improved third edition. With their guidance, you’ll understand the ins and outs
of SAP Gateway, OData, and an interconnected digital network.
What did you think about SAP Gateway and OData? Your comments and suggestions
are the most useful tools to help us make our books the best they can be. Please feel
free to contact me and share any praise or criticism you may have.
Thank you for purchasing a book from SAP PRESS!
Meagan Fuerst
Editor, SAP PRESS
[email protected]
www.sap-press.com
Rheinwerk Publishing • Boston, MA
Notes on Usage
This e-book is protected by copyright. By purchasing this e-book, you have agreed to
accept and adhere to the copyrights. You are entitled to use this e-book for personal
purposes. You may print and copy it, too, but also only for personal use. Sharing an
electronic or printed copy with others, however, is not permitted, neither as a whole
nor in parts. Of course, making them available on the Internet or in a company network
is illegal as well.
For detailed and legally binding usage conditions, please refer to the section
Legal Notes.
This e-book copy contains a digital watermark, a signature that indicates which person
may use this copy:
Imprint
This e-book is a publication many contributed to, specifically:
Editor Megan Fuerst
Acquisitions Editor Hareem Shafi
Copyeditor Rachel Paul
Cover Design Graham Geary
Photo Credit iStockphoto.com/539359316/© Mlenny
Production E-Book Hannah Lane
Typesetting E-Book SatzPro, Krefeld (Germany)
We hope that you liked this e-book. Please share your feedback with us and read the
Service Pages to find out how to contact us.
The Library of Congress has cataloged the printed edition as follows:
Names: Bönnen, Carsten, author.
Title: SAP Gateway and OData / Carsten Bönnen, Volker Drees, Andre Fischer,
Ludwig Heinz, Karsten Strothmann.
Other titles: OData and SAP NetWeaver Gateway
Description: 3rd edition. | Bonn ; Boston : Rheinwerk Publishing, 2019. |
Revised edition of: OData and SAP NetWeaver Gateway. | Includes
bibliographical references and index.
Identifiers: LCCN 2018045669 (print) | LCCN 2018046736 (ebook) | ISBN
9781493217564 (ebook) | ISBN 9781493217557 (alk. paper)
Subjects: LCSH: SAP NetWeaver Gateway. | Open Data Protocol.
Classification: LCC QA76.76.S27 (ebook) | LCC QA76.76.S27 B66 2019 (print) |
DDC 006.3/3--dc23
LC record available at https://lccn.loc.gov/2018045669
ISBN 978-1-4932-1755-7 (print)
ISBN 978-1-4932-1756-4 (e-book)
ISBN 978-1-4932-1757-1 (print and e-book)
© 2019 by Rheinwerk Publishing, Inc., Boston (MA)
3rd edition 2019
Contents
Foreword by Björn Goerke .......................................................................................... 19
Introduction .................................................................................................................... 21
Acknowledgments ........................................................................................................ 25
PART I Getting Started
1 Introduction to SAP Gateway
31
1.1 Modern Business Applications ................................................................ 32
1.1.1 User Interfaces................................................................................. 33
1.1.2 Infrastructures................................................................................. 40
1.2 SAP Gateway for Modern Business Applications ............................ 44
1.3 SAP Gateway in SAP S/4HANA ................................................................ 49
1.4 Installation and Deployment ................................................................... 50
1.4.1 Installation........................................................................................ 51
1.4.2 Deployment...................................................................................... 53
1.5 SAP Gateway and Related Products...................................................... 57
1.5.1 SAP Fiori ............................................................................................. 58
1.5.2 SAP Cloud Platform, ABAP Environment ................................ 58
1.5.3 SAP Cloud Platform API Management .................................... 58
1.5.4 SAP Cloud Platform Integration................................................. 59
1.5.5 SAP Cloud Platform Portal and SAP Enterprise Portal........ 59
1.5.6 SAP Cloud Platform Mobile Services ........................................ 60
1.5.7 SAP HANA.......................................................................................... 61
1.5.8 SAP Process Integration and SAP Process
Orchestration................................................................................... 62
1.5.9 SAP Business Warehouse............................................................. 63
1.6 Summary ........................................................................................................... 64
7
Contents
2 Introduction to OData
65
2.1 OData and REST.............................................................................................. 65
2.1.1 What Is REST? .................................................................................. 65
2.1.2 What Is OData? ............................................................................... 69
2.2 Structure of an OData Service.................................................................. 74
2.2.1 Service Document .......................................................................... 78
2.2.2 Service Metadata Document...................................................... 82
2.3 OData Operations ......................................................................................... 85
2.3.1 Create ................................................................................................. 85
2.3.2 Read .................................................................................................... 85
2.3.3 Update................................................................................................ 87
2.3.4 Delete ................................................................................................. 88
2.4 OData Query Options .................................................................................. 88
2.4.1 Filtering and Projecting ($filter and $select) ......................... 90
2.4.2 Sorting ($orderby)........................................................................... 94
2.4.3 Client-Side Paging ($top, $skip, and $inlinecount).............. 94
2.4.4 Counting ($count) .......................................................................... 99
2.4.5 Inlining ($expand) .......................................................................... 99
2.4.6 Formatting ($format) .................................................................... 103
2.5 OData in SAP Solutions............................................................................... 106
2.5.1 Mobile Applications....................................................................... 108
2.5.2 SAP Fiori ............................................................................................. 108
2.5.3 SAP Jam.............................................................................................. 109
2.5.4 SAP Enterprise Portal..................................................................... 110
2.5.5 SAP Solution Manager .................................................................. 110
2.5.6 SAP HANA.......................................................................................... 110
2.5.7 SAP S/4HANA................................................................................... 113
2.5.8 SAP Cloud Platform........................................................................ 113
2.6 SAP Gateway OData Features.................................................................. 115
2.7 What’s Different with OData 4.0? ......................................................... 119
2.7.1 JavaScript Object Notation Format .......................................... 119
2.7.2 Powerful Query Language ........................................................... 121
2.7.3 Cross-Service Navigation ............................................................. 122
8
Contents
2.7.4 Actions and Functions................................................................... 122
2.7.5 Vocabularies and Annotations................................................... 123
2.8 Summary ........................................................................................................... 123
3 Architecture and Integration
125
3.1 Gateway Principles ....................................................................................... 125
3.2 SAP Gateway Architecture ........................................................................ 127
3.2.1 Consumer Tier ................................................................................. 130
3.2.2 SAP Gateway Tier............................................................................ 131
3.2.3 SAP Backend Tier............................................................................. 132
3.2.4 Add-On Structure Evolution........................................................ 133
3.3 Integration with Other Technologies ................................................... 138
3.3.1 Remote Function Call .................................................................... 139
3.3.2 Business Object Repository ......................................................... 139
3.3.3 Service Provider Infrastructure .................................................. 139
3.3.4 SAP BW InfoCubes.......................................................................... 140
3.3.5 Multidimensional Expressions................................................... 140
3.3.6 SAP BW Easy Query ........................................................................ 141
3.3.7 Generic Interaction Layer............................................................. 141
3.3.8 SAP Business Process Management......................................... 141
3.3.9 SAP Business Workflow................................................................ 142
3.4 ABAP Programming Model for SAP Fiori ............................................. 142
3.4.1 Architecture and Technology ..................................................... 143
3.4.2 SAPUI5 and SAP Fiori Elements.................................................. 144
3.4.3 SAP Gateway and the ABAP Programming Model
for SAP Fiori ...................................................................................... 146
3.4.4 SAP HANA.......................................................................................... 151
3.4.5 Outlook .............................................................................................. 152
3.5 Summary ........................................................................................................... 152
9
Contents
4 Deployment Options, Installation, and
Configuration
155
4.1 Introduction to SAP Gateway Deployment ....................................... 155
4.1.1 Hub Deployment with Development in the
SAP Backend System...................................................................... 158
4.1.2 Hub Deployment with Development on the Hub ............... 159
4.1.3 Embedded Deployment................................................................ 161
4.1.4 SAP Cloud Platform OData Provisioning ................................ 163
4.1.5 Mixed Deployment Options ....................................................... 164
4.1.6 Deployment Options for SAP Fiori and SAP S/4HANA ....... 166
4.1.7 Comparison of Deployment Options....................................... 169
4.2 Preparing for Installation and Configuration ................................... 170
4.3 Quick Start Guide .......................................................................................... 173
4.3.1 Step 1: Deploy the SAP Gateway Add-Ons for Older
SAP NetWeaver Versions ............................................................. 174
4.3.2 Step 2: Activate SAP Gateway .................................................... 174
4.3.3 Step 3: Create an SAP System Alias.......................................... 175
4.3.4 Step 4: Create an SAP Gateway Alias....................................... 176
4.3.5 Step 5: Activate the OPU Node .................................................. 178
4.3.6 Step 6: Test Your Settings............................................................ 179
4.4 Installation and Configuration in Detail ............................................. 180
4.4.1 Installing the SAP Gateway Add-Ons....................................... 181
4.4.2 Basic Configuration Settings ...................................................... 182
4.4.3 OData Channel Configuration ................................................... 184
4.4.4 Business Enablement Provisioning Configuration.............. 190
4.4.5 Smoke Testing ................................................................................. 191
4.5 Summary ........................................................................................................... 193
PART II Service Creation
5 Introduction to OData Service Creation
197
5.1 Methods for Creating an OData Service.............................................. 198
10
