Set-Up Instructions | PUBLIC

SAP S/4HANA Cloud

2023-12-08

Setting Up Royalties Settlement for Sales (55I)

© 2023 SAP SE or an SAP affiliate company. All rights reserved.

THE BEST RUN

Content

1 Purpose. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2 Preparation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.1 Target Audience. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.3 Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

3 Configuration in SAP S/4HANA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

3.1 Condition Contract Type Integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
Configure Communication Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.2 Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Events for Settlement Document - Maintain Event Topics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Events for Condition Contract - Maintain Event Topics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
3.3 Logistics - Settlement Document Integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Create Communication System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Create Communication Arrangement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.4 Logistics - Condition Contract Integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Create Communication System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
Create Communication Arrangement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

4 Appendix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
4.1 Ticket Component. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Setting Up Royalties Settlement for Sales (55I)

2 PUBLIC Content
1 Purpose

This configuration guide is valid for SAP S/4HANA Cloud Editions.

SAP S/4HANA offers Integration with the following ODATA API from ERP or SAP S/4HANA systems into SAP
S/4HANA Cloud systems:

• API_CONDITION_CONTRACT_TYPE (OData)

This document describes additional configuration steps that have to be carried out by customers in order to
activate the Condition Contract Type API service. As these configuration steps are customer-specific, they cannot
be delivered by SAP, and must be carried out by the customer.

This is an API only scenario for consumption with an external application.

This document describes how the service must be set up before consumption from an external application.

• API_SETTLMT_DOC:

With this API the customers can read Settlement Documents and their relevant Pricing Elements and Partners on
header and item level. The API can also release Settlement Documents, which are blocked for accounting, but no
Application Status is set. Reverse, complete and revoke is also possible with the API and mass processing for all the
operations and actions.

• API_CONDITION_CONTRACT:

This document describes additional configuration steps that have to be carried out by customers in order to
activate the Condition Contract API service. As these configuration steps are customer-specific, they cannot be
delivered by SAP, and must be carried out by the customer.

This is an API only scenario for consumption with an external application and offers the possibility of reading,
creating, updating Condition Contracts and it’s entities with further operations and actions.

Event for Settlement Management

There is a need to enable customers of SAP S/4HANA to be able to leverage the eventing capabilities of the
Business Objects. The events fired by the Business Objects are mostly used internally within the system or to
trigger SOA based processes. But with SAP Cloud Platform now it is possible to extend the reach of the events
outside the system boundary. This will enable any subscriber of the event outside SAP S/4HANA to listen to such
events and then be able to react on such events.

Settlement Document now has requirements towards notifying external consumers of events raised. With this an
SAP/Partner/Third Party Application can react on such events and take necessary actions based on the type of
event. An example, one can think of would be a payment solution which needs to react to the situation when a
settlement document is released to accounting. The event will be fired into a messaging queue in Cloud Foundry
Messaging service instantiated in the SAP Cloud Platform. The payment solution can then subscribe to the
messaging queue, read the event info and then make a call into the SAP S/4HANA system to find the details of the
settlement document and then issue a payment document to the business partner relevant to settlement. This can
be done easily by making some minor configuration changes and enhancements.

Setting Up Royalties Settlement for Sales (55I)

Purpose PUBLIC 3
This document describes additional configuration steps that have to be carried out by customers in order to
activate the eventing capabilities of the Business Objects scope item title. As these configuration steps are
customer-specific, they cannot be delivered by SAP, and must be carried out by the customer.

Setting Up Royalties Settlement for Sales (55I)

4 PUBLIC Purpose
2 Preparation

2.1 Target Audience

This setup guide is intended for technical consultants/Administrators who want to set up or perform any
configuration activity to get the SAP S/4HANA Cloud Edition Integration working.

2.2 Prerequisites

Condition Contract Type Integration

The authentication of the ABAP Server for Condition Contract Type Integration ODATA API is based on the Basic or
X.509. For the user setup, see details below.

SAP S/4HANA offers services to read condition contract types and the associated data from external applications
via OData protocol.

Event for Settlement Management

It is mandatory that the scope item Business Event Handling is actived.

2.3 Roles

SAP_BR_ADMINISTRATOR

Setting Up Royalties Settlement for Sales (55I)

Preparation PUBLIC 5
3 Configuration in SAP S/4HANA

3.1 Condition Contract Type Integration

3.1.1 Configure Communication Management

A communication arrangement needs to be activated in SAP S/4HANA for communication with web services.

The communication arrangement is named as follows: SAP_COM_0335

3.1.1.1 Create Communication User

Procedure

