orkungedik/SAP-basis-dataset huggingface dataset:
## 4.6 Integration with SAP S/4HANA Cloud Public Edition
##  Note
Joule is accessible in both 2-system landscape (2SL) and 3-system landscape (3SL). For more information, see System Landscapes in SAP S/4HANA Cloud.
This section describes how to integrate Joule with the technical product SAP S/4HANA Cloud Public Edition.
These steps comprise the Joule-specific and product-specific prerequisites and depend on your initial system
setup. For example, you must first set up the technical environment, such as the SAP Business Technology Platform (BTP) with the entitlements for Joule and SAP Build Work Zone, standard edition (foundation/ standard plan). You are guided through the integration steps with instructions, for example, you run the Joule booster that - among other settings - enables the communication scenario SAP\_COM\_0882 (SAP Digital Assistant Services) in the background.
##  Note
SAP S/4HANA Cloud Public Edition refers to an offering that includes the technical product SAP S/4HANA Cloud Public Edition as the main component and a large variety of surrounding services. The integration described here is between Joule and the technical product SAP S/4HANA Cloud Public Edition.
##  Note
To access Joule within SAP S/4HANA Cloud Public Edition, an additional entitlement and authorization may be required. Please consult your account executive for more information.
## Prerequisites
- You fulfill the general Prerequisites [page 7] for Joule.
- You have reviewed the Initial Setup [page 6] for Joule and have carried out the necessary steps.
- You checked the Joule-specific information regarding Security.
- You are aware of the Constraints for Joule in SAP S/4HANA Cloud Public Edition [page 82].
## Integration Steps
To integrate Joule with SAP S/4HANA Cloud Public Edition, you must carry out the following steps:
1. Expose the SAP Fiori Launchpad Content to SAP BTP [page 69] (specific for SAP S/4HANA Cloud Public Edition)
2. Configure Trust to the Identity Authentication Tenant [page 15]
3. Configure User Attributes for Joule from the Identity Directory [page 16]
4. Register the SAP S/4HANA Cloud Public Edition System [page 69] (specific for SAP S/4HANA Cloud Public Edition)
5. Create SAP Build Work Zone Application and Instance [page 11]
6. Run the Joule Booster [page 17]
7. Configure Identity Provisioning Service [page 70] (specific for SAP S/4HANA Cloud Public Edition)
8. Configure Trusted Domain in SAP BTP [page 21]
9. Configure Trusted Domains in Identity Authentication [page 20]
10. Maintain Custom Content Security Policy [page 82] (specific for SAP S/4HANA Cloud Public Edition)
11. Set Up Document Grounding [page 105]
## Related Information
Integrating With SAP Build Work Zone, Standard Edition
## 4.6.1  Expose the SAP Fiori Launchpad Content to SAP BTP
To set up the content exposure flow, the Joule booster created a communication arrangement in the Communication Arrangements app, and a communication system for the communication scenario SAP\_COM\_0647 (Launchpad Content Exposure to SAP BTP Integration). In most cases, you set the Exposure Role Selection to ALL (All Roles with SAP Fiori Launchpad Content). For more information, see Expose Launchpad Content to SAP BTP.
However, if you would like to expose individual business roles to SAP BTP and have therefore set the Exposure Role Selection to SELECTION (Selected Roles in 'Maintain Business Roles' Application), you must expose your roles as follows:
1. In the SAP S/4HANA Cloud Public Edition system, log on to the SAP Fiori Launchpad as administrator.
2. Open the Maintain Business Roles app.
3. Identify the business roles that your are using. For more information about business roles in SAP S/4HANA Cloud Public Edition, see Business Roles, Business Catalogs and Restrictions.
4. Open each role and select Exposed to SAP BTP . For more information about mass changes, see How to Select Business Roles for Exposure.
5. Confirm the dialog box that displays.
6. The Exposed to SAP BTP entry indicates that the role you selected is exposed.
7. The content is ready to be consumed by SAP Build Work Zone, standard edition. To look at the exposure log, open the application log in the Display Launchpad Content Exposure Logs tile.
## 4.6.2  Register the SAP S/4HANA Cloud Public Edition System
## Procedure
1. In the SAP BTP cockpit, navigate to your global account, and then choose System Landscape Systems .
2. On the Systems page, choose Add System . In the Add System wizard do the following:
- a. Enter a name for the system you want to register.
- b. In the Type dropdown list, select the system type.
- c. Choose Add .
- d. Select All Communication Scenarios in the Communication Scenario Groups dropdown menu.
- e. Choose Get Token .
The system generates the registration token.
- f. Copy the registration token. You need the token to complete the integration on the respective SAP solution system side.
- g. Close the wizard.
3. Go to your SAP S/4HANA Cloud Public Edition system. Open the Communication Management Maintain BTP Extension app.
4. Choose New and add the token fetched from the SAP BTP cockpit as mentioned in the step 2.
5. The status of the system is set as Enabled once you add the token.
6. Go back to SAP BTP Cockpit and verify if the status of the system is set as Registered .
## 4.6.4  Maintain Custom Content Security Policy
Maintain a custom content security policy to enable loading the plugin script as cross-origin resource.
1. Open Manage Content Security Policy app, click Trusted Sites and navigate to details for Resources Scripts.
2. Click New in Managed by Customer section.
3. Enter the URL of your Joule tenant under Trusted Content and choose Save .
## 4.6.5  Constraints for Joule in SAP S/4HANA Cloud Public Edition
##  Note
Joule is accessible in both 2-system landscape (2SL) and 3-system landscape (3SL). For more information, see System Landscapes in SAP S/4HANA Cloud.
In addition to the general Constraints for Joule [page 128], the following constraints apply for Joule in SAP S/4HANA Cloud Public Edition:
- Joule does not cover the full set of globalization support as SAP S/4HANA Cloud Public Edition. For now, you can converse with Joule in English (EN).
- Joule is not designed to process personal data or sensitive data. You must not add any personal sensitive data in Joule. For more information, see Data Protection and Privacy.
- Joule is designed to work with one SAP S/4HANA Cloud Public Edition instance only.
- To use single log-out (SLO) for Joule with SAP S/4HANA Cloud Public Edition, you need to configured (SLO). For more information, see Authentication of Requests.
- In the Joule booster, when you enable Joule in the system, Joule is enabled for all users.
Since Joule Web Client is embedded via iFrame, it requires support for iFrame and 3rd-party cookies. This implies the following technical constraints:
- Blocking of iFrame from Joule domains ( *.cloud.sap ) and IAS domains must be disabled in the browser settings, either by default or by policy. See Supported Browsers for details.
- Single Sign-On (SSO) relies on an a shared session with IAS used by SAP S/4HANA Cloud Public Edition instance and Joule instance. Thus, IAS must not be configured to force authentication with the Corporate IdP for each authentication if IAS is configured as a proxy IdP .
## Other technical constraints:
- Rate limits for BTP apply.
- Rate limit for Joule is 3000 requests per minute per tenant.
- Restrictions for SAP Build Work Zone, standard edition with SAP S/4HANA Cloud Public Edition apply. For more information, see 3075638 .
- If SAP Build Work Zone, standard edition is not already used, Joule uses SAP Build Work Zone, standard edition with foundation plan for navigational scenarios. This implies that Identity Provisioning Service (IPS) is enabled and will be configured for user assignment to the navigation content.
## 4.7 Integration with SAP Integrated Product Development
SAP Integrated Product Development is a cloud solution that enables you to digitally orchestrate your product development from design to operate, resulting in reduced time to market, higher R&amp;D return on investment, higher margins, and reliable product launches.
With Joule, business users have conversational access to the SAP Integrated Product Development product documentation on the SAP Help Portal from within the SAP Fiori apps that are delivered for the different SaaS applications. For more information about supported scope and setting up Joule for SAP Integrated Product Development, see 3503056 .
## 4.8 Integration with SAP Asset Performance Management
SAP Asset Performance Management is a cloud solution that is meant for industries and customers that operate and service industrial assets and want to run outcome-based operations with a focus on high asset availability, and resilient and safe operations.
This solution allows you to manage risk and reliability, optimize maintenance strategies and connect assets for real-time condition monitoring, allowing a shift towards more efficient predictive and prescriptive maintenance.
With Joule, business users have conversational access to the SAP Asset Performance Management product documentation on the SAP Help Portal from within the SAP Fiori apps that are delivered for the different
SaaS applications. For more information about setting up Joule for SAP Asset Performance Management, see 3503073 .
## 4.9 Integration with SAP Digital Manufacturing
SAP Digital Manufacturing is a cloud solution that provides manufacturing and industrial customers with analytics, plant and enterprise-level Industry 4.0 execution, machine/equipment modeling, data collection, and resource orchestration capabilities.
With Joule, business users have conversational access to the SAP Digital Manufacturing product documentation on the SAP Help Portal from within the SAP Fiori apps that are delivered for the different SaaS applications. For more information about supported scope and setting up Joule for SAP Digital Manufacturing, see SAP Note 3506025 .
## 4.10.1  Maintaining Custom Content Security Policy
You need to add the Joule tenant URL as a trusted source to enable loading Joule in your SAP Integrated Business Planning (SAP IBP) system.
## Context
Once you've run the Setting up Joule booster, you must maintain the custom content security policy in your SAP IBP tenant to enable loading the Joule icon  .
## Procedure
1. Navigate to the SAP Fiori launchpad of your SAP IBP system.
2. Open the Manage Content Security Policy app.
3. On the Trusted Sites tab, open the details for Resources Scripts ( UI\_RESOURCES\_SCRIPTS ).
4. Under Managed by Customer , choose New .

