0% found this document useful (0 votes)
8 views37 pages

SDK Overview

The Software Development Kit (SDK) for SAP Business One is a toolset designed for partners and customers to develop and enhance SAP Business One solutions. It includes components like the Data Interface API, User Interface API, and Screen Code Generator, allowing for integration and customization of the software. The SDK is continuously updated based on user feedback to improve functionality and ease of use.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PPT, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
8 views37 pages

SDK Overview

The Software Development Kit (SDK) for SAP Business One is a toolset designed for partners and customers to develop and enhance SAP Business One solutions. It includes components like the Data Interface API, User Interface API, and Screen Code Generator, allowing for integration and customization of the software. The SDK is continuously updated based on user feedback to improve functionality and ease of use.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PPT, PDF, TXT or read online on Scribd
You are on page 1/ 37

Overview –

Software Development Kit


(SDK)
SAP AG, 11/2003
Agenda

Introduction - Software Development Kit (SDK)

SDK Components:
 Data Interface API (DI API)
 User Interface API (UI API)
 Screen Code Generator (SCG)
 Solution Examples

Features & Functions/Outlook

Compatibility

General Information

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 2


Added Value for SAP Business One Partners/Customers

Software Development Kit

A simple and powerful development toolset for SAP


partners/customers to cost effectively develop
SAP Business One solutions

A set of development tools that enable partners and


customers to enhance and extend SAP Business
One as well as to integrate external solutions with
SAP Business One

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 3


Why SAP Business One SDK

Source Code of SAP Business One is not accessible by 3 rd


parties:
 Guarantees “single Version” of SAP Business One with improved
stability and functionality

Using the SAP Business One SDK, partners and customer have
the chance to extend and change the functionality of SAP
Business One:
 Industry specific functionality
 Missing functionality
 Interfaces to 3rd party tools

The different interfaces (APIs) included in the Software


Development Kit “open up” SAP Business One:
 Allows access to all Business Objects:
 Data level
 User Interface level

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 4


Product Philosophy

Partner
SAP Add-ons
Add-ons

Application Programming Interfaces (APIs)


 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 5
Continuous Enhancements Based on Feedback

The SAP Business One Software Development Kit is a growing


“Toolbox” that includes:
 Application Programming Interfaces for Data and User
Interface
 SAP Business One Java Connector
 Screen Code Generator
 Sample Code, Full Documentation
 Additional Development Tools (planned for future releases)

The Software Development Kit will be continuously extended


based on partner/customer feedback to become a powerful and
easy-to-use standardized development platform for SAP Business
One

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 6


Target Group

Target groups for the SAP Business One


Software Development Kit are developers
working with :
 Partners - to develop and interface their
3rd party solutions with SAP Business One.
 SSPs - to implement and interface 3rd
party applications or Add-on’s with SAP
Business One.
 Customers - to change screen designs etc.
of their individual SAP Business One
implementation.

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 7


Facts of the SAP Business One SDK

Status today:
 Pilot Shipment of SDK since February 2003.
 Till September 2003 more than 70 shipments into 11 countries.

Example - Partner Solutions using the SDK (GER, CH):

PPS, Project
PPS Solution Planning

Fixed Assets, Cost


PPS, Cost
Acc., Payroll, HR,
Accounting
PDM

Variant Venture Capital


Configuration Solution

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 8


Agenda

Introduction - Software Development Kit (SDK)

SDK Components:
 Data Interface API (DI API)
 User Interface API (UI API)
 Screen Code Generator (SCG)
 Solutions Examples

Features & Functions/Outlook

Compatibility

General Information

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 9


SAP Business One Interfaces

Client Flat Files

Server
Interfaces
XML Adapter XML

API (COM) APIs


MS SQL
Server ODBC
Services
E-Mail
RDBMS
Backup

XML APIs
APIs ODBC
ODBC
XML  DI 
 XML  DIAPI
APIfor
forData
DataExchange
Exchange  DB
DBAccess
Access
XMLfor
forData
DataExchange
Exchange  UI 

 UIAPI
APIfor
forFunctional
FunctionalExtension
Extension  Only
OnlyOutbound
Outbound
Basis:
Basis:HTTP/SOAP
HTTP/SOAP  Basis: COM
 Basis: COM
 Outbound
OutboundundundInbound
Inbound 
 Outbound
OutboundandandInbound
Inbound
  Only Windows Platforms
All
AllPlatforms
Platforms  Only Windows Platforms
 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 10
