DOCSEARCHbyAlgolia
Submit Docs

SAP Open UX Tools

repository·main·Indexed 41 days ago

https://github.com/sap/open-ux-tools

Open-source building blocks and middlewares designed to streamline the development of SAP Fiori applications. The toolkit includes utilities for OData metadata fetching, Yeoman generator patterns, and ABAP deployment configuration via packages such as @sap-ux/abap-deploy-config-inquirer, @sap-ux/abap-deploy-config-writer, and @sap-ux/abap-deploy-config-sub-generator.

Tokens
575.1K
Snippets
1.9K
Records
2.5K
Agent score
100%

What's inside Open UX Tools

  3. Overview of Open UX Tools

    main

    Open UX Tools is a collection of open-source modules designed to make the development of SAP Fiori applications more efficient. The project provides reusable building blocks, such as templates for generating SAP Fiori applications, UI5 tooling middlewares, and helper modules for modifying UI5 tooling configuration files.

    All modules are published to npmjs.com under the @sap-ux scope. The package name (without the scope) corresponds to the folder name in the packages directory (e.g., ./packages/fiori-freestyle-writer is published as @sap-ux/fiori-freestyle-writer).

  4. Overview of @sap-ux/adp-tooling

    main
    The @sap-ux/adp-tooling module provides a collection of specialized submodules designed to assist with SAP UI5 adaptation projects. It is primarily intended to be used as a dependency within larger tools (like generators or middleware) rather than as a standalone application.

  5. Overview of CAP Sample Projects

    main

    The repository contains several CAP (Cloud Application Programming Model) sample projects designed to demonstrate different approuter configurations and deployment strategies for Cloud Foundry. Use these to test managed/standalone/hybrid router configurations, create BTP destinations, and deploy to SAP BTP.

    Available Sample Projects:

    1. Managed Approuter with SAP HANA Cloud service
      • Path: cap/cap-fiori-mta/README.md
    2. Standalone Approuter with an in-memory database
      • Path: cap/cap-fiori-mta-standalone/README.md
    3. Managed Approuter with CDS Hybrid Profile (HANA + XSUAA on SAP BTP)
      • Path: cap/cap-fiori-hybrid/README.md
    4. Create a SAP BTP Destination exposing CAP services
      • Path: cap/destination/README.md (Supports cross subaccount & regions)

  8. Overview of SAP Fiori Application Development and Extension Steps

    main

    The SAP Fiori tools ecosystem is organized into three main development phases:

    1. Developing an Application

    Focuses on project structure, page element configuration (List Reports, Object Pages, Forms), and maintaining elements via:

    • Annotation-based elements: Using the annotation language server for completion, snippets, and diagnostics.
    • Extension-based elements: Adding custom columns, sections, fields, or controllers.

    2. Deploying an Application

    Covers deployment to Cloud Foundry or ABAP environments, configuring SAP Fiori Launchpad, and managing security/exposure to the central router.

    3. Extending an Existing Application (Adaptation Projects)

    Allows for UI adaptations (control variants, fragments, controller extensions) and app descriptor changes (replacing OData services, adding local annotations) for both On-Premise and Cloud/S/4HANA Cloud environments.

  9. What is Control Property Editor Common?

    main
    Control Property Editor Common is a supporting module designed to facilitate communication between a React application and a UI5 application running within an iframe. It provides utility methods and registers an EventLister to enable this cross-application communication. It is primarily used as a dependency for @sap-ux/control-property-editor and @sap-ux-private/preview-middleware-client.

  10. Overview of @sap-ux/deploy-config-generator-shared

    main
    @sap-ux/deploy-config-generator-shared is a utility package containing shared functionality designed to support various deployment configuration generators within the Open UX Tools ecosystem. It provides common logic and tools that are reused across multiple deployment configuration generator modules to ensure consistency and reduce duplication.

  11. Overview of features in generated Fiori projects

    main

    Projects generated by the fiori-tools generator include several key features. Use the following modules to implement, configure, or troubleshoot them:

    • Annotation Support: Enable or customize OData annotation handling for model-driven UI elements.
    • Taskbar Notification: Enable desktop or in-app notifications for background tasks or updates.
    • Edit in Source Code: Modify and persist generated UI or controller code.
    • Automatic Generation: Understand the scaffolding process and how to re-run or customize the generator.
    • Internationalization (i18n): Add or modify translations and resource bundles for multi-language support.
    • Project Cleanup: Remove unnecessary files and apply best-practice folder structures before deployment.

  12. Overview of Connection Manager for SAP Systems (Webapp)

    main

    The Connection Manager for SAP Systems (Webapp) is the front-end interface for the Connection Manager for SAP Systems extension. It enables users to view, configure, and manage SAP system connections directly within their IDE.

    Development and Deployment

    • Local Development: During development, the webapp can be built and served locally to facilitate faster iteration and debugging.
    • Production/Packaging: When the extension is packaged, the webapp is bundled into the dist/webapp directory and loaded at runtime.