If you don't see the Managed by Customer section, choose Add , and the section is added.
5. Under Trusted Content , enter the URL of your Joule tenant and choose Save .
##  Note
To find out the URL of your Joule tenant, go to your SAP Business Technology Platform (SAP BTP) subaccount and navigate to System Landscape Formations . Select the formation that was created by the Joule booster and view its details. Copy the URL and enter it as a trusted site in your SAP IBP system.
For example: https://&lt;subaccount&gt;.&lt;region&gt;.sapdas.cloud.sap
## Related Information
Integration with SAP Integrated Business Planning [page 84]
## 4.10.2  Constraints for Joule in SAP Integrated Business Planning
Familiarize yourself with the constraints for Joule in SAP Integrated Business Planning (SAP IBP).
For more information about constraints for Joule, see Constraints for Joule [page 128].
In addition, the following constraints apply:
- Joule doesn't support all languages that are supported in SAP IBP. For a list of languages that are supported in Joule, see Joule Multi Language Support.
- Joule doesn't support the same set of accessibility standards as SAP IBP.
- Joule is designed to work with one SAP IBP instance only. So if, for example, you want to integrate Joule with the SAP IBP instance of your test system and the SAP IBP instance of your productive system, you need separate Joule tenants for each of the systems. Equally, if you have more than one productive system and want to integrate Joule with each of them, you need separate Joule tenants for each of the systems.
- Custom domains aren't supported.
- Joule isn't designed to process personal data or sensitive data. You must not add any personal or sensitive data in Joule. For more information, see Data Protection and Privacy.
- The Joule Web client is embedded via inline frame (iFrame), so it requires support for iFrame and thirdparty cookies. This implies the following technical constraints:
- Blocking of iFrame from Joule domains (*.cloud.sap) and SAP Cloud Identity Services - Identity Authentication (IAS) domains must be disabled in the browser settings, either by default or by policy. For more information, see Supported Browsers.
##  Note
Joule supports cookie partitioning to mitigate the impact of the deprecation of third-party cookies by Google Chrome. Users can continue to leverage single sign-on-based login to Joule after the third-party cookies are deprecated.
- Single sign-on relies on a shared session with the IAS used by the SAP IBP instance and the Joule tenant. If the IAS is configured to use a proxy IdP , the IAS mustn't be configured to force authentication with the corporate IdP for each authentication.
- In the Setting up Joule booster, when you enable Joule in your SAP IBP system, it is enabled for all users.
## 4.11 Integration with SAP Ariba
## 4.11.1  Create OAuth Credentials for the CDM API
You must create the OAuth credentials in the SAP Ariba Developer Portal of your data center.
## Context
The credentials that you create in the SAP Ariba Developer Portal will be used during the configuration of design and runtime destinations.
## Procedure
1. Sign in to the SAP Ariba Developer Portal (https:/ /developer.ariba.com/api/home ) as a user with the Organisation admin role and select your data center.
2. Navigate to Manage Applications .
3. Locate the desired application in the application list on the left.
4. Click Actions Request API Access .
5. Select one of the APIs:
- For SAP Ariba Strategic Sourcing Solutions, select Workzone CDM Content for Sourcing .
- For SAP Ariba Procurement solutions, select Workzone CDM Content for Procurement .
6. Choose one of the following APIs:
- For SAP Ariba Strategic Sourcing Solutions, select Sourcing API .
- For SAP Ariba Procurement solutions, select Procurement API .
7. Select all the realms and submit the request.
The request must be approved by the Open API team. Once approved, go to Actions and generate the OAuth secret.
For more information on creating APIs, see
- Administrator Functions Related to Applications on the SAP Ariba Developer Portal
- Finding Your Application's Application Key and OAuth Client ID
- Generating the OAuth Secret and Base64 Encoded Client ID and Secret
- OAuth Access Token Request and Receipt
## 4.11.3  Configure Identity Provisioning Service From SAP Ariba Applications to IAS
Follow the steps explained in the following topics to configure Identity Provisioning Service from SAP Ariba Applications to IAS.
- Configure SAP Ariba Applications as source system. For instructions, see SAP Ariba Applications.
##  Note
Do the following steps in addition to the steps mentioned in this link:
- Remove FamilyName from the transformation.
- Add the filter ariba.applications.user.filter to filter only selected few Users during the sync. Enter the user name is the format "John.Doe".
- Configure SAP Cloud Identity Service - Identity Authentication as a target system. For instructions, see Identity Authentication.
##  Note
Do the following steps in addition to the steps mentioned in this link:
- Remove givenName , FamilyName , middleName , and honoroficPrefix from the transformation.
- Set ias.support.patch.operation to T rue.
## 4.12 Integrating Joule with Microsoft 365 Copilot
## Prerequisites
- You have at least one SAP business tenant (Such as SAP S/4HANA Private Cloud, SAP SuccessFactors) integrated with Joule.
- You have set up trust between Entra and SAP Cloud Identity Services - Identity Authentication, registering Entra as the Corporate IdP based on OIDC. For more information, see Configuring SAP Cloud Identity Services and Microsoft Entra ID for Joule .
- All users that shall be able to use Joule from within Microsoft 365 Copilot have been created / replicated to the SAP Cloud Identity Services User Store.
- You have a Microsoft M365 Copilot license and have rolled out M365 Copilot to the intended user base. For more information, see Getting Started with Microsoft 365 Copilot .
## Integration Steps
## Entra Application Registration for the Federation with IAS
The Entra Application used for integrating Entra with IAS must be enhanced to cover the permissions and APIs for the Joule Integration.