Integration with SAP Business One

SOAP
SOAP1.1
1.1(HTTP,
(HTTP,XML)
XML)

Data
Dataexchange
exchangevia
viaInternet
Internet
technologies
technologies

SAP
Business One
Library
Libraryof
ofBusiness
BusinessObjects
Objects
(based on COM technology)
(based on COM technology)

Development
Developmentofofadditional
additional
applications
applications
(VB,
(VB,C/C++,
C/C++,Delphi,
Delphi,.NET,
.NET,…)
…)

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 11


Application Programming Interfaces (APIs) in Detail

Data Interface API:


 Provides objects and methods to read, write, and update data objects on
database level
 Access to master and transactional data
 Link existing 3rd party solutions “as-is”
 Examples: POS System Integration, HR Service Integration, Synchronization
with Mobile Devices

User Interface API:


 Provides objects and methods to access user interface screen objects
 Access to user interface internal system events
 Add menus, windows, or fields
 One integrated user interface
 Example:E-Banking Solution, Customer Service Solution (add new master
data transaction e.g. maintenance history of equipment)

Java Native Interface (JNI):


 Java Wrapper Class for the DI API to access all COM based objects from a
Java Runtime Environment

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 12


API Architecture

User Interface API exposes the UI elements of the SAP Business One front-end.
Workstation Server
SAP Business One
SAP Business One Server tools
Client

SAP Business One


User Interface API
MS SQL Server
Add-On Development
3rd party application

SBO-
Common
Workstation
SAP Business One
Data Interface API Company
Company
Company
Add-On Development
3rd party application

Data Interface API exposes the SAP Business One data objects.
It can be used independently from the SAP Business One front-end to
access a company.
 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 13
Data Interface API – Software Architecture

Add-On Development
3rd party application

Interface Layer
(SAPbobsCOM.DLL)
• based on COM technology
• exposes the business objects and implements additional
generic objects such as RecordSet

Implementation Layer
(OBServer.DLL)
• based on existing source code of SAP Business One client
• implements the business objects and the database
connectivity

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 14


Using the Screen Gode Generator

The Screen Code Generator allows you to use the Screen-Painter in your
preferred development environment to design a screen for inclusion in
SAP Business One.
Myscreen.frm
Myscreen.frm Myscreen.bas
Myscreen.bas SAP Business One Client

User Interface API


Development
Environment Screen Code
with Generator
Screen Painter SAP Business One
Frontend -
Application

Output in Transformation Usage of


development to SAP Business designed screen
environment One SDK specific via UI API
specific format format

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 15


Example: PPS Solution from CIM-POOL AG

Workstation
SAP Business One
Server
Client SAP Business One
Modules: Server tools
 Order Processing
 Address Administration
 Accounting
 Item/Stock Management
MS SQL Server
 Finance/Purchase

DI API
SBO-
Objects: Common
 Company
 Reservation
 Customer
 Business Partner Company DB +
CIM Pool Tables
 Cost Accounts
 Procurement
 Same look and feel
 Same look and feel
 No redundant data
 No redundant data
 Add-on will be launched from SAP Business One
 Add-on will be launched from SAP Business One

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 16


Example: Alcohol Tax Calculation

Calculation and Administration of product specific add on taxes


 Seamless add on integration into SAP Business One (running in the
background)
 Real time processing of of add on transactions through event-
handling of SAP Business One UI API

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 17


Example of Use: SAP Internet Sales Integration

 Connection of SAP Business One with SAP CRM Internet Sales


through the DI API:
Web Server Application Server SBO Server

SAP J2EE Engine


SAP
Business
Internet Sales One
Internet
Web Application
MS Internet
Customer Information
Server MS SQL
Server
Firewall

Firewall

SAP
Business One RDBMS
Adapter
Catalog
Images

SAP Business One


Data Interface API SAP
Business
One

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 18


Agenda

Introduction Software Development Kit (SDK)

SDK Components:
 Data Interface API (DI API)
 User Interface API (UI API)
 Screen Code Generator (SCG)

Features & Functions/Outlook

Compatibility

General Information

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 19


Content and Development Strategy

Features and Functions SDK Release


Single Sign On Feature for Add-on and partner solutions 6.5

Event Filter: Events from SAP Business One can be filtered by 6.5
Add-on and partner solutions

Context API: User context and system information can be 6.5


used by Add-on and partner solutions

STAMPIT API: Use the STAMPIT functions for Deutsche Post 6.5
from SAP Business One

