Exploring the Capability to Customize UI Pages in SAP Business One, Web Client

Objective

After completing this lesson, you will be able to describe how to create UI extensions by customizing the SAP Business One, Web Client UI pages

UI API Extensions

The SAP Business One Web Client Extensibility Landscape graphic with the UI API Extensions highlighted.

With SAP Business One, Web client 10.0 FP 2405, you can use the UI API framework. This framework allows you to create UI extensions on top of the Web client, so that you can customize system views to suit specific business needs. For example, extending the Business Partner Detail view with a tab containing a grid with the last five items purchased by this customer. Selecting an entry in the Item Name column will open a Google search for this item.

UI API Framework:

  • Allows you to customize Web client views.
  • Supports UI controls.
  • Supports events.
  • Provides samples and SAP Help documentation.

The UI API Framework has four key steps.

The SAP Business One Web Client Extensibility Development Process outlining four key steps: Develop, Package, Deploy, and Run.
  1. Develop: The key development tools in the UI API framework include:
    • Web Client Inspector extension: A standard Chrome or Edge extension that helps app developers to inspect, analyze, and debug extensions and plugins for SAP Business One, Web client.
    • Dedicated Visual Studio Code plugin for the Web client: If you install this plugin, it provides you with an all-in-one environment, where the development environment is set up automatically (working on the Chrome browser only). With this plugin, you can:
      • Create the extension for a system view or multiple views.
      • Create an extension for a User-Defined Object (UDO) or User-Defined Table (UDT).
      • Design your own GUI and code in the extension.
  2. Package: You package the Visual Studio Code project by building an .mtar archive file.
  3. Deploy: Once the extension is ready, the admin deploys the .mtar archive file extension using the import function in the SAP Business One Extension Manager. The admin assigns the deployed extension to a company in the Web client production environment by using the SAP Business One Extension Manager.
  4. Run: As a result, the user sees no difference between the Web client system views and the extension.

Note

Not all parts of SAP Business One, Web client user interfaces can be customized. For more details refer to Web Client UI API References | SAP Help Portal

Prerequisites

Before you start working with UI API Extensions for SAP Business One, Web client, you need to:

  • Install SAP Business One, Web client 10.0 FP 2405 or higher.
  • Install Visual Studio Code plugin for the Web client.
  • Install SAP Business One Web Client Inspector.

We'll cover the process for installing the Visual Studio Code plugin and the SAP Business One Web Client Inspector in the following lessons.

For more details on UI API Extensions, refer to UI API Extensions | SAP Help Portal.

Log in to track your progress & complete quizzes