1. Log onto the SAP S/4HANA Fiori UI launchpad with the user that has the role template:
SAP_BR_ADMINISTRATOR.
2. Under the Communication Management section, navigate to the Maintain Communication Users application .
3. On the Maintain Communication Users screen, choose New.
4. Under User Data, make the following entries:
User Name: <Enter a user name>
Description: SAP Condition Contract Type Integration
Password: <Enter a password and note it down>
5. Choose Create.
6. Make a note of user data. This is required when you create the communication arrangement.

3.1.1.2 Create Communication Systems

Procedure

1. Log onto the SAP S/4HANA Fiori UI launchpad with the user that has the role template:
SAP_BR_ADMINISTRATOR.

Setting Up Royalties Settlement for Sales (55I)

6 PUBLIC Configuration in SAP S/4HANA
 2. In the Communication Management section, navigate to the Communication Systems application.
3. On the Communication System screen, choose New.
4. On the New Communication System pop-up screen, enter the following entries and choose Create.
System ID: Your Communication System ID
System Name: Your Communication System Name

 Note

Make a note of this name as it is required in the step .

5. In the General Data area, you can enter any value. The actual value is not being used in this Communication
Scenario and thus can be chosen freely.
6. Choose Save.

3.1.1.3 Create Communication Arrangements

Procedure

1. Log onto the Fiori launchpad with user that has the role template SAP_BR_ADMINISTRATOR.
2. In the Communication Management section, navigate to the Communication Arrangements application.
3. On the Maintain Communication Arrangements screen, choose New.
4. On New Communication Arrangement pop-up screen, make the following entries and then choose Create:
Scenario: SAP_COM_0335(Logistics - Condition Contract Type Integration)
Arrangement Name: Your Communication Arrangement Name
5. On the Communication Arrangements screen, make the following entries and then choose Save:
Communication System: Maintain the communication system ID defined under Create Communication
Systems.
6. To add the User for Inbound Communication area, choose Add (+ symbol).
7. On the New Inbound Communication User popup, choose Authentication Method with User Name and Password
and enter the user that you created above. Confirm with OK.
8. Choose Save.

Result

You created a communication arrangement that allows you to integrate Condition Contract Types and the
associated data in SAP S/4HANA Cloud system with external systems.

Setting Up Royalties Settlement for Sales (55I)

Configuration in SAP S/4HANA PUBLIC 7
3.2 Events

Follow the steps in Business Event Handling as a part of scope item Business Event Handling. The only variation
would be in the part Maintain Event Topics in the Enterprise Event Enablement section. There would be settlement
document relevant entries that need to be included.

3.2.1 Events for Settlement Document - Maintain Event Topics

While maintaining event topics as per the set-up instructions of scope item 1NN, you can maintain entries for
settlement document while configuring event topics. An example screen shot is provided below:

3.2.2 Events for Condition Contract - Maintain Event Topics

While maintaining event topics as per the set-up instructions of scope item 1NN, you can maintain entries for
condition contracts while configuring event topics. An example screen shot is provided below:

 Note

The below Channel is an example. The channel name can be defined in the chapter Create Communication
Arrangement of section Enterprise Event Enablement.

Setting Up Royalties Settlement for Sales (55I)

8 PUBLIC Configuration in SAP S/4HANA
3.3 Logistics - Settlement Document Integration

This communication scenario offers OData service to read, release, reverse, complete and revoke Settlement
Document and read the relevant Pricing Elements and Partners as well.

Prerequisite

To carry out the following activity, a business user with a business role must exist. The business role must
contain the business catalog SAP_CORE_BC_COM (Communication Management), for example, the business role
SAP_BR_ADMINISTRATOR (Administrator) is required.

3.3.1 Create Communication System

1. Log on to the SAP Fiori launchpad in the SAP S/4HANA Cloud system.
2. Select the Communication Systems tile.
3. Choose New to create a new system.
4. Enter a system ID and a system name.
5. Choose Create.
6. Enter information regarding the system you wish to integrate in the Technical Data section.
7. This will generally be the hostname of the customer's system which will receive the settlement document.
8. Maintain the user for the Inbound Communication with the above server
9. Choose Save.

Setting Up Royalties Settlement for Sales (55I)

Configuration in SAP S/4HANA PUBLIC 9
3.3.2 Create Communication Arrangement

1. Log onto the Fiori launchpad with user that has the role template SAP_BR_ADMINISTRATOR.
2. In the Communication Management section, navigate to the Communication Arrangements application.
3. On the Maintain Communication Arrangements screen, choose New.
4. On New Communication Arrangement pop-up screen, make the following entries and then choose Create:
Scenario: SAP_COM_0714 (Logistics - Settlement Document Integration)
Arrangement Name: Your Communication Arrangement Name
5. On the Communication Arrangements screen, make the following entries and then choose Save:
Communication System: Maintain the communication system ID defined under Create Communication
Systems.
6. To add the User for Inbound Communication area, choose Add (+ symbol).
7. On the New Inbound Communication User popup, choose Authentication Method with User Name and
Password and enter the user that you created above. Confirm with OK.
8. Choose Save.

The communication arrangement has been activated.

3.4 Logistics - Condition Contract Integration

This communication scenario offers OData service to read, create, update Condition Contract, also there is the
possibility to release, lock and release for settlement the contracts. It is also possible to determine the accruals
amount for the condition contracts. New entries in the Business Volume Selection Criteria, Settlement Calendar
and Condition Records can be created with reference to the relevant condition contract. You can also read, update
and delete the entries in the Business Volume Selection Criteria and the Settlement Calendar. The status of the
contract can also be read. Furthermore it is possible to read Condition Records, their scales and validity. The
Condition Record entries can be updated and deleted, also they can be set to invalid and this can be revoked
and create scales referring to the Condition Record. These Scales can be read and deleted. The validity of each
condition record can be read and can be changed as well. Condition Record Texts can be read and created as well
as updated and deleted.

Prerequisite

To carry out the following activity, a business user with a business role must exist. The business role must
contain the business catalog SAP_CORE_BC_COM (Communication Management), for example, the business role
SAP_BR_ADMINISTRATOR (Administrator) is required.

3.4.1 Create Communication System

1. Log on to the SAP Fiori launchpad in the SAP S/4HANA Cloud system.
2. Select the Communication Systems tile.
3. Choose New to create a new system.

Setting Up Royalties Settlement for Sales (55I)

10 PUBLIC Configuration in SAP S/4HANA
 4. Enter a system ID and a system name.
5. Choose Create.
6. Enter information regarding the system you wish to integrate in the Technical Data section.
7. This will generally be the hostname of the customer's system which will receive the settlement document.
8. Maintain the user for the Inbound Communication with the above server
9. Choose Save.

3.4.2 Create Communication Arrangement

1. Log onto the Fiori launchpad with user that has the role template SAP_BR_ADMINISTRATOR.
2. In the Communication Management section, navigate to the Communication Arrangements application.
3. On the Maintain Communication Arrangements screen, choose New.
4. On New Communication Arrangement pop-up screen, make the following entries and then choose Create:
Scenario: SAP_COM_0729 (Logistics - Condition Contract Integration)
Arrangement Name: Your Communication Arrangement Name
5. On the Communication Arrangements screen, make the following entries and then choose Save:
Communication System: Maintain the communication system ID defined under Create Communication
Systems.
6. To add the User for Inbound Communication area, choose Add (+ symbol).
7. On the New Inbound Communication User popup, choose Authentication Method with User Name and
Password and enter the user that you created above. Confirm with OK.
8. Choose Save.

The communication arrangement has been activated.

Setting Up Royalties Settlement for Sales (55I)

Configuration in SAP S/4HANA PUBLIC 11
4 Appendix

4.1 Ticket Component

Implementation Step Component Comment

All steps LO-AB

Setting Up Royalties Settlement for Sales (55I)

12 PUBLIC Appendix
Important Disclaimers and Legal Information

Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:

• Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your agreements
with SAP) to this:

• The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.

• SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.

• Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering an SAP-hosted Web site. By using such links,
you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this information.

Videos Hosted on External Platforms

Some videos may point to third-party video hosting platforms. SAP cannot guarantee the future availability of videos stored on these platforms. Furthermore, any
advertisements or other content hosted on these platforms (for example, suggested videos or by navigating to other videos hosted on the same site), are not within the
control or responsibility of SAP.

Beta and Other Experimental Features

Experimental features are not part of the officially delivered scope that SAP guarantees for future releases. This means that experimental features may be changed by
SAP at any time for any reason without notice. Experimental features are not for productive use. You may not demonstrate, test, examine, evaluate or otherwise use the
experimental features in a live operating environment or with data that has not been sufficiently backed up.
The purpose of experimental features is to get feedback early on, allowing customers and partners to influence the future product accordingly. By providing your feedback
(e.g. in the SAP Community), you accept that intellectual property rights of the contributions or derivative works shall remain the exclusive property of SAP.

Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax and
phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of example
code unless damages have been caused by SAP's gross negligence or willful misconduct.

Bias-Free Language
SAP supports a culture of diversity and inclusion. Whenever possible, we use unbiased language in our documentation to refer to people of all cultures, ethnicities, genders,
and abilities.

Setting Up Royalties Settlement for Sales (55I)

Important Disclaimers and Legal Information PUBLIC 13
www.sap.com/contactsap

© 2023 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 https://www.sap.com/about/legal/trademark.html for

additional trademark information and notices.

THE BEST RUN