SAP Business One – Software Development Kit (SDK)
TB1300 Course Number and Course Title ABC123Overiew SAP Business One – SoftwareDevelopment Kit (SDK)SAP Business One2010 / Q2 SAP 2010 / Page 1Version 92Material number: 50099230
CopyrightCopyright 2010 SAP AG. All rights reserved.Neither this training manual nor any part thereof maybe copied or reproduced in any form or by any means,or translated into another language, without the priorconsent of SAP AG. The information contained in thisdocument is subject to change and supplement without priornotice.All rights reserved.Trademarks:Microsoft , Windows , NT , PowerPoint , WinWord , Excel , Project , SQL-Server ,Multimedia Viewer , Video for Windows , Internet Explorer , NetShow , and HTML Help areregistered trademarks of Microsoft Corporation.Lotus ScreenCam is a registered trademark of Lotus Development Corporation.Vivo and VivoActive are registered trademarks of RealNetworks, Inc.ARIS Toolset is a registered Trademark of IDS Prof. Scheer GmbH, SaarbrückenAdobe and Acrobat are registered trademarks of Adobe Systems Inc.TouchSend Index is a registered trademark of TouchSend Corporation.Visio is a registered trademark of Visio Corporation.IBM , OS/2 , DB2/6000 and AIX are a registered trademark of IBM Corporation.Indeo is a registered trademark of Intel Corporation.Netscape Navigator , and Netscape Communicator are registered trademarks of NetscapeCommunications, Inc.OSF/Motif is a registered trademark of Open Software Foundation.ORACLE is a registered trademark of ORACLE Corporation, California, USA.INFORMIX -OnLine for SAP is a registered trademark of Informix Software Incorporated.UNIX and X/Open are registered trademarks of SCO Santa Cruz Operation.ADABAS is a registered trademark of Software AGThe following are trademarks or registered trademarks of SAP AG; ABAP/4, InterSAP, RIVA, R/2, R/3, R/3Retail, SAP (Word), SAPaccess, SAPfile, SAPfind, SAPmail, SAPoffice, SAPscript, SAPtime, SAPtronic,SAP-EDI, SAP EarlyWatch, SAP ArchiveLink, SAP Business Workflow, and ALE/WEB. The SAP logo andall other SAP products, services, logos, or brand names included herein are also trademarks or registeredtrademarks of SAP AG.Other products, services, logos, or brand names included herein are trademarks or registered trademarks oftheir respective owners.
Course PrerequisitesRequired:SAP Business One standard business processesBasic knowledge and experience with Microsoft .NET technology –ideally Visual Basic .NETBasic knowledge of and experience with software developmentprocessesBasic general accounting and IT skillsThe following are required prerequisites for attending this course:Knowledge of SAP Business One standard business processes. This prerequisite can be met bycompleting the courses in the “Product essentials Learning Map”Basic knowledge and experience with Microsoft .NET technology – ideally Visual Basic .NET since theexercises in the course will be performed with VB .NET and code examples are also provided in VB.NET onlyBasic knowledge of and experience with software development processesStudents must bring their own laptop with SAP Business One software at release 8.8 installed. Notraining system will be provided for participants. Participants will be required to install a local demodatabase on their laptop during the class.Note: this course assumes that participants have basic general accounting and IT skills.
Target AudienceThe target audience for this course is an external SAP BusinessOne consultant who will be developing additional functionality inor for SAP Business One.Duration: 4 ½ daysUser notesThese training materials are not a teach-yourself program. They complement the explanations providedby your course instructor. Space is provided on each page for you to note down additional information.There may not be sufficient time during the course to complete all the exercises. The exercises provideadditional examples that are covered during the course. You can also work through these examples inyour own time to increase your understanding of the topics.
Course OverviewContents:Course GoalsCourse ObjectivesCourse ContentCourse Overview DiagramMain Business Example
Course GoalsThis course will prepare you to:Know the basics of the SAP Business One SDK as wellas details that are important for a general understandingof the SDKCreate a partner package that contains enhancements tothe SAP Business One Software
Course ObjectivesAfter completing this course, you will be able to:Develop simple additional functions (add-ons) using the DataInterface (DI) Application Programming Interface (API) and developsimple enhancements using the User Interface API (UI API)Use the User-Defined Objects (UDO) featureUse SDK components in (customer) projectsModify business processes with the SDKCreate and deliver an add-on installation package, including using thelicense mechanismFind and work with the SDK relevant information resourcesKnow SAP solution certification requirementsTo ensure that you retain the knowledge gained in this course and successfully complete the certificationexamination, we recommend that you consolidate the content in your own time after the course.We also recommend joining the developer community on the SAP Community Network to seek andprovide help in everyday SDK challenges.
Course ContentPrefaceUnit 1 Course OverviewUnit 5Unit 2 SDK IntroductionUnit 6 Add-On Packaging, Add-OnAdministration & LicensingUnit 3 The Data Interface APIUnit 4The User Interface APIUser-Defined ObjectsAppendices SAP 2010 / Page 81 Course Overview2 SDK Introduction3 The Data Interface API4 User-Defined Objects (UDO)5 The User Interface API6 Packaging, Add-On Administration and LicensingAppendices:Contain guidance how to implement the “Course Project”Include information about available toolsProvide an overview on SDK installation matters and support processesProvide more details about some features that are only mentioned briefly in the User Interface API unitThe last one is supposed to refresh – or provide – details e.g. about the “Formatted Search” feature
Course Overview Diagram3rd PartyApplication5ServerUser Interface APIClientSAP Business OneJava Co33SAP Business OneDatabaseDI ServerData I – Application Programming InterfaceTechnology name for approaching application through an interfaceCOM – Component Object ModelMicrosoft sepcific technology / Model for interfacesSDK – Software Development KitA package that enables developers to implement own modules – here to build solutions that interface withSAP Business One (i.e. COM objects, services, and other tools)InterfaceAn access point to exchange data with e.g. an applicationSoftware Solution Partner (SSP)Also known as ISV (Independent Software Vendor) implements solution(s) based on SAP Business Oneand SAP Business One SDKChannel Partner (CP)Sells and customizes SAP Business One. Often uses SAP Business One SDK for customer projects only.
IntroductionContents:The SAP Business One SDKComponents of the SAP Business One SDKIntroduction to DI APIIntroduction to UI APISAP Business One integration for SAP NetWeaverIntroducing the Course ProjectThis unit is a short outline and will give you an overview on component level.In addition it will show how SAP uses the SDK for extensions (i.e. „Add-Ons“) to SAP Business One.1-1
Introduction: Unit ObjectivesAt the conclusion of this unit, you will be able to describe and explain:The SAP Business One Software Development KitData Interface APIUser Interface APISAP Business One integration for SAP NetWeaver1-2
Course Overview DiagramServer3rd PartyApplication5User Interface APIClientSAP Business OneJava Co33SAP Business OneDatabaseDI ServerData InterfaceAPIServerLicenseService12UDO461 Course Overview2 SDK Introduction3 The Data Interface API4 User-Defined Objects (UDO)5 The User Interface API6 Packaging, Add-On Administration and Licensing1-36
SAP Business One - Technology andInterfacingSAP Business OneEase of UseContinuous and integrated solutionWindows look & feel (SAP style)Simple navigationAbility to drill down to details“Drag and relate” featureProductArchitectureTwo-tier client-server architecture (fat client)Microsoft Windows 32 based, 64 Bit supp.Microsoft SQL ServerAdaptationsCustomizingForm SettingsQueries / ReportsUser-Defined Tables and FieldsLinkage of input fields to queriesUser-Defined Objects (UDOs)ClientGUISDK (COM)ServerInterfacesIntegrationSDK (COM)MicrosoftSQL ServerServicesSDK (DI Server)EmailRDBMSBackupMS OfficeIntegrationMicrosoft Excel, Word (out)Microsoft Outlook (in / out)InterfacesFile-based (built-in)SOAP (HTTP/XML)APIs (COM, web services (SOA) starting)User-Defined objects (UDOs)Integration (not only) to SAP systemsLicenseSAP Business One is implemented as a two-layer architecture. The system is based on a MicrosoftSQL Server database where data is stored centrally. The business logic is mostly processed on theclient software (fat client).In detail, the client software consists of a graphical user interface and the business object classesconnecting to the database.There are several built-in integration capabilities, interfaces and customization features (see“Adaptation”, MS Office Integration” “Interfaces”):Besides all the adaptation capabilities accessible for customers, SAP Business One SDK enablespartners to implement a solution extending SAP Business One using APIs and other features.DI Server e.g. enables partners to use SAP Business One data in a Browser without the need toinstall any SAP Business One component on the client or the application server of the web-basedapplication.The UDO feature is a further step to ease creation of additional functionality inside SAP BusinessOne.Licenses are also managed centrally. Partners can use the mechanism for own purposes.1-4
Introducing SAP Business One SDK: UnitOverview DiagramIntroductionTopic 1: Introducing SAP Business One SDKTopic 2: Introducing Data Interface APITopic 3: Introducing User Interface APITopic 4: SAP Business One integration for SAP NetWeaverTopic 5: Introduction to the Course Project1-5
Introducing SAP Business One SDK: TopicObjectivesAfter completing this topic, you will be able to:Describe purpose and components of the SDKExplain SDK packages and licenses shortlyTell where to find further information or seek helpUse test tools available on the SAP Community Network1-6
SAP Business One SDK - MotivationCustomizationcapabilities apabilities cannotsolve everyrequirement.SAPBusiness OneSource code notaccessible!Use SDK!SoftwareDevelopment KitThe SAP Business One client software consists of a graphical user interface and the business objectclasses connecting to the database.The source code of SAP Business One is not accessible by third parties. This guarantees a single versionof SAP Business One with approved stability, functionality and upgrade functionality.If you want to extend and change the functionality of SAP Business One, you can use the built-in toolsfor adjustments such as User defined fields and tables, formatted search, etc.). If your enhancements needmore, You can use the SAP Business One Software Development Kit.With this SDK, you canadd industry-specific functionsadd other functions you deem necessarycreate interfaces to third-party tools.SDK gives access to Business One internals via a set of programmatic interfaces based on COM: everydevelopment environment supporting COM can be usedMany add-ons can be executing together with Business One changing its standard behavior: add-ons livein separate address spaces than Business OneNevertheless you should not underestimate the power of the customization tools!Check-out the Appendix „More exercises and solutions“ for more information about „formatted search“„queries“ and „alerts“.1-7
SAP Business One SDK – ComponentsOverviewClientJava Co3rd PartyApplicationUser Interface APIServerSAP Business OneSAP Business OneDatabaseDI ServerData InterfaceAPIServerLicenseService?UDOThe different application programming interfaces (APIs) included in the Software Development Kit useopen Microsoft standards that allow access to a lot of business objects provided by SAP Business One.API runtimes are installed with the SAP Business One client application – except DI Server which is partof the SAP Business One Server Tools installationYou can access SAP Business Oneon business data level through the Data Interface API (DI API). Most SAP Business One businessobjects are exposed in this API. They can be accessed by external programs. If you prefer using Java,use “Java Connector” to access DI API.on business data level through DI Server (Data Interface). DI Server is a DCOM service that runs onthe SAP Business One server and accepts XML data packed in SOAP (Simple Object Access Protocol)“envelopes”.on user interface level: The User Interface API (UI API) provides access to a running application whereyou can add or modify forms, and provide your own event handlers to actively influence the existingbusiness logic.In addition to that you can define your own business objects (User-Defined Objects (UDO)) that arejoined to the SAP Business One business object collection.The SDK ships withSample CodeDocumentationUtilities1-8
SAP Business One SDK – Terminology andPackagingThe SDK consists of 2 major packages:1) The Runtimes (i.e. the APIs)The runtimes (DI API UI API) are installed together with the SAP Business One client applicationDI API can be installed stand-alone (separate installer package available)2) The documentation (samples, helpfiles, utilities) named „SDK Installation““SDK” InstallationDevelopment package for partners – includes SDK help, samples, tools(SDK) LicensesSDK Implementation LicenseFor customer specific implementation (usage of UI API only)SDK Implementation license (99999 licenses) included in Professional User licenseSDK Development License / Add-On Solution LicenseNeed development or solution license to use UI&DI API (we will talk about that later)Partner has to order SDK Development License to start developmentAddOn Access User LicenseAllows to work via UI&DI API – cannot be used to do anything in the B1 applicationIndirect Access User LicenseAllows to work via DI only – cannot be used to do anything in the B1 applicationNew in version 8.8: Add-on connection requires user having an SAP License!There‘s only one set of APIs – no debug / release According to the remark above you could see the SAP Business One Software Development Kit to beavailable in three “versions”:The SDK Installation is a full version suitable for development of additional components by partners orcustomers. It contains documentation and examples.The SDK Implementation Version basically is just the general authorization to use UI API, if at least aProfessional User license has been installed.The SDK DI API / Runtime Installation is required if customers want to run additional functionsprovided by a partner using DI API. It is installed with the client.In the past „Compatibility License for Add-Ons“ existed – to allow partners to work without using theSAP license mechanism for some time. While this is still possible – there‘s no license for this purposeyet, but the users need any payable SAP license to connect to SAP Business One‘s SDK starting withversion 8.8.1-9
SAP Business One SDK - More InformationVisit us bThe most important source of information for developers:The SAP Community Network (aka SAP Developer Network):http://www.sdn.sap.comYou can get more information on the service marketplace via http://service.sap.com/smb.Another valuable source of information about the SAP Business One SDK is currently the SAPDeveloper's Network. You can access it under http://www.sdn.sap.com. There is a Discussion forumwhere hot topics regarding the SAP Business One SDK are discussed.Please note:You can find additional information in Appendix 3 of this course material.1-10
What you can find on SDN: People like you.eeFruiscDtonoirattsireg1-11sumrFonoiss
What you can find on SDN: Technicalinformation.QFA:ces etdQlu Anc s, Fi–eea rticlrAaer ols,polove to teD ksLin1-12
What you can find on SDN: Development orarneeGdeoC
Introducing SAP Business One SDK: TopicSummaryYou should now be able to:Describe purpose and components of the SDKExplain SDK packages and licenses shortlyTell where to find further information or seek helpUse test tools available on the SAP Community Network1-14
Introducing SAP Business One SDK: UnitOverview DiagramIntroductionTopic 1: Introducing SAP Business One SDKTopic 2: Introducing Data Interface APITopic 3: Introducing User Interface APITopic 4: SAP Business One integration for SAP NetWeaverTopic 5: Introduction to the Course Project1-15
Introducing Data Interface API (DI API): TopicObjectivesAfter completing this topic, you will be able to:Explain what DI API is high-levelTell how DI API is usedKnow about DI ServerExplain the User-Defined Objects concept high-level1-16
SAP Business One SDK – Data Interface API /DIServerProvides objects and methods (add, update etc.) to work on data level – installing the SAPBusiness One client application is not requiredProvides access to business objects (e.g. master data and transactional data) and crossfunctionalities (services)Performs the same checks as the SAP Business One client applicationLinks existing third-party solutions “as-is”Use COM capable development tools (e.g. Microsoft Visual Studio)SAP Business One3rd PartyApplicationUDOSAP Business OneCompanyDatabaseDI API(or JCoor DI Server)DI API is meant to be used by partners only!To use the DI API, you must either use a development environment and programming language thatsupport Microsoft COM (component object model) technology and is released by SAP.Alternatively – just using JavaConnector (JCo) – you can use a Java development environment likeEclipseThe following development environments are released by SAP:Microsoft Visual Basic .NET (or Microsoft Visual Studio 6.0)Microsoft Visual C .NET (or Microsoft Visual Studio 6.0 for C )Microsoft C# .NETOther development environments supporting COM technology might work but SAP does not providesupport for them. See SAP Note 615987 for a complete list of development environments released bySAP.Note: SDK does not contain a development environment or source code editors. This is to give you theflexibility to choose the environment you prefer.Supported platforms: https://websmp209.sap-ag.de/ sapidb/011000358700001241092005/Note: SAP highly recommends that you install the latest Support Packages for the supported platforms.See SAP Note 628155 for a complete overview of supported platforms.The UDO feature is supported by DI API as far as meta data are concerned.1-17
Data Interface API – Use casesThere are a couple of scenarios where Data Interface API is engaged:Data level integration of existing applications:Easily read or write data from / to SAP Business One – when neededData Import / Export scenarios – which are not covered through SAP tools – and wherethe capabilities of the SAP Business One application are not sufficient.Depending on the architecture of the overall solution you might consider to use DI Serverthough.Handling data in an Add-On that uses UI API (see next unit) beyond UI API‘s capabilities.Essentially writing data to the SAP Business One database by default requires usage ofDI APIEven though other techniques may be faster when it comes to reading data from thedatabase – usage of DI API is often a good choice regarding usability (no need torequest additional credentials etc) and data coherence (imagine that the required datamight be stored in various tables).Sometimes partners ask for: an optio
We also recommend joining the developer community on the SAP Community Network to seek and provide help in everyday SDK challenges. Course Objectives After completing this course, you will be able to: Develop simple additional functions (add-ons) using the Data Interface (DI) Application Programm
SAP ERP SAP HANA SAP CRM SAP HANA SAP BW SAP HANA SAP Runs SAP Internal HANA adoption roadmap SAP HANA as side-by-side scenario SAP BW powered by SAP HANA SAP Business Suite powered by SAP HANA Simple Finance 1.0 2011 2013 2014 2015 Simple Finance 2.0 S/4 HANA SAP ERP sFin Add-On 2.0
SAP Certification Material www.SAPmaterials4u.com SAP Certification Material for SAP Aspirants at Low cost Home Home SAP Business Objects SAP BPC CPM SAP BPC 7.0 SAP EWM SAP GTS SAP Public Sector SAP Real Estate SAP FSCM SAP FI/CO SAP AC - FI/CO SAP BI 7.0 SAP CRM 5.0
SAP HANA Appliance SAP HANA DB In-Memory A io BI Client non-ABAP (SAP supported DBs) SAP Business Suite SAP Business Suite SAP Business Suite SAP Business Suite SAP Business Suite SAP Business Suite SAP Business Warehouse SAP HANA DB r In-Memory Source Systems SAP LT Replication Ser
SAP Business Suite SAP BW SAP Apps Partner Apps SAP HANA PLATFORM Planning and Calculation Engine Real-Time Replication Services Information Composer & Modeling Studio SAP UI HTML5 Mobile SAP BI 4 SAP ERP SAP CRM SAP SCM SAP PLM SAP SRM SAP Netweaver Predictive Analytics & Business Function Libraries In-Memory
SAP Master Data Governance SAP Information Steward SAP HANA smart data integration SAP Data Hub SAP Cloud Platform Big Data Services SAP HANA, platform edition SAP Vora Customer Experience IoT Workforce Engagement SAP Cloud for Customer SAP Commerce SAP Marketing SAP Asset Intelligence Network SAP Predictive Maintenance and Service SAP .
Customer Roadmap to SAP Simple Finance - Example " Adopting SAP Simple Finance is a journey - start early" Side-by-side SAP HANA Acceleration SAP HANA accelerators, BW, BPC, GRC SAP Business Suite on SAP HANA SAP ERP on SAP HANA SAP ERP in SAP HANA Enterprise Cloud SAP Accounting Powered By SAP HANA Simple Finance add-on/
ALE/RFC Setup 88 SAP System Type 88 SAP IDoc Version 88 Program ID (SAP to e*Gate) 88 SAP Load Balancing Usage (e*Gate to SAP) 89 SAP Application Server (e*Gate to SAP) 89 SAP Router String (e*Gate to SAP) 90 SAP System Number (e*Gate to SAP) 90 SAP Gateway Ho
SAP Job Scheduler Service SAP Business Workflow (ABAP) SAP Integration Suite (API Mgmt.) SAP S/4HANA Cloud SAP Marketing Cloud SAP Integrated Business Planning SAP HANA Cloud Further KPI'sfor all editions of SAP S/4HANA and SAP Business Suite SAP SuccessFactors Employee Central Payroll