This is documented in the following blog post: Enable Microsoft 365 Copilot and Teams to Pass Requests to Joule .
## Joule

Note down your Microsoft M365 Tenant Id corresponding to your productive Microsoft M365 Copilot/ Teams deployment. You'll need to provide this during the Joule landscape setup.
- In the BTP Cockpit, go the system landscape and add a system of type M365 Copilot for SAP Joule. Enter the tenant ID you noted down before.
- If you are setting up Joule for the first time you can activate the Microsoft 365 Copilot integration when running the Joule Booster.
- If you already have a running Joule setup, include the newly created system to the formation via the BTP cockpit.
##  Note
Joule is powered by Generative AI and all output should be reviewed before use. Please do not enter any sensitive personal data, and avoid entering any other personal data you do not wish to be processed.
## Microsoft M365 Copilot
- Install the SAP Joule app via the Microsoft 365 Admin Center.
##  Note
After installing the M365 Custom Engine Agent via the M365 Admin Center and doing all setup steps, it may take up to two hours until the Joule Agent can be accessed from within M365 Copilot Chat.
##  Note
SAP does not control data processed by Microsoft 365 Copilot, the decision to use Microsoft 365 Copilot is up the customer and all use of Microsoft 365 Copilot is subject to the terms of the agreement between the customer and Microsoft.
## 4.13 Integration with SAP Logistics Management
View the steps required to integrate Joule with SAP Logistics Management.
## Prerequisites
- You have completed steps for the initial setup. For more information, see Initial Setup [page 6].
- You fulfill the general prerequisites for Joule. For more information, see Prerequisites [page 7].
- You have configured trust to the Identity Authentication tenant. For more information, see Configure Trust to the Identity Authentication Tenant [page 15].
- Your SAP Logistics Management system is discovered in the SAP BTP system landscape.
## Integration Scenarios
You subscribe to SAP Logistics Management and Joule at the same time
Follow the instructions Include SAP Logistics Management in the Joule Formation [page 103].
## You are already using SAP Logistics Management and now want to also subscribe to Joule
Follow the instructions Integrating with Joule Using Joule Booster [page 102].
## 4.13.1  Integrating with Joule Using Joule Booster
Integrate SAP Logistics Management with Joule using Joule Booster.
## Prerequisites
Ensure that you meet the prerequisites under Integration with SAP Logistics Management [page 101].
## Context
You are already using SAP Logistics Management and now want to start using Joule.
## Procedure
1. Run the Joule Booster. For more information, see Run the Joule Booster [page 17].
- a. In step 3, select SAP Logistics Management as the product for integration.
- a. In step 5, select your SAP Logistics Management tenant as listed in your SAP BTP system landscape.
2. Configure the Joule user attributes in the Identity directory. For more informarion, see Configure User Attributes for Joule from the Identity Directory [page 16].
## Results
Once you completed the integration steps, the following will be created for you:
- A system landscape formation including Joule and the SAP Logistics Management system that you select for the integration.
- A subscription to Joule.
- A dependency to SAP Logistics Management is added to the Joule application in the trusted Identity Authentication Tenant.
## 4.13.2  Include SAP Logistics Management in the Joule Formation
Subscribe to SAP Logistics Management and Joule at the same time.
## Prerequisites
Ensure that you meet the prerequisites under Integration with SAP Logistics Management [page 101].
## Context
If you subscribe to SAP Logistics Management and Joule at the same time, you have to manually add SAP Logistics Management to the existing Joule formation.
## Procedure
1. Include SAP Logistics Management in the existing Joule formation. Follow the instructions under Include or Exclude a System in the Joule Formation [page 19]. In step 4 of the
2. instruction, select SAP Logistics Management as the system which you want to include in the formation.
2. Configure the Joule user attributes in the Identity directory. For more informarion, see Configure User Attributes for Joule from the Identity Directory [page 16].
## Results
Once you completed the integration steps, the following will be created for you:
- A system landscape formation including Joule and the SAP Logistics Management system that you select for the integration.
- A dependency to SAP Logistics Management is added to the Joule application in the trusted Identity Authentication tenant.
## 5.2 Set Up Data Repository Integration
Choose your data repository type and set up the integration with either Microsoft SharePoint or SAP Build Work Zone.
## Microsoft SharePoint
Create user and register application in Microsoft Entra ID. For the SharePoint integration, you need a valid Microsoft SharePoint site, a Microsoft Azure application through which SharePoint can be accessed, and admin rights to the Microsoft Azure application. The steps and Microsoft Entra documentation articles listed below are for you reference only.
1. Create a technical user. For more information, see the Microsoft Entra documentation article Quickstart: Create and assign a user account .
2. Register an application. For more information, see the Microsoft Entra documentation article Quickstart: Register an application with the Microsoft identity platform .
##  Note
## In API permissions :
- If you configure access from SAP BTP with OAuth2Password authentication, use the permission name Sites.Read.All with type Delegated
- If you configure access from SAP BTP with OAuth2ClientCredentials authentication, use the permission name Sites.Selected for Graph with type Application
For more information, see Configure Access from SAP BTP [page 112].
3. Add a scope to the application that you've registered. For more information, see the Microsoft Entra documentation article Quickstart: Configure an application to expose a web API .
## SAP Build Work Zone
To integrate SAP Build Work Zone, advanced edition with document grounding, follow steps 1 and 2 as described in Integration With Document Grounding.
## 5.4.2  Search Pipelines
See a list of pipelines that match the metadata specified in the request body.
## Create Pipeline with Metadata
First, you need to create a pipeline using metadata . T o create your pipelines, send a POST request to the endpoint &lt;url&gt;/pipeline/api/v1/pipeline adding the configuration parameter metadata in the request body.
## Request Body Example
```
{ "type":"MSSharePoint", "configuration":{ "destination":"ragetest", "sharePoint":{ "site":{ "name":"ragedemo", "includePaths":[ "/test2" ] } }, "cronExpression":"0 23 * * *" }, "metadata":{ "destination":"", "dataRepositoryMetadata":[ { "key":"pipeline/purpose", "value":[ "some" ] } ] } }
```
## Response Example
201 'Returns pipeline ID. '
```
{ "pipelineId":"uuid" }
```
## Search Pipelines with Metadata
To see the list of pipelines, send a POST request to the endpoint &lt;url&gt;/pipeline/api/v1/pipeline/ search with the desired optional parameters and the required request body.
##  Tip
For pagination support, use the optional header parameters $top and $skip .
The optional header parameter $count is also available.
## Request Body Example
```
{ "dataRepositoryMetadata":[ { "key":"pipeline/purpose", "value":[ "demonstration" ] }, { "key":"pipeline/sample-key", "value":[ "sample-value1", "sample-value2" ] } ] }
```
## Response Example
200 'Returns pipelines.'
```
{ "count":6, "resources":[ { "id":"3478e17a-90ad-4b2f-a13d-e440c0341d81", "status":"INPROGRESS", "type":"SDM", "metadata":true }, { "id":"38305435-0c9f-44fb-8fc1-49a721124a2e", "status":"INPROGRESS", "type":"MSSharePoint", "configuration":{ "sharePoint":{ "id":"sap.sharepoint.com,2871e865-2041-4qa9bacc-46d09cc3249f,c031f3c0-6634-445a-9f63-92fc5ad0ee21", "name":"210295", "includePaths":[ "/asif-test" ] } } }, { "id":"b763bc3e-cee7-4199-b79e-7c2311165198", "status":"FINISHED", "type":"S3", "configuration":{ "s3":{ "includePaths":[ "/test" ] }
```
```
} }, { "id":"d766fa0c-3ed0-4b1b-90d3-f247293d22bb", "status":"INPROGRESS", "type":"SDM", "metadata":true }, { "id":"df98edb1-a05b-49f2-afda-07b7b227f34d", "status":"INPROGRESS", "type":"WorkZone", "metadata":true }, { "id":"dfc58108-f07b-4fdd-9cd3-53831ad26e40", "status":"FINISHED", "type":"SFTP", "configuration":{ "sftp":{ "includePaths":[ "/test" ] } } } ] }
```
## 5.6 Supported Regions
Find out in which providers and regions the document grounding capability is available.
The document grounding capability is available in the following Amazon Web Services regions:
- ap10 - Australia (Sydney)
- ap11 - Asia Pacific (Singapore)
- eu10 - Europe (Frankfurt)
- eu11 - Europe (Frankfurt) EU Access
- jp10 - Japan (Tokyo)
- us10 - US East (VA)
The document grounding capability is available in the following Google Cloud regions:
- ap30 - Australia (Sydney)
- eu30 - Europe (Frankfurt)
- sa30 - KSA (Dammam)
##  Caution
For now, the large language models (LLMs) used by the document grounding capability are deployed outside of the Google Cloud sa30 region.
- us30 - US Central (IA)
The document grounding capability is available in the following Microsoft Azure regions:
- ap20 - Australia (Sydney)
- eu20 - Europe (Netherlands)
- us21 - US East (VA)
##  Tip
For more information, see Regions in the SAP BTP documentation.
## 6 Troubleshooting
This section contains information that helps you troubleshoot problems in Joule.
## Joule screen is blank
## Root Cause
You are using Corporate Identity Provider (like Azure AD or OKTA) for user login.
## Solution
- Make sure you have set your Corporate Identity Provider as the Default Identity Provider for Joule application in the Identity Authentication.
- For more information, see Choose Default Identity Provider for an Application.
## Joule Navigation button is missing after a successful Jobrun or Jobsync
## Solution
- Check your NavigationService destination settings in your SAP BTP subaccount.
- Open SAP Build Work Zone application in your SAP BTP subaccount and select Content Channel that you have created for your product integration.
- Ensure to select the Token Service URL Type as Dedicated .
- Manually refresh SAP Build Work Zone application to check if service provider details are updated.
## 3.1 Onboard SAP Subscription Billing
To start the onboarding of SAP Subscription Billing, follow these step-by-step instructions.
##  Tip
Throughout the booster configuration, choose Next to get to the next selection screens or Previous to adjust settings you made in the previous screens.
## Step Task
1. Logon to the SAP BTP Cockpit using either of these URLs depending on your region, your contract, and your special data processing needs:
- EMEA: https:/ /emea.cockpit.btp.cloud.sap
- Americas: https:/ /amer.cockpit.btp.cloud.sap
- Asia-Pacific, Oceania: https:/ /apac.cockpit.btp.cloud.sap
- EU Access: https:/ /eu-access.cockpit.btp.cloud.sap
- A logon URL in the region closest to you (to avoid latency). See Regions and Regions and API Endpoints Available for the Cloud Foundry Environment in the SAP BTP documentation.
2. Open the global account that was used to order SAP Subscription Billing.
##  Tip
To find the right global account, you can use the System &amp; Provisioning dashboard in SAP for Me (log on with your S-user ID). In the dashboard, you can find the global account ID under System Name &amp; Number .
In this guide, we use ' SubscriptionBilling Consulting ' as the example account.
3. Choose Boosters in the navigation panel.

