orkungedik/SAP-basis-dataset huggingface dataset:
## 8.2 Importing Transport Requests with Cloud Foundry Content
All transport requests that are released become part of the import queue of the first target system. You can now import one, several, or all of them.



After having imported a transport request, a return code will be shown for each transport request to tell whether the import was successful or not. Refer to the next chapter to learn more about return codes.


For more details on performing imports, see Importing Transport Requests with Non-ABAP Objects.

NOTE
As of CTS Plug-In 2.0 SP02 (SL Toolset 1.0 SP05), a new browser-based Import UI is available. Alternatively, you can use the Import UI to perform imports. For more information, see Performing Imports Using the Import Queue Web UI.
## 8.2.1 Meaning of Return Codes - Reading the Deployment Log-File on CTS side
Four different return codes can appear in the import queue
- RC = 0: The import has been successfully completed. Icon in the queue:
- RC = 4: Warning that not everything was ok but import in principle worked. Icon in the queue:
- RC = 8: Errors for the content occurred when importing. A subsequent transport is required. Icon in the queue:
- RC = 12: There were issues with the tool during the import. The transport request can be imported again after the issue has been fixed. Icon in the queue:




You can double-click on the icon for the return code for one transport request to learn more about the import. Especially if the RC is not zero, it might be interesting to find out what went wrong. Clicking on the return code will bring up the overview of the transport logs.
## 8.3 Advanced Usage of Cloud Foundry with CTS+
## 8.3.1 Tools for managing transports
In some cases, Cloud Foundry content should be kept in sync, resp. transported together with content from other applications, for example ABAP backend content. There are tools in SAP Solution Manager that can help you manage collections of change requests and keep changes that are made in different systems together. These tools are called Change Request Management (ChaRM) and Quality Gate Management (QGM). Details for both are provided on SAP Support Portal at https://support.sap.com/en/solutionmanager.html -&gt; Change Control Management .
## www.sap.com/contactsap
© 2022 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 platform 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.
## 1 Introduction
This guide provides detailed information to system administrators or technical consultants on how to set up Joule and the integration between Joule and other SAP products.

