SAP-samples/ai-seamless-integration

AI Seamless Integration Sample App

Description

This sample project demonstrates the seamless integration of UI5 Web Components into the OpenUI5 framework showing AI use cases. The goal is to showcase how modern UI5 Web Components can be used alongside classic OpenUI5 controls within a single application, enabling developers to take advantage of AI use cases as per design guidelines.

By using this sample, you can explore best practices for embedding UI5 Web Components in OpenUI5 views, handling interoperability, and leveraging the strengths of both frameworks. It demonstrates AI Button component, AI Acknowledgment Pattern & AI Quick Prompt Pattern.

Requirements

Either npm, yarn, or pnpm for dependency management.

Download and Installation

1. Clone the project:

git clone https://github.com/SAP-samples/ai-integration.git
cd ai-integration

(or download from https://github.com/SAP-samples/ai-integration/archive/main.zip)

2. Use npm (or any other package manager) to install the dependencies:

npm install

Run the App

Execute the following command to run the app locally for development in watch mode (the browser reloads the app automatically when there are changes in the source code):

npm start

As shown in the terminal after executing this command, the app is then running on http://localhost:8080/index.html.
A browser window with this URL should automatically open.

Debug the App

In the browser, you can directly debug the original TypeScript code, which is supplied via sourcemaps (need to be enabled in the browser's developer console if it does not work straight away).
If the browser doesn't automatically jump to the TypeScript code when setting breakpoints, use e.g. Ctrl/Cmd + P in Chrome to open the *.ts file you want to debug.

Known Issues

No known issues at this time.

How to obtain support

Create an issue in this repository if you find a bug or have questions about the content.

For additional support, ask a question in SAP Community.

Contributing

If you wish to contribute code, offer fixes or improvements, please send a pull request. Due to legal reasons, contributors will be asked to accept a DCO when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses the standard DCO text of the Linux Foundation.

License

Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.