##  Note
If you don't see this entry in the navigation panel, you need to have the Global Account Administrator role assigned to your user.
4. Select the tile Onboard SAP Subscription Billing from the Boosters overview page and choose Start .

The overview page displays:
- Information about the booster
- Components that are available for the booster
- Available additional resources
5. Choose Start to begin the booster process.
The booster checks the necessary prerequisites including required authorizations and entitlements.
If the prerequisites are met, choose Next .
6. Decide whether you want to create a new subaccount for SAP Subscription Billing or add it to an existing subaccount.

##  Caution
This decision has implications for the onboarding of further applications such as Event Mesh (optional). Some applications MUST be subscribed in the same subaccount as SAP Subscription Billing.
Once you have decided, select either Create Subaccount or Select Subaccount and choose Next . Continue with step 6a. or 6b.
## Step Task
## 6a. Create Subaccount
To create a new subaccount, enter the required information and choose Next add users. The booster prefills the fields with suggestions you can partially change:
- Entitlements : Depending on your use case, you can delete optional entitlements of services and applications that you don't want to subscribe.
- Subaccount Name : Y ou can change the generated name to something more relevant to your use case.
- Region : Change the region if the prefilled region is not suitable.
- Subdomain : This will be the name of your SAP Subscription Billing tenant.
You can deselect optional applications in this step by choosing the Delete action.