- Check the setup requirements for your SAP Solution [page 6]
- Follow the Joule onboarding process to get Joule ready for integrating your SAP Solution [page 7]
- Integrate your SAP Solution with Joule to use the Joule capabilities your solution offers [page 23]
- Set up document grounding to upload documents to the Joule service [page 105]
## 2 Initial Setup
Learn about the options for setting up Joule for productive purposes.
Before you perform the setup instructions, it's important to know which path you should take. Here are the different ways that Joule is available.
## Joule is already available. I don't have to do anything.
You can tell that this applies to you when you see the Joule icon  inside your product. For example, in the SAP BTP cockpit, just click the Joule icon and start working with Joule.
## I already have a BTP platform set up. I just need to run the Joule booster.
In this situation, you already have a global account, subaccounts, and entitlements set up. You also have users onboarded and trust set up to support your platform. Since the BTP platform is ready, you simply need to initiate the booster to prepare Joule and then configure the trusted domains.
## Instructions :
- Make sure you Configure Trust to the Identity Authentication Tenant [page 15] and Configure User Attributes for Joule from the Identity Directory [page 16] before running the Joule booster.
- Run the Joule Booster [page 17]
## I need to set up the BTP platform first and then I can onboard Joule.
If you haven't set up a BTP platform, then you'll need to set up BTP first. This involves administrative actions in the SAP BTP cockpit. After you set up the platform, you can onboard Joule.
## Instructions :
- Prerequisites [page 7]
- Joule Onboarding Guide [page 7]
## Related Information
Joule Onboarding Guide [page 7] Integration Guide [page 4]
## 3 Joule Onboarding Guide
A step by step guide for setting up Joule and integrating it with SAP solutions.
## Overview of the Onboarding Process
Joule includes multiple components that must be integrated for a seamless working solution. The onboarding process consists of the following steps:
## Prerequisites [page 7]
Prerequisites for Joule Onboarding.
## SAP Build Work Zone and SAP Start [page 10]
An overview of the process for integrating content to the SAP Build Work Zone Foundation.
## Configure Trust to the Identity Authentication Tenant [page 15]
Use your SAP Cloud Identity Services - Identity Authentication tenant as an Identity Provider or a proxy to your own Identity Provider hosting your business users.
## Configure User Attributes for Joule from the Identity Directory [page 16]
A step by step guide to configure user attributes from the identity directory.
## Run the Joule Booster [page 17]
Instructions for running the booster to set up Joule.
## Configure Trusted Domains in Identity Authentication [page 20]
You need to add the domain of the integration product as trusted domain in the Identity Authentication.
## Configure Trusted Domain in SAP BTP [page 21]
You can add, configure and save newly created trusted domain.
## Unsubscribe from Joule [page 21]
This section provides instructions on how to unsubscribe and delete a Joule subscription and service instance. Use it to efficiently manage your subscriptions and free up resources when no longer needed.
## 3.2 SAP Build Work Zone and SAP Start
An overview of the process for integrating content to the SAP Build Work Zone Foundation.
To support navigation to different apps from Joule and handle role based access scenarios, Joule configures the navigation service of SAP Build Work Zone. This allows resolution of intent based navigation targets that are defined in the backend. The content needs to be exposed by the SAP product (source system) and consumed by SAP Build Work Zone (target system). This process is composed of a content exposure flow and a content consumption flow.
##  Note
For Joule setup post June 1, 2025, you do not need to configure the navigation service destinations in your Joule subscriber sub-accounts, as this is handled by default as part of the initial setup. For more information, see Run the Joule Booster [page 17].
##  Remember
For integrating content from cloud solutions, all systems must operate under the same domain.
## Content Exposure
The content exposure involves setting up the communication between the content provider system and the SAP Build Work Zone, and exposing the roles that you want to integrate. The steps required for content exposure vary for each SAP product. Please refer to the product specific integration section.
## Content Consumption
After completing the content exposure, you need to set up the content consumption, at the end of which it will be possible to transfer content from SAP product to SAP Build Work Zone. You also need to configure a design-time destination from which the SAP Build Work Zone will fetch the exposed content. The following steps need to be performed for all integrations that support navigational scenarios.
- Create SAP Build Work Zone Application and Instance [page 11]
## Related Information
## 3.2.1  Create SAP Build Work Zone Application and Instance
Steps to create a subscription and instance of SAP Build Work Zone, standard edition.
Make sure that you have the entitlement for SAP Build Work Zone, standard edition (foundation plan) for both application and service added in your global account. For more information, see Prerequisites [page 7].
##  Note
If your subaccount already has the set up for SAP Build Work Zone system, standard edition (standard plan), you can skip these entitlements and continue to use the same and add the missing configurations.
## Create a Subscription for SAP Build Work Zone, standard edition
1. In the SAP BTP Cockpit, open your subaccount.
2. Go to Services Service Marketplace in the left navigation pane.
3. Search for SAP Build Work Zone, standard edition, and click the tile.
4. In the top right corner, click Create .
5. In the window that opens, keep all the default settings and click Create .
6. Assign users to the Launchpad\_Admin role collection. This role collection enables you to perform all the administration tasks for a SAP Build Work Zone, standard edition site, and is available out-of-the-box.
1. Go to Security Role Collections in the left navigation pane.
2. Search for the role collection Launchpad\_Admin .
3. Open the role collection for editing. Click the arrow at the far right, and in the role collection screen, click Edit .
4. In the Users section of the screen, search for your email and add it to the list of users by clicking the + button. Save your changes.
## Create an Instance for SAP Build Work Zone, standard edition
1. Go to Services Service Marketplace in the left navigation pane.
2. Search for SAP Build Work Zone, standard edition, and click the tile.
3. In the top right corner, click Create and enter the details of the new service instance.
##  Note
You must enable Cloud Foundry and create a space before you create a service instance. For more information, see Creating Service Instances in Cloud Foundry.
4. In the window that opens, keep all the default settings and click Create .
5. To create a service key, still in the Instances and Subscriptions screen, click the  (Actions) next to the service instance entry in the table, and create a service key. For more information, see Creating Service Keys in Cloud Foundry.
## Related Information
SAP Build Work Zone, standard edition
## 3.2.2  Configure Destination to Use Navigation Service
Steps to configure the destination for using the navigation service.
You need to configure a destination with the name NavigationService in the subaccount with Joule set up to use the navigation service and ensure that these targets are resolved at runtime.
1. Go to your subaccount for Joule set up and choose Connectivity Destinations and create new destination with the following information:
2. In the Additional Properties section, enter the following information:
| Field                  | Value                                                                                                              |
|------------------------|--------------------------------------------------------------------------------------------------------------------|
| Name                   | NavigationService                                                                                                  |
| Type                   | HTTP                                                                                                               |
| URL                    | portal-service URL from the service key created for the service instance of SAP Build Work Zone, standard edition. |
| Proxy Type             | Internet                                                                                                           |
| Authentication         | OAuth2UserTokenExchange                                                                                            |
| Client ID              | Client ID from the service key created for the service in- stance of SAP Build Work Zone, standard edition.        |
| Client Secret          | Client Secret from the service key created for the service instance of SAP Build Work Zone, standard edition.      |
| Token Service URL Type | Dedicated                                                                                                          |
| Token Service URL      | https://<uaa url>/oauth/token                                                                                      |
Use default JDK trust store
3. Save your changes.
## 3.2.3  SAP Build Work Zone, standard edition
## Prerequisites
- You've switched to SAP Cloud Identity Services - Identity Authentication as Joule leverages Identity Authentication for user login. If you're not yet using Identity Authentication, please switch over. For more information, see Switching to SAP Cloud Identity Services - Identity Authentication.
- Before completing the Joule onboarding tasks, you'll need to ensure that you've met the required prerequisites for both SAP Build Work Zone, standard edition and for Joule. For a list of these prerequisites, please refer to: Prerequisites [page 7].
##  Note
The trust is already created, so you can skip this particular step in the list of prerequisites.
- The Joule booster has been run. For more information, see Run the Joule Booster [page 17].
## Setting Up the Joule Integration
1. Once the Joule booster has been run, and the integrations between SAP Build Work Zone, standard edition and Joule is complete, a setting becomes available in the Site Settings screen of the site.
2. As an administrator, you can then go to the Site Settings screen and enable the Joule setting.
3. Once enabled, the Joule icon is displayed in the header of your runtime site.
##  Note
If you plan to set up Joule in another subaccount other than the SAP Build Work Zone, standard edition subaccount, then you need to ensure that for both subaccounts trust is established to the same SAP Cloud Identity Services - Identity Authentication tenant.
## Restrictions
To view a list of restrictions and constraints when using Joule, see Constraints for Joule [page 128].
Enable this option.
## 3.2.4  SAP Start
## Prerequisites
- You have already run the manual setup for SAP Start, to obtain a subscription to SAP Build Work Zone, standard edition.
For more information, see Manual Setup.
##  Note
If you run the automated set up for SAP Start, you can't select an existing subaccount. It is recommended to run the manual set up for SAP Start and select an existing subaccount.
- SAP Build Work Zone, standard edition is configured to use SAP Cloud Identity Services - Identity Authentication.
For more information, see Switching to SAP Cloud Identity Services - Identity Authentication.
##  Note
If you plan to set up Joule in another subaccount other than the SAP Build Work Zone, standard edition subaccount, then you need to ensure that for both subaccounts trust is established to the same SAP Cloud Identity Services - Identity Authentication tenant.
## Procedure
1. Run the Joule booster.
For more information, see Run the Booster.
##  Note
In steps 3 and 4 of the booster, you don't need to select anything from the Products and Capability Packages drop-down lists, respectively.
2. Add the Joule system created by the booster to the SAP Start formation:
1. In your global account, select System Landscape from the left panel, and select the Formations tab.
2. Search for your formation of type Integration with SAP Start and click Include Systems (in the top right corner of the formation).
3. Select the Joule system to include in the formation. This system has your subaccount in the Discovery column and Joule in the System Type column.
4. Click Next Step .
5. Click Include .
As a result, the Joule system is added to the formation's list of systems.
You can now use Joule in SAP Start by clicking the Joule icon that was added to the header.
## Restrictions
To view a list of restrictions and constraints when using Joule, see Constraints for Joule.
## 3.3 Configure Trust to the Identity Authentication Tenant
Use your SAP Cloud Identity Services - Identity Authentication tenant as an Identity Provider or a proxy to your own Identity Provider hosting your business users.
## Prerequisites
- You have subaccount administrator permissions. For more information, see Managing Subaccounts Using the Cockpit.
- You have a tenant of SAP Cloud Identity Services.
- For more information, see Tenant Model and Licensing in the documentation for Identity Authentication.
- The Identity Authentication tenant is associated with the customer IDs of the relevant global account of SAP BTP.
- For more information, see Reuse SAP Cloud Identity Services Tenants for Different Customer IDs in the documentation for Identity Authentication.
- You must use the same Identity Authentication tenant for all SAP applications that are included in the Joule formation.
## Procedure
1. In the SAP BTP cockpit, go to your subaccount and choose Security Trust Configuration .
2. Choose Establish Trust . The Configure Tenant wizard opens.
3. Choose the Identity Authentication tenant. The Identity Providers listed are the Identity Authentication tenants associated with your customer ID. Click Next .
4. Choose the domain configured with the Identity Authentication tenant and continue with Next .
##  Note
For single-sign on to work, the domain of the Identity Authentication tenant must be same as the corresponding SAP system trust setup.
5. You can change the name and the description of the tenant, display and change the origin key, and provide a link text for user logon (see Using Multiple Identity Providers from the Same Subaccount). Click Next .
6. Review your configuration and confirm using Finish . The application das-ias (subaccound name) is created in the administration console of the SAP Cloud
3. Identity Services.
## Related Information
Establish Trust and Federation Between SAP Authorization and Trust Management Service and Identity Authentication
## 3.4 Configure User Attributes for Joule from the Identity Directory
A step by step guide to configure user attributes from the identity directory.
1. Sign in to the administration console for SAP Cloud Identity Services.
2. Under Applications and Resources , choose the Applications tile.
3. Select the application which was automatically created in the previous step.
4. If you don't have a created application in your list, you can create one. For more information, see Create a New Application.
5. Choose the Trust tab.
6. Under SINGLE SIGN-ON , choose Attributes .
7. Under the Self-defined Attributes section, choose Expand All to view all the information about the user attributes. Ensure that the following SAML Assertion Attributes are present:
8. If any attribute is missing, choose the Add button.
9. Provide a name for the attribute.
10. Choose Identity Directory source.
11. Choose a value from the drop-down list.
12. Optional: Choose the plus button next to the attribute to set a new value for the attribute.
13. Save your configuration.
| User Attribute   | User Attribute Name   |
|------------------|-----------------------|
| email            | Email                 |
| Email_verified   | Email Verified        |
| family_name      | LastName              |
| given_name       | FirstName             |
| groups           | Groups                |
| user_uuid        | Global User Id        |
## Related Information
SAP Cloud Identity Services - Configuring User Attributes from the Identity Directory Global User ID in Integration Scenarios
## 3.6 Configure Trusted Domains in Identity Authentication
You need to add the domain of the integration product as trusted domain in the Identity Authentication.
## Prerequisites
You are assigned the Manage Tenant Configuration role. For more information about how to assign administrator roles, see Edit Administrator Authorizations.
## Procedure
1. Sign in to the administration console for SAP Cloud Identity Services.
2. Under Applications and Resources , choose the Tenant Settings tile. At the top of the page, you can view the administrative and license relevant information of the tenant.
3. Under Customization , choose the Trusted Domains list item
4. Press the + Add button.
5. Type the URL of the trusted host in the field. You can type either the full name of the host or you can use the wild card * function.
##  Caution
Be careful when using the wild card * function. Make sure that you trust the domain when you use it.
See the examples:
mycompany.ondemand.com
*.example.com
6. Save your changes.
If the operation is successful the system displays the message Trusted Domains updated .
For more information, see Configure Trusted Domains.
## 3.7 Configure Trusted Domain in SAP BTP
You can add, configure and save newly created trusted domain.
1. Go to your subaccount and choose Security Settings .
2. Choose + (Add).
3. Enter the host name for the trusted domain.
4. For example: https://store.example.com
5. All the trusted domains together, including their space separators, can't exceed 2048 characters.
6. Save your entries.
## 3.8 Unsubscribe from Joule
This section provides instructions on how to unsubscribe and delete a Joule subscription and service instance. Use it to efficiently manage your subscriptions and free up resources when no longer needed.
If you no longer need the Joule subscription or the service instance, you can delete them.
Upon unsubscribing from Joule, all new configurations will be deleted. All services that are part of Joule setup will be unsubscribed, and their persisted data will be deleted. Consequently, you will not be able to access your assistant and the chat data.
##  Note
Once you delete the subscription, all your tenant data is deleted. Consequently, you will not be able to access your assistant and the chat data.
## Deleting the Joule Subscription
1. Open the Cockpit of your subaccount.
2. Open your Subaccount tile and click Instances and Subscriptions in the navigation pane on the left.
3. Find the application Joule under Subscriptions .
4. Click Delete under the actions menu (  ) on the right. The subscription is deleted.
##  Caution
After you have deleted the subscription of Joule, you may not be able to re-subscribe in the same subaccount. Create a subscription in another subaccount in which you haven't yet subscribed to Joule or raise a ticket to CA-DAS-TO .
## 4 Integrating Your SAP Solution
Use the following table to search for your SAP Solution, navigate the solution specific integration guide, and integrate your solution with Joule.
Integrating your solution
| SAP Solution                                         | Integration Guide                                             |
|------------------------------------------------------|---------------------------------------------------------------|
| SAP Analytics Cloud (analytical insights capability) | Integration with SAP Analytics Cloud [page 25]                |
| SAP SuccessFactors                                   | Integration with SAP SuccessFactors [page 41]                 |
| SAP S/4HANA Private Cloud                            | Integration with SAP S/4HANA Cloud Private Edition [page 49]  |
| SAP S/4HANA Cloud Public Edition                     | Integration with SAP S/4HANA Cloud Public Edition [page 67]   |
| SAP Integrated Product Development                   | Integration with SAP Integrated Product Development [page 83] |
| SAP Asset Performance Management                     | Integration with SAP Asset Performance Management [page 83]   |
| SAP Integrated Business Planning                     | Integration with SAP Integrated Business Planning [page 84]   |
| Joule for Microsoft 365 Copilot                      | Integrating Joule with Microsoft 365 Copilot [page 100]       |
| SAP Digital Manufacturing                            | Integration with SAP Digital Manufacturing [page 84]          |
| SAP Logistics Management                             | Integration with SAP Logistics Management [page 101]          |
| SAP Ariba solutions                                  | Integration with SAP Ariba [page 89]                          |
## 4.1 SAP Build Work Zone, standard edition
## Prerequisites
- You've switched to SAP Cloud Identity Services - Identity Authentication as Joule leverages Identity Authentication for user login. If you're not yet using Identity Authentication, please switch over. For more information, see Switching to SAP Cloud Identity Services - Identity Authentication.
- Before completing the Joule onboarding tasks, you'll need to ensure that you've met the required prerequisites for both SAP Build Work Zone, standard edition and for Joule. For a list of these prerequisites, please refer to: Prerequisites [page 7].
##  Note
The trust is already created, so you can skip this particular step in the list of prerequisites.
- The Joule booster has been run. For more information, see Run the Joule Booster [page 17].
## Setting Up the Joule Integration
1. Once the Joule booster has been run, and the integrations between SAP Build Work Zone, standard edition and Joule is complete, a setting becomes available in the Site Settings screen of the site.
2. As an administrator, you can then go to the Site Settings screen and enable the Joule setting.
3. Once enabled, the Joule icon is displayed in the header of your runtime site.
##  Note
If you plan to set up Joule in another subaccount other than the SAP Build Work Zone, standard edition subaccount, then you need to ensure that for both subaccounts trust is established to the same SAP Cloud Identity Services - Identity Authentication tenant.
## Restrictions
To view a list of restrictions and constraints when using Joule, see Constraints for Joule [page 128].
## 4.2 SAP Start
## Prerequisites
- You have already run the manual setup for SAP Start, to obtain a subscription to SAP Build Work Zone, standard edition.
For more information, see Manual Setup.
##  Note
If you run the automated set up for SAP Start, you can't select an existing subaccount. It is recommended to run the manual set up for SAP Start and select an existing subaccount.
- SAP Build Work Zone, standard edition is configured to use SAP Cloud Identity Services - Identity Authentication.
For more information, see Switching to SAP Cloud Identity Services - Identity Authentication.
##  Note
If you plan to set up Joule in another subaccount other than the SAP Build Work Zone, standard edition subaccount, then you need to ensure that for both subaccounts trust is established to the same SAP Cloud Identity Services - Identity Authentication tenant.
## Procedure
1. Run the Joule booster.
For more information, see Run the Booster.
##  Note
In steps 3 and 4 of the booster, you don't need to select anything from the Products and Capability Packages drop-down lists, respectively.
2. Add the Joule system created by the booster to the SAP Start formation:
1. In your global account, select System Landscape from the left panel, and select the Formations tab.
2. Search for your formation of type Integration with SAP Start and click Include Systems (in the top right corner of the formation).
3. Select the Joule system to include in the formation. This system has your subaccount in the Discovery column and Joule in the System Type column.
4. Click Next Step .
5. Click Include .
As a result, the Joule system is added to the formation's list of systems.
You can now use Joule in SAP Start by clicking the Joule icon that was added to the header.
## Restrictions
To view a list of restrictions and constraints when using Joule, see Constraints for Joule.
## 4.3 Integration with SAP Analytics Cloud
View the steps required to enable Joule's analytical insights capability, powered by SAP Analytics Cloud, for your SAP product. Note that these steps do not make Joule itself available in SAP Analytics Cloud, but instead allow your users to ask questions to the Joule analytic insights feature from other SAP products.
##  Note
The Joule 2506 release has introduced a change that affects Joule analytical insights. SAP Build Work Zone is now required as part of the integration to provision and sync users and roles from SAP Analytics
Cloud to SAP Build Work Zone. If you have activated analytical insights in Joule before the 2506 release, you may want to redo the setup, for more information see Analytical Insights in Joule - Setup Guide .
## Prerequisites
- You must be an SAP BTP global account administrator to run the Joule booster steps in this guide and set up the capability.
- You must have SAP Build Work Zone as part of the integration to provision and sync users and roles from SAP Analytics Cloud to SAP Build Work Zone.
- You have set entitlements for SAP Build Work Zone. For more information, see Create SAP Build Work Zone Application and Instance [page 11].
- You have created an SAP Build Work Zone destination with the name NavigationService in the subaccount with Joule set up. For more information, see Configure Destination to Use Navigation Service [page 12].
- You must have a single SAP Analytics Cloud tenant with at least three free OAuth client slots available.