Name Spaces for tables: Add-On and partner solutions can 6.5
use name spaces for partner defined tables

BC Sets: Transport System for customizing settings, 6.5


transactional, and master data between multiple SAP
Business One systems
Integrated Screen Painter for SAP Business One (successor 6.5
of the Screen Code Generator)

DRAFT statements – Content and release version can change without notice.
 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 20
Content and Development Strategy (cont.)

Features and Functions SDK Release


Development Framework:Standardized methods, templates 6.7 (first
etc. for SAP Business One Add-on development (will be components)
extended for each new SDK release).
User Defined Objects: Function to create own objects 6.7

Improved Integrated Screen Painter 6.7

Add-On and partner solution Administration and Monitoring. 6.7

Extended Documentation and Online Help 6.7

UI API improvements 6.7

Authorization API, License API, and license manager service 6.7


for Add-on and partner solutions

User Exists: For exiting from standard SAP Business One 8.0 (planned)
transactions into Add-on or partner solutions

DRAFT statements – Content and release versions can change without notice.
 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 21
Screen Painter - Overview

Using the SAP Business One SDK WYSIWYG Screen Painter (from SDK
6.5) you can quickly and easily create forms with the same look and feel
as those already available in SAP Business One.

SAP Business One Client

User Interface API


WYSIWYG
Screen Painter
SAP Business One
Frontend
Application

Transformation to Using the new


SAP Business One screen via UI-API
SDK specific format

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 22


Using Screen Painter – Step 2
Add form items from the Tool Box, and set their properties according to your
requirements:

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 23


Activities for Development Community

SAP will focus on close contact with its partners for solution
development.

Training:
 Classroom training
 E-Learning training maps
 Regular expert WebEx sessions
 Programming examples

Developers Network (planned):


 Chat room/regular development roundtable
 CodeZone
 Special web page
 ……

Solution DB:
 Marketplace to exchange or resell partner solutions

Development Architects:
 Develop experts that will assist partners in solution development
 Roll-in partner requirements into products
 Contact persons for solutions certification

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 24


Agenda

Introduction Software Development Kit (SDK)

SDK Components:
 Data Interface API (DI API)
 User Interface API (UI API)
 Screen Code Generator (SCG)

Features & Functions/Outlook

Compatibility

General Information

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 25


Compatibility Definitions

A Software Development Kit is available for each SAP Business


One release:
 The Software Development Kit has the same release numbering

SDK release X runs with SAP Business One release X or higher


(X+1).

The SDK will support all previous interfaces and functionalities:


 An application initially developed with SDK release X technically
also runs with the interfaces and components of SDK X+1 without
any changes.
 New features and functions along with business objects are only
available with the matching release to SAP Business One.
 An application built with an SDK runs on a higher SDK and SAP
Business One release without the need for changes.
 There are two exceptions to this rule:
 1 - SDK6.01 SP0 works with SAP Business One 6.01 SP0 only. 2 -
There’s no SDK available for SAP Business One 6.2 SP0.

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 26


Software Development Kit Compatibility List

SDK 6.01 6.2 6.5


Release
SAP Support

Package
Support
Business Package

SP0

SP1

SP1

SP2

SP0

SP1
One
Release
6.01 SP0 OK / / / / /
SP1 / OK / / / /
6.2 SP0 / / / / / /
SP1 / OK OK / / /
SP2 OK OK OK / /
6..5 SP0 / OK OK OK OK /
SP1 / OK OK OK OK OK

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 27


Agenda

Introduction Software Development Kit (SDK)

SDK Components:
 Data Interface API (DI API)
 User Interface API (UI API)
 Screen Code Generator (SCG)
 SAP Business One Java Connector

Features & Functions/Outlook

Compatibility

General Information

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 28


SAP Business One Software Development Kit Versions

Depending of the usage of the SAP Business One Software Development


Kit (SDK) SAP provides different versions
 SAP Business One SDK – Development Version
 SAP Business One SDK – Implementation Version
 SAP Business One SDK – Runtime Version

The Development Version is needed by partners/customers who want


 to create own industry solutions which will interface with SAP Business One
(for this mainly the Data Interface API is used).
 SAP Business One will be used for data exchange with 3 rd party applications
 Example: POS System Integration, HR Service Integration, Synchronization with
Mobile Devices
 to change the program logic and processes (features and modules) of SAP