Tip
You can find a brief description of each entitlement under Overview of Entitlements [page 12] below.

## Step Task
## 4 Set Up Using Connectivity Automation
If you're integrating SAP Subscription Billing with SAP S/4HANA Cloud Public Edition , you can automate part of the integration setup by creating formations to define system connectivity.
| Integration                                                        | Integration Setup Guide                        |
|--------------------------------------------------------------------|------------------------------------------------|
| Subscription Management with Sales Billing (scope item 57Z)        | Setup Guide PDF SAP Signavio Process Navigator |
| Subscription Management with Convergent Invoicing (scope item 5IK) | Setup Guide PDF SAP Signavio Process Navigator |

For easier reading, "SAP S/4HANA Cloud" is used in this help section to refer to the software product SAP S/4HANA Cloud Public Edition.
## 5 Set Up Using Manual Steps
The manual steps that you need to perform to set up SAP Subscription Billing depend on whether you did the initial setup using the booster (see Set Up Using Booster Automation [page 7]).
 Tip
The required roles for performing the manual steps are mentioned in the following instructions. For a full list of roles, see Default Role Collections of SAP BTP.
## 5.1 Technical Setup
## 5.1.1  Check Successful Completion of Provisioning
Log on to the SAP BTP cockpit to check that SAP Subscription Billing is available for your account.
| Step   | Task                                                                                                                                                                                           |
|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1.     | Log on to the SAP BTP Cockpit using one of these URLs depending on your geographical region:                                                                                                   |
|        | • EMEA: https:/ /emea.cockpit.btp.cloud.sap                                                                                                                                                    |
|        | • Americas: https:/ /amer.cockpit.btp.cloud.sap                                                                                                                                                |
|        | • Asia-Pacific, Oceania: https:/ /apac.cockpit.btp.cloud.sap                                                                                                                                   |
|        | • EU Access: https:/ /eu-access.cockpit.btp.cloud.sap If you have the option EU Access in your contract (to restrict processing of personal data to EEA/Switzer- land), log on using this URL. |
|        |  Tip Use a logon URL in the region closest to you (to avoid latency), unless you use the EU Access option in case use the dedicated URL.                                                      |
|        | which                                                                                                                                                                                          |
## Step Task
2. Open the global account that was used to order SAP Subscription Billing.
##  Tip
To find the right global account, you can use the System &amp; Provisioning dashboard in SAP for Me (log on with your S-user ID). In the dashboard, you can find the global account ID under System Name &amp; Number .
In this guide, we use ' SubscriptionBilling Consulting ' as the example account.
3. Choose Entitlements Service Assignments in the navigation panel.

##  Note
If you don't see this entry in the navigation panel, you need to have the Global Account Administrator role assigned to your user.
## Step Task
4. In the service overview, search for "SAP Subscription Billing". The service plan with the technical name revenue-cloud is for the application user interface. The other service plan is for the use of APIs.

Now search for "Price Calculation". The service plan with the technical name price-management is for the application user interface. The other service plan is for the use of APIs.

##  Note
If the service isn't displayed, please report this to your local SAP contact.
## 5.1.2  Add Administrators to Global Account
To enable further users to create a tenant, one of the recipients of the welcome email must add the relevant user as a global account administrator. You add administrators by assigning them a predefined role collection.
For more information on the default role collections for administrators, see Role Collections and Roles in Global Accounts, Directories and Subaccounts in the SAP BTP documentation.
## Step Task
1. In your global account, choose Security Users in the navigation panel.
2. Select Create to add the user who you want to make administrator.

3.
1. Enter the user name and email address of the user.
2. The identity provider must be Default identity provider .
3. Select Create .
4. Optional: If the user isn't part of the identity provider, you're asked to add the user. Complete this action.
5. In the overview of users, open the new user. Then, under Role Collections , select Assign Role Collection .
6. Assign the role collection Global Account Administrator .
7. The user has now administrative access to the global account.
## 5.1.3  Create Subaccounts
Subaccounts on SAP BTP are required for deploying applications and using services. When you create a subaccount and subscribe to SAP Subscription Billing and Price Calculation, tenants are created.
You need one subaccount for each tenant to which you are entitled. A tenant for SAP Subscription Billing and a corresponding tenant for Price Calculation must be created in the same subaccount. Repeat the steps below to create each subaccount.

