TB 1300 - SAP Business One SDK

Introduction
May, 2023

PUBLIC
Agenda

▪ Deployment model and Technology

▪ The SAP Business One SDK
▪ Introduction to DI API
▪ Introduction to Service Layer
▪ Introduction to UI API

Public 2
Partner Solution Implementations

COMPATIBILITY HTML5 / FIORI

MODE SOLUTIONS XSJS, ODATA, NODEJS

ML VORA Apple SDK IoT

LOOSELY COUPLED

HANA DB SOLUTIONS
UI API
SAP Cloud Platform (Cloud Foundry)
HTTPS

HTML5 / FIORI
XSJS, ODATA, NODEJS
Service Layer
DI API B1 Business Script
TIGHTLY COUPLED Logic Engine
B1 Business Logic
SOLUTIONS ODBC
B1 HANA DB
B1 MSSQL DB

Public 3
SAP Business One: Business Platform

Low cost of
ownership Expands the
and support solution scope

Robust integration
and collaboration

Extensibility OData Interface

Covers all standard

business processes

Runs on in-memory
technology

Deployment flexibility

Public 4
SAP Business One: Technology and Interfacing

■ Continuous and integrated solution

SAP® Business One ■ Windows look & feel (SAP style)
Ease of Use ■ Simple navigation
■ Ability to drill down to details
Client
■ “Drag and relate” feature
GUI SDK (COM)
■ Two-tier client-server architecture (fat client)
Product ■ Microsoft Windows 64 Bit support
Architecture ■ Microsoft SQL Server / HANA Server
Server
■ Customizing
Interfaces
Integration ■ Form Settings
■ Queries / Reports
Adaptations ■ User-Defined Tables and Fields
SDK (COM)
■ Linkage of input fields to queries
SQL Server / HANA Services ■ User-Defined Objects (UDOs)
SDK (DI Server)
Email MS Office ■ Microsoft Excel, Word (out)
RDBMS Integration ■ Microsoft Outlook (in / out)
Backup

License ■ File-based (built-in)

■ SOAP (HTTP/XML)
Interfaces ■ APIs (COM, web services (SOA) starting)
■ User-Defined objects (UDOs)
■ Integration (not only) to SAP systems
Public 5
Agenda

▪ Deployment model and Technology

▪ The SAP Business One SDK
▪ Introduction to DI API
▪ Introduction to Service Layer
▪ Introduction to UI API

Public 6
Introducing SAP Business One SDK: Topic Objectives

After completing this topic, you will be able to

▪ Describe purpose and components of the SDK
▪ Explain in high level about the SDK packages and licenses
▪ Find further information and use the community to ask questions and get answers

Public 7
 SAP Business One SDK - Motivation

SAP Partner
■ Customization capabilities are Add-Ons Add-Ons
powerful!

■ However the customization

capabilities cannot solve
every requirement

■ The Source code of SAP SAP

Business One
Business One is not
accessible

■ Therefore you can use the

SDK to develop the required Software
solution. Development
Public
Kit 8
SAP Business One SDK – Components Overview

Client Server

User Interface API

3rd Party SAP SAP Business One
Application Business One Database
Java Co

Data DI Server
Interface
API
Server
License
Service
UDO

Public 9
SAP Business One SDK – Terminology and Packaging

SDK Installation

▪ Development package for partners – includes SDK help, code samples, tools and
SAPBusinessOneSDK.dll

Runtime:
▪ Only one runtime is available for development and productive usage
▪ The runtimes (DI API + UI API) are installed together with the SAP Business One client application
▪ DI API can be installed stand-alone (separate installer package available)

Public 10
 What You Can Find on SAP Community Network: People Like You...

The most important source of information for developers (SAP Community Network):
■ https://www.sap.com/community/topics/business-one.html

Public 11
Agenda

▪ Deployment model and Technology

▪ The SAP Business One SDK
▪ Introduction to DI API
▪ Introduction to Service Layer
▪ Introduction to UI API

Public 12
Introducing Data Interface API (DI API) : Topic Objectives

After completing this topic, you will be able to

▪ Explain what DI API is in high level
▪ Tell how DI API is used
▪ Explain about DI Server in high level

Public 13
SAP Business One SDK – Data Interface API / DI Server

▪ Provides objects and methods (add, update

etc.) to work on data level
Installing the SAP Business One client application
is not required

▪ Provides access to business objects

E.g. master data, transactional data and services

▪ Performs the same validations as the SAP

Business One client application

▪ Links existing third-party solutions “as-is”

▪ Use COM capable development tools

e.g. Microsoft Visual Studio

Public 14
Data Interface API – Use Cases

Data level integration of Data import / export

existing applications scenarios

Handling data in an add-on

that uses UI API

Public 15
SAP Business One SDK – DI Server

The DI Server is designed to run on a server machine and supply a light-weight SOAP-based
access layer

▪ Based on the DI API technology but functions as a “Server” (as a service)

▪ Supports all business objects that are exposed by the DI API
▪ Enables developing SOAP-based solutions
▪ Potential solution to heavy duty operations (e.g. batch)
▪ Can support larger number of clients working at the same time

Public 16
Agenda

▪ Deployment model and Technology

▪ The SAP Business One SDK
▪ Introduction to DI API
▪ Introduction to Service Layer
▪ Introduction to UI API

Public 17
Introducing Service Layer: Topic Objectives

After completing this topic, you will be able to

▪ Describe in high level the Service Layer fundamentals and architecture
▪ List the OData key points

Public 18
SAP Business One Service Layer - Extensibility for Next Generations Apps

New generation of extension API for consuming SAP Business One data and services.
SAP UI5

❑ Equivalent BO coverage to DI API

❑ Built on core protocols such as HTTP and OData
❑ Highly scalable (parallel-processing)
❑ High availability (load balancing)

Value Proposition
❑ Cater customer needs of using mobile and web apps
SAP Business One
❑ High volume to support new customer segment and industries Service Layer
❑ One Box for OLTP, OLAP and DEV platform
Physical Tables

SAP HANA SERVER

MSSQL SERVER

Public 19
B1 Service Layer Architecture

SAP UI5

HTTPs/OData

SAP Business One Service Layer

Session
OData Parser DI Core … Manager

OBServer

C++ business
object
C++ business
object
… C++ business
object

ODBC
ODBC
SAP HANA SERVER
Physical Tables
MSSQL SERVER

Public 20
OData - Key points
Just HTTP
▪ Data as resources, HTTP methods to act
on it

Uniform operations
▪ GET, POST, PATCH, PUT, DELETE
always mean the same

Uniform way of representing structured data

▪ Atom
▪ JSON

Uniform URL conventions

▪ Navigation, filtering, sorting, paging, etc.
Any OData client can access data
provided by any OData data source.

Public 21
Agenda

▪ Deployment model and Technology

▪ The SAP Business One SDK
▪ Introduction to DI API
▪ Introduction to Service Layer
▪ Introduction to UI API

Public 22
Introducing User Interface API (UI API): Topic Objectives

After completing this topic, you will be able to :

▪ Explain what UI API is in high level
▪ Tell how UI API is used

Public 23
SAP Business One SDK – User Interface API

▪ Provides objects and methods to access

screen objects of the User Interface

▪ Provides access to internal system events of

the user interface

▪ Provides ability to modify or add menus,

windows, or fields

▪ Provides one integrated user interface

Public 24
User Interface API – Use Cases

Visual Elements Customization Manipulate SAP Business One

standard functionality

Public 25
Thank You
Contact information:

© 2023 SAP SE or an SAP affiliate company. All rights reserved. See Legal Notice on www.sap.com/legal-notice for use terms, disclaimers, disclosures, or restrictions related to SAP Materials for general audiences.