Business One by using the tools and interfaces of the Software
Development Kit (for this mainly the User Interface API is used).
 Example:E-Banking Solution, Customer Service Solution (add new master data
transaction e.g. maintenance history of equipment)
 to sell or license the created industry solution or add-on to 3rd parties

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 29


SAP Business One Software Development Kit Versions
(cont.)

The Implementation Version is needed by customers/partners who want


 To change the screen layout of an individual SAP Business One implementation
(for that only the UI API and SCG is needed)
 Add, hide, move, change buttons/fields and screens to individual customer settings
 Change screen colors
 Example: Hide fields in screens based on user role and authorization
 No source code is allowed to be created with the Implementation Version which
will change the business logic of SAP Business One
 Modifications made with the Implementation Version are not allowed to be sold or
licensed to 3rd parties

The Runtime Version is needed by customers/partners who want:


 To run SAP and partner add-on solutions. This version only contains and installs
the runtime environment of the APIs (just the DLLs) which is needed to run the add
ons.
 Example: A customer wants to use the Fixed Asset add-on from SAP. He simply
needs to run the installer for the runtime environment on each client machine the
add-on should be installed and install the add-on afterwards. SAP and partner
add-ons will not be delivered or install this runtime package. The runtime
environment installation will be automated with the next releases

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 30


SAP Business One Software Development Kit Versions
(cont.)

Content
 Development Version
 Data Interface API, User Interface API, DI Java Connector for DI API,
Screen Code Generator, full documentation, sample programs,
additional development tools (after release 6.5)
 Implementation Version
 User Interface API, Screen Code Generator, full documentation, sample
programs
 Runtime Version
 Just the appropriate DLLs (and JAR files for JCo)

The Versions have a different licensing model


 The Development Version has a package based fee of 6.500 € for a
maximum of 20 named users.
 The Implementation Version is included into the license of the SAP
Business One Professional User – No special license fee available
 The Runtime Version is included into the license of the SAP
Business One add-on– No special license fee necessary

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 31


SAP Business One Software Development Kit Versions
(cont.)

Ordering and Shipment

The Versions will be shipped separately


 The Development Version has to be ordered from SAP and will e
shipped on a separate CD. For that please contact your local SAP
representative. Currently also updates will be handled through the
local SAP organization. This is planned to be replaced through an
download process very soon.
 The Implementation and Runtime Versions are automatically
included into the SAP Business One core Software package. You
can find the respective files and documentation into the SDK folder
on the CD

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 32


Prerequisites

To use the SDK a development environment and programming


language has to be used that support MS COM technology and is
released by SAP.

Following development environments are released by SAP:


 Microsoft Visual Studio 6.0 and .NET for Visual Basic
 Microsoft Visual Studio 6.0 and 7.0 (.NET) for C/C++

Other development environments supporting COM technology


might work but support cannot be given by SAP.

Specially following development environments are not released


yet:
 C#

See Note 615987 for a complete overview of


development environments released by SAP.

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 33


Platforms and Requirements

Supported Platforms
 Microsoft Windows 2000
 Microsoft Windows XP (planned)
 It's highly recommended to install the latest Support Packages for
these platforms.

The system requirement for SAP Business One SDK are the
following:
 See system requirements for SAP Business One
 See system requirements for the development environment you
use (design time)
 To run up to 5 AddOn solutions using UI API 256MB RAM are
needed
 For more than 5 AddOn solution a minimum of 512MB RAM is
required.

See Note 628155 for a complete overview of


supported platforms

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 34


Support

There is a standard support available for customers and partners

Use OSS/CSN Component


 Component: SBO-SDK-TLS for the additional tools (e.g. Screen
Code Generator, Java Connector, Screen Painter)
 Component: SBO-SDK-DI for the Data Interface API
 Component: SBO-SDK-UI for the User Interface API

General Information about SAP Business One Service and


Support Offerings can be found under http://service.sap.com/
sbosupport

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 35


Summary

Customer Empowerment:
 Opens SAP Business One for individual
and customer specific scenarios or
solutions.

Partner Empowerment:
 No Partner development is possible
without using the Software Development
Kit.
 Ultimate insight into business logic of
SAP Business One

Solution Empowerment:
 The Software Development Kit fosters
data consistency, program integrity, and
consistent user interaction.

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 36


More Information

Visit us at:
http://service.sap.com/sbo-sdk
http://www.sap.com/smb

 SAP AG 2003, TechED_Basel / Session ID, Speaker Name / 37

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy