week 2: migration, input, and output unit 6: web services

Week 2: Migration, Input, and Output

Unit 6: Web Services

2PUBLIC© 2021 SAP SE or an SAP affiliate company. All rights reserved. ǀ

Web services

Overview

SOAP Web Services

▪ Service explorer

▪ SAP API Business Hub

▪ SOAP payload

REST/OData Services

▪ OData editor

▪ OData for reports/KPIs/data sources

▪ System demo


Data & Process Integration

▪ Create or update business object data, e.g.

– Master data replication

– Mass change

– Continue a business process in

SAP Business ByDesign that started in a

remote system, e.g. create sales orders

▪ Let an event in SAP Business ByDesign

trigger a business process task in a remote

system

▪ Develop e.g. an external app that interacts

with SAP Business ByDesign data

Analytical Integration

▪ Remote consumption of data from

SAP Business ByDesign

– Report results and KPIs (i.e. pre-

processed analytical data)

– Data sources (analytical raw data)

Web services

Typical use cases


Web services

SOAP Web services

SOAP Web Service APIs

▪ Approx. 200 APIs/ approx. 100 business objects

▪ Query / create / update

▪ Actions (e.g. Release Outbound Delivery)

Service Explorer

▪ Work center “Application and User Management”

→ view “Service Explorer”

▪ All SOAP Web services

▪ Detailed documentation with field information

and sample XML payload messages

▪ Download structure definition of API (WSDL file)

Remarks

▪ SAP Cloud Applications Studio: wizard to create

additional SOAP APIs for standard and custom

business objects


SAP Business ByDesign in SAP API Business Hub

▪ https://api.sap.com/package/BYD/soap

▪ All SOAP APIs incl. links to WSDL file

▪ General documentation on how to use SOAP Web services in

SAP Business ByDesign, e.g. action codes, sample code for

consumer side

Web services

SOAP Web services

https://api.sap.com/package/BYD/soap


Web services

SOAP Web services – payload sample

<BasicMessageHeader/>

<Material actionCode="06"

descriptionListCompleteTransmissionIndicator="false">

<InternalID>P100101</InternalID>

<Description actionCode="01">

<Description languageCode="FR">Sample French Text</Description>

</Description>

</Material>


Web services








</Description>

</Material>

actionCode

actionCode="01" Create (error message if already exists)

actionCode="02" Update (error message if doesn’t exist)

actionCode="04" Save (create or update as needed)

actionCode="06" No change on this node level

See

documentation

for details


Web services


ListCompleteTransmissionIndicator

descriptionListCompleteTransmissionIndicator=“true" Replace the descriptions in the system with this list

descriptionListCompleteTransmissionIndicator="false" Modify the descriptions in the system

See

documentation

for details







</Description>

</Material>


Web services

OData services

OData for Business Objects

“Application and User Management” → “OData Services”

→ Custom OData Services

▪ 337 standard business objects

▪ Custom business objects (SAP Cloud Applications Studio)

▪ Select nodes, fields, filter, and functions → Activate API

OData for Reports / KPIs / Data Sources

▪ “Business Analytics” → “Design Reports”

→ “Build OData Queries” → Specify fields and filter

▪ “Business Analytics” → “Design KPI” → “OData Service”

▪ “Business Analytics” → “Design Data Sources”

→ “Build OData Queries”

Automatic authorization control via user and assigned

work center views


Web services

System demo: OData for KPIs


Web services

Event subscription

Subscription for Event Notifications

“Application and User Management” → “Event Notification”

▪ Subscribe to specific business object data being created/updated/deleted

▪ The event triggers an OData call to a service in the specified remote system


Web services

Preparation and monitoring

Preparation

Set up communication and user

▪ Communication system – who?

▪ Communication scenario – what?

▪ Communication arrangement – how?

→ See file with detailed descriptions

as additional info to this unit.

Monitoring

Monitoring views in work center “Application and User

Management”

▪ Business Communication Monitoring

▪ Web Service Message Monitoring

▪ Event Notification Monitoring

Status, error log, payload view


Web services

Where to go from here

Suggestions for next steps

▪ OData Example: Create and Update Product Data,

step-by-step description and video (Murthy V, SAP)

https://blogs.sap.com/2019/02/28/odata-example-create-and-

update-product-data-in-byd/.

▪ SOAP: Create ByD Sales Orders using Web Services

https://blogs.sap.com/2017/08/10/create-byd-sales-orders-using-

web-services/ (Knut Heusermann, SAP)

▪ Samples covering end-to-end business scenarios

https://blogs.sap.com/2019/02/27/sap-business-bydesign-api-

usage-samples/ with link to GitHub for Postman© collections

▪ Get an overview on all available

APIs and when to use what

(Knut Heusermann, SAP)

https://blogs.sap.com/2019/09/26/

sap-business-bydesign-an-api-

overview/

Hands-on: follow the blog posts and videos

published in the SAP Business ByDesign community

Use available resources

Suggestions for first steps with Web

services

▪ Questions? Ask the community!

https://www.sap.com/community/topics/bu

siness-bydesign.html

→ Go to section “Integrate and Extend...”

▪ Sample demos published by

SAP Business ByDesign partners

on YouTube and other platforms

▪ Use SAP Help Portal

https://help.sap.com/viewer/product/SAP_

BUSINESS_BYDESIGN/

→ Go to tab “Integrate” → “Web Service

APIs”

▪ Tip: The search in the Help Center within

SAP Business ByDesign combines both

documentation and community blog posts!

https://blogs.sap.com/2019/02/28/odata-example-create-and-update-product-data-in-byd/

https://blogs.sap.com/2017/08/10/create-byd-sales-orders-using-web-services/

https://blogs.sap.com/2019/02/27/sap-business-bydesign-api-usage-samples/

https://blogs.sap.com/2019/09/26/sap-business-bydesign-an-api-overview/

https://www.sap.com/community/topics/business-bydesign.html

https://help.sap.com/viewer/product/SAP_BUSINESS_BYDESIGN/

https://help.sap.com/viewer/product/SAP_BUSINESS_BYDESIGN/

https://www.sap.com/community/topics/business-bydesign.html

Thank you.

Contact information:

[email protected]

© 2021 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.

In particular, SAP SE or its affiliated companies have no obligation to pursue any course of business outlined in this document or

any related presentation, or to develop or release any functionality mentioned therein. This document, or any related presentation,

and SAP SE’s or its affiliated companies’ strategy and possible future developments, products, and/or platforms, directions, and

functionality are all subject to change and may be changed by SAP SE or its affiliated companies at any time for any reason

without notice. The information in this document is not a commitment, promise, or legal obligation to deliver any material, code, or

functionality. All forward-looking statements are subject to various risks and uncertainties that could cause actual results to differ

materially from expectations. Readers are cautioned not to place undue reliance on these forward-looking statements, and they

should not be relied upon in making purchasing decisions.

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.

See www.sap.com/trademark for additional trademark information and notices.

www.sap.com/contactsap

Follow all of SAP

http://www.sap.com/trademark

https://www.sap.com/registration/contact.html

https://plus.google.com/+SAP

https://www.linkedin.com/company/sap

https://www.youtube.com/user/SAP

https://twitter.com/sap

https://www.facebook.com/SAP

week 2: migration, input, and output unit 6: web services

Documents