## Step Task
## 3. Define the subaccount:
1. Specify a display name and short description.
2. In the Region list, scroll to the provider 'Amazon Web Services (AWS)' and select your region:
1. Europe (cf-eu10)
2. Europe EU Access (cf-eu11) You can include the option EU Access in your contract, in which case processing of personal data is restricted to EEA/Switzerland, provided you create your subaccount (tenant) in the region eu11 . Creating a subaccount in the region eu11 without the option active in your contract is not sufficient to restrict processing to EEA/Switzerland.
3. US East (cf-us10)
3. Enter a name for your subdomain.
##  Caution
The subdomain is the tenant name used for login. Once defined, you can't change it later.
The subdomain also becomes part of the application URL for SAP Subscription Billing according to this pattern: &lt;subdomain&gt;.&lt;region&gt;.revenue.cloud.sap
The subdomain can contain only letters, digits and hyphens. Hyphens aren't allowed in the beginning or at the end. The subdomain must be unique across all accounts in the same region of the Cloud Foundry environment of SAP BTP.
You can use upper case and lower case letters; however, they can't be used to differentiate subdomains ('SUBDOMAIN' and 'subdomain' are considered the same).
4. For productive subaccounts, don't select Enable beta features .
5. Select Create .

4. You see a tile for your subaccount on the Subaccounts tab. Wait for the onboarding process to finish before accessing the subaccount.

##  Note
You are automatically assigned to the subaccount as administrator. To learn how to add other users as subaccount administrators, see Define Subaccount Administrators [page 33].
## 5.1.4  Assign Entitlements
You need to assign entitlements if you want to use SAP Subscription Billing including Price Calculation and their APIs.
Your SAP BTP global account has entitlements to use resources, such as services and memory. Distribute quotas of these entitlements to your individual subaccounts (tenants) to define the maximum consumption for each subaccount.
##  Note
The total entitlements that you have available to distribute are:
- For SAP Subscription Billing: 10 entitlements across a maximum of 10 tenants
- For Price Calculation: 10 entitlements across a maximum of 10 tenants
## Step Task

## Step Task
4. Search for "SAP Subscription Billing" and select both service plans for the SAP Subscription Billing service (one for the application and one for API use).
5. Search for "Price Calculation", select it, then select the service plan default (Application) .

Optionally, select the service plan standard if you need to get access to the Price Calculation APIs.
Then choose Add Service Plans to add all the service plans that you previously selected.


You can adjust quotas for only one subaccount at a time. To adjust quotas for multiple subaccounts, complete these steps for each subaccount.
If you have distributed the maximum of your purchased quotas, you can't increase it further. However, you can move quotas between subaccounts in the same global account.
## 5.1.5  Subscribe to SAP Subscription Billing
To use SAP Subscription Billing, you must subscribe to the corresponding application, and also to the Price Calculation application, in the same subaccount.

## Step Task
2. You see all the services that are available to you. Search for the service "SAP Subscription Billing" and select it.
3. Under Application Plans , display the action menu of the plan for which you want to create a subscription and choose Create .
4. Check the basic info and then choose Create .
5. The creation process starts. Choose View Subscription to switch to the Instances and Subscriptions screen.



## Step Task
6. You're subscribed to the SAP Subscription Billing application.
With this step, your SAP Subscription Billing tenant is created.

##  Tip
The tenant ID is the SAP BTP subaccount ID, the tenant name is the SAP BTP subaccount name (subdomain).
7. Now subscribe to the Price Calculation service.
Choose Services Service Marketplace in the navigation panel.

8. You see all the services that are available to you. Search for the application Price Calculation and select it.

## Step Task
9. Under Application Plans , display the action menu of the plan for which you want to create a subscription and choose Create .
10. Check the basic info and then choose Create .
11. The creation process starts. Choose View Subscription to switch to the Instances and Subscriptions screen.
12. You're subscribed to the Price Calculation application.


With this step, your Price Calculation tenant is created.