##  Restriction
Adding more than one SAP Analytics Cloud tenant to your Joule formation is not supported and will result in an error. Exclude additional tenants until only one is included.
To check for available OAuth client slots navigate to System Administration App Integration and check the Configured Clients section; if you see the  Add a New OAuth Client button, it indicates that slots are available.
- Your SAP Analytics Cloud user accounts must have Read permission for the Joule privilege to use analytical insights.
- The just ask feature in your SAP Analytics Cloud tenant must be enabled.
You can check this in SAP Analytics Cloud by going to System Administration Default Appearance and checking that the Just Ask toggle under the Conversational Analytics section is enabled.
## Integration Steps
The integration process involves the following steps:
- Enable the Analytical Insights Capability in Joule [page 27]
- Consume Role Definition Content from SAP Analytics Cloud [page 29]
- Provision Users from SAP Analytics Cloud to SAP Build Work Zone Using IPS [page 38]
- Index Your Data Using Just Ask and Test Your Integration [page 40]
## 4.3.4  Index Your Data Using Just Ask and Test Your Integration
Set up your business data for analytical insights in the just ask feature of SAP Analytics Cloud.
The data available for your business users to ask Joule analytical questions is the data from supported models indexed by the just ask feature in your SAP Analytics Cloud tenant. Analytical insights supports the following indexed models:
- Acquired models with data imported into SAP Analytics Cloud.
- Analytic models from SAP Datasphere that are part of an SAP Business Data Cloud formation that includes your SAP Analytics Cloud system and Joule.
For full details on how to index your data in just ask, see Manage Models in the Exploring Your Data with Just Ask section of the SAP Analytics Cloud help documentation.
Your users will also need different permissions in SAP Analytics Cloud depending on their role:
- To index models in the just ask feature of SAP Analytics Cloud, users will need the Maintain permission for the Just Ask privilege.
- To simply ask questions to Joule's analytical insights feature, and see answers and charts, users will need the Read permission for the Joule privilege.
You can check the permissions by viewing the role details for any role in the Security Roles page of your SAP Analytics Cloud tenant.
By default, the sample model My Files/Samples/Sales\_SampleModel is indexed by just ask. Y ou can use these sample models to try out the capability. You can also include your own organization's acquired model in the Manage models section of the Just Ask page to make them available to Joule.
## Test Your Integration in Joule
To test your complete integation of analytical insights, open your Joule client from any of your SAP products where Joule is available and ask a question that can be answered by the sample model Sales\_SampleModel .
For example, ask Joule "Show me sales by state year to date" and a corresponding chart should be displayed such as the following:

For additional example questions to try, see Analytical Question Examples. You can also ask Joule additional business questions about the supported data you've indexed with the just ask feature in your SAP Analytics Cloud tenant.
If Joule is available for your product, and the analytical insights capability has been successfully enabled, your business users can open using the Joule icon  from inside your product. For example, in the SAP SuccessFactors, just click the Joule icon and start asking it business questions about your data.
For more information on how to explore your data using analytical insights, see: Analytical Insights with SAP Analytics Cloud
## 4.4 Integration with SAP SuccessFactors
Steps required to integrate Joule in SAP SuccessFactors.
## Prerequisites
- You have fulfilled the necessary prerequisites as mentioned in Prerequisites [page 7].
- You have integrated SAP SuccessFactors with Identity Authentication as Joule leverages the IAS setup of the integrated SAP product for user login. For more information, see Getting Started with Identity Authentication and SAP SuccessFactors.
- You have created a service instance and generated a service key for SAP Build Work Zone, standard edition (foundation plan). For more information, see Create SAP Build Work Zone Application and Instance [page 11].
## Integration Steps
The integration process involves the following steps:
- Register an SAP SuccessFactors System in a Global Account in SAP BTP
- Run the Joule Booster [page 17] with SAP SuccessFactors as an option in the Select Integrations screen. You can select other products in combination with SAP SuccessFactors if you have appropriate licenses and entitlements.
- Create SAP Build Work Zone Application and Instance [page 11]
- Consume Content from SAP SuccessFactors [page 42]
- Configure Identity Provisioning Service [page 45]
## 4.4.3  Setting Up Joule in SAP SuccessFactors
Set up Joule in your SAP SuccessFactors system to enable users to use Joule right out of the box.
## Prerequisites
You have the following system administrator roles:
- SAP SuccessFactors Administrator
- SAP BTP Global Account Administrator
- SAP Cloud Identity Services Administrator
For more information on prerequisites, refer to Prepare for Joule Activation .
##  Caution
For SAP SuccessFactors Mobile customers, consider the following restrictions and prerequisites before setting up Joule in SAP SuccessFactors Mobile:
- Enabling Joule in SAP SuccessFactors Mobile relies on BTP Mobile Services for authentication, which currently doesn't support multi-profile mode. If your organization wants to allow mobile users to use multi-profile mode, please do not enable Joule in SAP SuccessFactors Mobile.
- For other impacts of using BTP for mobile authentication, refer to Authentication with BTP Mobile Services.
- Joule in SAP SuccessFactors Mobile is available in restricted data centers. For more information, refer to 3583836 .
- Make sure that your SAP SuccessFactors Mobile app version is at least 15.0.1 for iOS or 15.0.2 for Android.
## Procedure
1. Follow the steps in the Community blog to finish the setup.
2. Follow the steps below to set up Joule in SAP SuccessFactors Mobile:
- a. In Cloud Identity Services, choose the Applications &amp; Resources tab and select Applications .
- b. In the applications list, search for SFSF Mobile Service and open the details page.
- c. Under the Trust tab of the SFSF Mobile Service application, select Dependencies in the Application APIs section.
- d. Add an API dependency by choosing the Add button and entering the following details:
| Dependency Name   | JOULE                |
|-------------------|----------------------|
| Application       | Start with "das-ias" |
| API               | joule-api            |
3. Grant users the User Permissions General User Permission Access to Joule permission.
4. For SAP SuccessFactors Mobile customers, contact Technical Support to complete the setup. For more information, refer to the last step in 3583836 .
5. Recommended: For SAP SuccessFactors Employee Central customers, enable the Employee Central Quick Actions feature and configure the corresponding templates.
For more information on the configuration, refer to Employee Central Quick Actions.
## Results
Joule is now ready to use.
## 4.5 Integration with SAP S/4HANA Cloud Private Edition
This section describes the steps to enable the Joule Communication Scenario on your SAP S/4HANA Private Cloud instance and integrate Joule Web Client plugin in your SAP Fiori Launchpad, allowing your users to interact with Joule.
## Prerequisites
- You have carried out the steps described in Initial Setup [page 6].
- You have referred to the Security related information for Joule.
- You have fulfilled the necessary prerequisites as mentioned in Prerequisites [page 7].
- You have integrated the SAP S/4HANA Cloud Private Edition with Identity Authentication as Joule leverages the IAS setup of the SAP product for user login.
- You have created a service instance and generated a service key for SAP Build Work Zone, standard edition (foundation plan). For more information, see Create SAP Build Work Zone Application and Instance [page 11].
- You have added the entitlement for the connectivity plan of the Cloud Identity services in your subaccount.
## Integration Steps
1. Configure Trust to the Identity Authentication Tenant [page 15]
2. Configure Trusted Domain in SAP BTP [page 21]
3. Configure User Attributes for Joule from the Identity Directory [page 16]
4. Configure Trusted Domains in Identity Authentication [page 20]
5. Expose SAP Fiori Launchpad Content to SAP BTP [page 52]
6. Set Up SAP S/4HANA Cloud Private Edition as a Content Provider [page 50]
7. SAP Build Work Zone and SAP Start [page 10]
8. Run the Joule Booster [page 17]
9. Configure Destinations [page 53]
10. Configure Identity Provisioning Service [page 58]
11. Configure and Activate Joule Plug-In in a Target Mapping [page 66]
## 4.5.2  Expose SAP Fiori Launchpad Content to SAP BTP
Administrators can expose SAP Fiori launchpad content to SAP BTP by choosing specific roles. The related content, such as groups, catalogs, pages, or spaces can then be consumed on SAP BTP. For information, see Manage Launchpad Content for Exposure.
## Procedure
Expose your SAP Fiori launchpad content:
1. Launch transaction /UI2/CDM3\_EXP\_SCOPE .
2. Choose the exposure version you would like to use. See Content Exposure Versions Overview.
##  Note
Each exposure version uses a dedicated repository, allowing you to run, schedule, and use both version 1 and version 2 simultaneously.
3. Choose which roles you want to provide to SAP BTP. You have the following options:
- All roles with launchpad content - By default, all roles are exposed.
- Selected roles in areas (all selected roles in all areas will be exposed) - Select specific roles or bundle several roles in a specific area. See Select Roles for Content Exposure.
##  Note
All roles contained in the role selections of all areas are used for the exposure. To add additional roles to the exposed content, simply include these roles in the existing role selection and execute the exposure. Conversely, to remove specific roles from the exposed content, simply exclude these roles from the existing role selection and execute the exposure.
##  Note
Derived roles are not supported directly. If you want to expose a derived role, choose the leading role containing the launchpad content and add it to the role selection. The derived role will be exposed indirectly as a related role assignment.
4. Optional: Click Preview Content or Preview Area Content to see a preview of the selected content. This might help you to see if you have selected all your required content and if the content contains any errors or warnings that you might need to fix before exposing.
5. Save your defined roles by clicking on Save Selected Roles . The role selection must be saved first before exposing. Otherwise you will expose the last saved role selection.
6. Check whether your content contains any errors by either clicking View Log or Preview Content Display Log . Note that only content without errors can be exposed.
7. Expose your launchpad content:
- Schedule a job to expose your content on a regular basis. The exposure process will use the saved configuration. See Schedule Content Exposure.
- Click Expose Content to manually trigger the exposure of the saved configuration.
## Related Information
Manage Launchpad Content for Exposure
## 4.5.5  Configure and Activate Joule Plug-In in a Target Mapping
Steps to configure and activate Joule plugin in SAP Fiori Launchpad.
You need to create a target mapping to activate the Joule plugin in the SAP Fiori Launchpad of your application. As a prerequisite, you must create a business catalog. For more information, see Creating Catalogs.
## Procedure
## Procedure
1. In the launchpad app manager (see e.g. Creating and Maintaining Launchpad App Descriptor Items), create a target mapping with the intent Shell-plugin and the following configuration:
| Field            | Value                                                                                                                                             |
|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| Semantic Object  | Shell                                                                                                                                             |
| Action           | plugin                                                                                                                                            |
| Application Type | SAP UI5 Fiori App                                                                                                                                 |
| Title            | Joule                                                                                                                                             |
| URL              | URL of the Joule application appended with /resources/public/ webclient/s4                                                                        |
| ID               | sap.das.webclientplugin.s4                                                                                                                        |
| Information      | Optional: Enter a description of your plug-in.                                                                                                    |
| Device Types     | Select the device or devices that are supported by your plug-in, e.g. desktop or phone. The plug-in will only be shown on these selected devices. |
| Parameters       | Define parameters that you want to pass to the plug-in component by entering a name and a default value for each parameter.                       |