##  Tip
The tenant ID is the SAP BTP subaccount ID, the tenant name is the SAP BTP subaccount name (subdomain). Therefore, the SAP Subscription Billing and Price Calculation tenants have the same tenant ID and name.
##  Caution
We strongly recommend that you do not unsubscribe from the Price Calculation service once you're actively using configured prices. Unsubscribing results in the deletion of all pricing data 1 day later which would result in inconsistencies within SAP Subscription Billing.
## 5.2 Enable UI Access
This chapter describes how to configure authentication and authorization for the users of your application.
Thus, you can enable them to log on to the SAP Subscription Billing user interface and get access to the appropriate apps and data.
## 5.2.1  Define Subaccount Administrators
To configure authentication and authorization for business users, you need a SAP BTP user with the role User and Role Administrator which is part of the Subaccount Administrator role collection. When you create a subaccount, SAP BTP automatically grants this role to your user.
If you want to enable other users to configure authentication and authorization, you can assign the role by adding the users to your subaccount and assigning the role collection Subaccount Administrator or another role collection with the User and Role Administrator role. Role collections are assigned to users as described in the section Assign Role Collections to Users or User Groups [page 40].
## 5.2.2  Grant Access to the SAP Subscription Billing UI
To give yourself access to the SAP Subscription Billing UI, you need to do the following:
1. Build at least one role collection, as described in the section Build Role Collections [page 35].
##  Recommendation
For the initial setup phase, we recommend the role ui\_applications\_all , which provides you with the complete set of authorizations and allows you to test all apps.
2. Assign at least one role collection to your user, as described in the section Assign Role Collections to Users or User Groups [page 40].
3. Log on to the SAP Subscription Billing application.
4. To enable UI access for further users, repeat steps 1 and 2 for these users to assign the appropriate role.
You find more information on authentication and single sign-on of business users in the sections Enable Authentication and Single Sign-On for Business Users [page 34].
## 5.2.4  Configure Your SAP Cloud Identity Services Tenant as Identity Provider or Proxy of Your Subaccount
If you use the Identity Authentication service in SAP BTP, you can find more information in the SAP BTP documentation under Establish Trust and Federation Between SAP Authorization and Trust Management Service and SAP Cloud Identity Services.
## 5.2.5  Build Role Collections
You need to define role collections to control user authorization for the SAP Subscription Billing apps and data, including Price Calculation.
## Step Task
1. In your global account, open the subaccount. In the navigation panel, choose Security Role Collections
2. To create a new role collection, choose Create .
3. Name your role collection and choose Create . In this guide, we use 'My Role Collection' as the example name.
4. Select the role collection that you just created.
5. In the detail view of the role collection, choose Edit to open the screen in edit mode.
6. Under Roles Role Name , choose the icon of the input field to open the role selector.
7. In the field Application Identifier , choose the identifier that begins with 'revenue-cloud' to filter the available roles for SAP Subscription Billing.



.
## Step Task
8. In the Roles table, you can further filter by roles and templates to reduce the number of rows. Then select the roles that you want in your collection.
9. Once you have selected all the roles for the collection, confirm the selection by choosing Add .


The screenshot shows the role 'ui\_applications\_all' , which provides the complete set of authorizations, as an example.
For productive use, we recommend that you configure suitable roles for your users.
Step
Task
10. Repeat steps 7. -9. to add roles for the Price Calculation apps.
In the field Application Identifier , choose the identifier that begins with 'price-management' .
##  Note
You can find information about the available role templates under Build Role Collections in the Setup and Administration Guide .
11. Choose Save to close the edit mode.
12. Now your role collection shows the assigned roles. Repeat these steps if you want to add further roles to the collection.
##  Note
Optionally, you can create role collections to restrict a specific market for a user, as described in Define Roles to Restrict Authorization by Market (Optional) [page 38].
## 5.2.6  Define Roles to Restrict Authorization by Market (Optional)
You can restrict user access to data that is associated with certain markets. For example, a user can be allowed to only display billing data for subscriptions or to view or edit the data of a lookup table in a particular market.
You restrict the markets for which users have authorization by assigning them a role collection that contains at least one role based on the role template ui\_market\_restriction . The role for market authorization restriction doesn't determine whether the user has permission to view or manage data for an object type. Therefore, in the relevant role collections you need to combine the market restriction role with the functional roles (view/ manage) for object types.
Users without a role that restricts market authorization have access to data for all markets.
To understand which data is visible to users who are authorized only for certain markets, see Build Role Collections in the Setup and Administration Guide .
## Step Task

2. Enter 'market' in the search field to find the role that restricts authorization for markets.

4. Follow the guided steps to create a new role with one or several market values.
Enter a name and description for the role. Make sure that you clearly identify the markets for which the role restrict s authorization.

5. Under Configure Attributes Values , enter the IDs of the markets for which the role grants authorization (press Enter after entering an ID). Leave the source set as Static .

##  Note
Make sure that you enter the market IDs exactly as they are defined in Business Configuration.
## Step Task
6.
We recommend that you use separate role collections for market restrictions, rather than using collections that combine market and functional roles (view/manage).
By keeping the role types separate, you have more transparency.
You can skip this step and create a new role collection for market authorization afterwards.
7. Review the role data and finish the creation process.
8. Repeat the steps above for the role template ui\_market\_restriction belonging to the price-management application.

To create a new role collection for market authorization and assign the roles for markets, follow the steps in the section Build Role Collections [page 35].