##  Note
As target mappings with the intent Shell-plugin have a special meaning, they do not appear in standard services such as the TargetMappings feed, resolveLink , or getLinksForSemanticObjects .
2. In the launchpad content manager, assign the catalog to a role. See Adding and Removing Catalogs, Groups and Spaces to/from Roles for detailed information.
3. If you have not already done this, assign the role to the respective users (see Assigning Users to Roles ).
## 4.5.6  Constraints for Joule in SAP S/4HANA Cloud Private Edition
In addition to the general Constraints for Joule [page 128], the following constraints apply for Joule in SAP S/4HANA Cloud Private Edition:
- Joule is available for SAP S/4HANA Cloud Private Edition 2021 onwards but with some exceptions. All capabilities of Joule may not be supported from 2021 but from a higher release. For the list of capabilities available per release of SAP S/4HANA Cloud Private Edition, please refer to Release-Specific Capabilities and 3523238 .
- A Joule instance can be only connected to exactly one SAP S/4HANA Cloud Private Edition.
- Joule is available for SAP S/4HANA Cloud Private Edition only within Rise with SAP .
- You can enable Joule for SAP S/4HANA Cloud Private Edition only in an SAP managed data center setup.
- Currently, you will have to add your relevant SAP S/4HANA Cloud Private Edition system as a part of the Joule formations, in the following cases, for Joule to leverage the latest SAP S/4HANA Cloud Private Edition capabilities available for Joule:
- You already have a Joule formation, but do not have your SAP S/4HANA Cloud Private Edition system added to such a formation.
- You have upgraded your SAP S/4HANA Cloud Private Edition system.
For more information, refer to Include or Exclude a System in the Joule Formation.
- In case you are already using Joule in your SAP S/4HANA Cloud Private Edition system but do not have the Joule formations, you will have to run the Joule booster by referring to Run the Joule Booster [page 17] or create the formations by referring to Formations.
- To be able to use the Joule capabilities, the minimum UI5 version required per release of your SAP S/ 4HANA Cloud Private Edition system must be used, as given in the following table.
|   SAP S/4HANA Cloud Private Edition Release | Minimum UI5 Version Required   |
|---------------------------------------------|--------------------------------|
|                                        2021 | 1.96.33                        |
|                                        2022 | 1.108.33                       |
|                                        2023 | 1.120.0 or Latest              |