2006 English Slutin Develpment Guide: SAP Business One Versin Status Date SAP AG Dietmar-Hpp-Allee 16 69190 Walldrf Germany
Cntents Intrductin...3 Overview...3 SAP Business One Sftware Develpment Kit...3 First steps...5 SAP Business One SDK Packages...5 SAP Business One SDK Main Cmpnents...5 UI API...5 DI API...6 DI Server...6 User-Defined Objects (UDO)...6 Figure 1: SAP Business One SDK Help Center...7 SAP Business One SDK License Types...7 Training, Learning Material, and Cnsultant Certificatin...7 Namespace Registratin...8 Plan develpment prject...9 Develpment Guidelines...9 Helpful Online Resurces: Infrmatin, Hw-T, and Tips...9 SAP Channel Partner Prtal...9 SAP Channel Partner Slutin Netwrk...9 SAP Service Marketplace...10 SAP Develper Netwrk...10 Develp Slutin...10 Helpful Online Resurces: Cding and Supprt...10 SAP Service Marketplace...10 SAP Develper Netwrk...10 Figure 3: SAP Develper Netwrk Hme Page...11 Available Tls...11 Package and Deply Slutin...13 Packaging...13 Licensing...14 Certify Slutin...14 SAP Integratin and Certificatin Center...15 Prerequisite...15 Detail Infrmatin...15 SAP AG Page 2 f 15
Intrductin This dcument is suppsed t give partners initial guidance fr their first develpment prject based n SAP Business One. In additin t this dcument, yu will find related infrmatin in the fllwing lcatins: Online dcumentatin fr SAP Business One (available after installing the SAP Business One client applicatin) Online dcumentatin fr SAP Business One Sftware Develpment Kit (SAP Business One SDK) The SAP Business One SDK Help Center will be available t yu after installing the package r here n the SAP Develper Netwrk site Peer-t-peer infrmatin in the Frums related t SAP Business One n SDN Screen design guidelines fr SAP Business One (available in the dcumentatin flder n the prduct CD and n SDN) License guide fr SAP Business One (available in the dcumentatin flder n the prduct CD) Other dcumentatin related t SAP Business One and SAP Business One SDK n SAP Channel Partner Prtal at http://cpsn-channel.sap.cm/ Overview Befre beginning add-n develpment, ISV partners must plan t get acquainted with and trained in using SAP Business One SDK. This dcument describes what yu need t d and where t g befre starting a develpment prject, alng with the fllwing infrmatin: Where t find mre advanced infrmatin fr prject planning Where t find infrmatin during the develpment phase Hw t deply the slutin t custmers Hw t get yur add-n slutin certified by SAP Please nte that the SAP PartnerEdge prgram may include incentives fr partners getting peple trained and getting slutins certified etc. Please check with yur channel manager fr details. SAP Business One Sftware Develpment Kit The SAP Business One SDK cntains interfaces, sample cde, dcumentatin, and develpment aids. Using SAP Business One SDK requires prgramming f SAP Business One (nt just custmizing). SAP Business One SDK allws prgrammers t easily interface third-party applicatins with SAP Business One bth n the database and user-interface level. Sme general details abut SAP Business One SDK include the fllwing: SAP Business One SDK is a supplementary prduct t SAP Business One, licensed separately. SAP Business One SDK is generally used slely by SAP partners. A custmer will see the need t use SAP Business One SDK in-huse nly in very rare instances. SAP AG Page 3 f 15
The necessary runtime versin f SAP Business One SDK required t run a partner s add-n at a custmer site is delivered by SAP free f charge with SAP Business One. Versins f SAP Business One SDK are aligned t SAP Business One cre releases and supprt packages. SAP Business One SDK is frward-cmpatible t higher SAP Business One releases, meaning that SAP Business One SDK release X runs with SAP Business One release X r higher (X+1). Fr full SAP Business One functinality, hwever, the respective SAP Business One client applicatin is required. SAP AG Page 4 f 15
First steps T get started, yu need the fllwing prerequisites after getting the sftware: 1. Get trained Training via SAP Channel Partner Prtal will enable yu t architect and develp yur slutin based n the applicatin prgramming interfaces (APIs) included in the SAP Business One SDK and the knwledge acquired in the training. Mre details fllw in this sectin. 2. Get invlved We recmmend jining the SAP Business One SDK develper cmmunity n SDN t discuss best practices and mre. The frum is mnitred and mderated by SAP slutin management and develpment teams. 3. Get an SAP-unique develpment namespace This namespace is a prefix yu will need t register via SAP Service Marketplace. Using a namespace will prevent naming cnflicts between different partner slutins at the custmer site. Mre details fllw in this sectin. SAP Business One SDK Packages Tw packages cmprise SAP Business One SDK, as fllws: The SAP Business One SDK runtimes (APIs) Develpers and custmer use the identical set f cmpnents. The runtimes are installed tgether with the client r server tls. The data interface (DI API) prvides access t SAP Business One data n an bject level. It can be installed separately. The user interface API (UI API) prvides access t SAP Business One screen bjects, and is available nly in cnjunctin with the SAP Business One prduct. The SAP Business One SDK develpment package (als knwn as SDK Installatin ) This package includes samples, utilities, tutrials, and help files (see Figure 1, which is a screen sht f the SAP Business One SDK Help Center). The package has been part f the prduct CD since 2005. The mst recent SAP Business One SDK Help Center package can be fund as a dwnlad n SDN. All functinal differences are handled via the SAP Business One SDK licensing mechanism. (Fr histrical reasns, yu might als find these names: SDK develpment versin, SDK implementatin versin, SDK runtime versin. ) SAP Business One SDK Main Cmpnents The main cmpnents f SAP Business One SDK are as fllws. UI API The UI API prvides prgrammatic access t windws, menus, and events in SAP Business One. The UI API allws yu t create new windws, mdify existing windws, add new business lgic, SAP AG Page 5 f 15
add r mdify applicatin menus, and mre. The API is expsed in the standard COM technique, which can easily be used in Micrsft.NET as well. DI API The DI API prvides a prgrammatic interface t SAP Business One thrugh a set f fully functinal business bjects. The DI API gives yu access t the business lgic and data-access layers f SAP Business One. The API is expsed in the standard COM technique, which can easily be used in Micrsft.NET as well. Furthermre, a Java library is supplied fr use in Java prgramming envirnments. DI Server The DI Server is an extensin f the DI API and supprts all its bjects. It is suitable where Webservices architecture is preferred. It is als intended fr high-vlume data integratin, where numerus client cnnectins must be managed simultaneusly. The API is expsed in the industry-standard SOAP technique as a Micrsft Windws service. User-Defined Objects (UDO) A unique feature allws yu t link tw user-defined tables quickly and easily t create a new business bject in SAP Business One. While the particular features can be accessed thrugh DI API and UI API, implementing a business bject class in a DLL file enables yu t verride the basic business bject behavir. Fr this purpse C++ header files and a C++ library are supplied. SAP AG Page 6 f 15
Figure 1: SAP Business One SDK Help Center SAP Business One SDK License Types SAP Business One SDK Implementatin License Allws yu t develp add-ns fr custmer-specific implementatin (use f UI API nly) SAP Business One SDK Develpment License Allws yu t register a namespace at SAP (t be used fr unique IDs, fr example) Allws yu t register a slutin t reuse the SAP license mechanism SAP Business One SDK Develpment License and Add-On Slutin License Allws yu t use DI API and UI API Cmpatibility License fr add-ns (planned t expire) Please nte: Allws yu t bypass the license mechanism in add-n cde fr backward cmpatibility with lder SAP Business One SDK versins installed and valid fr a limited time Fr mre details abut licensing and SAP Business One SDK, please refer t the SAP Business One license guide (available in the dcumentatin flder n the prduct CD) r visit the SAP Business One area n SAP Channel Partner Prtal at channel.sap.cm. SAP Business One including SAP Business One SDK may be installed fr a 31-day evaluatin perid. Fr details, please refer t the SAP Business One license guide. Training, Learning Material, and Cnsultant Certificatin Befre starting add-n slutin develpment, yu must get acquainted with and trained in using SAP Business One SDK. While SAP Business One SDK cntains easy-t-learn interfaces, yu shuld expect there t be sme learning prcesses invlved. Frm the discussins in the SAP Business One frum n SDN, yu can get an idea up frnt f what can be dne easily and what will take mre effrt t accmplish. Classrm learning material and e-learning are available thrugh SAP Service Marketplace. (In SAP Channel Partner Prtal, g t Educatin and frm there t the Develpment Cnsultant area see Figure 2.) Classrm material and registratin fr classrm training can be fund under a direct link. Fr e-learning g t the certificatin curriculum and check ut the cntents f the learning map. Please nte that yu may earn Value Pints in the SAP PartnerEdge prgram when yur emplyees are trained. Please check with yur channel manager fr details. SAP AG Page 7 f 15
Figure 2: SAP Business One Develpment Cnsultant Curriculum Infrmatin After cmpleting the training sessins, develpers can take the certificatin exam t assess their knwledge. Please cntact yur lcal SAP channel manager fr assistance where the certificatin can be perfrmed. While the exam is based n multiple-chice questins regarding applicatin features as well, the majrity is abut the SAP Business One SDK cmpnents and their use. In additin, we strngly recmmend that yu learn hw t use the custmizatin capabilities f SAP Business One. This is cvered in the slutin cnsultant learning map, which is ffered in parallel t the develpment cnsultant learning map. We recmmend that at least ne persn in yur cmpany shuld have these skills, regardless f whether yu plan t supply larger slutins as an ISV r t supply functinality in simpler add-ns. Namespace Registratin T prevent cnflicts with ther slutins using the SAP Business One APIs that may be installed at a custmer site, yu must use a prefix fr any bject in yur add-n. This prefix is called a namespace. The namespace ensures unique names. Example: Trini & Mart Inc. has registered namespace TMI then uses TMI fllwed by the delimiter _, fr an additinal table, fr instance ( TMI_MyTable as a table name). G t channel.sap.cm/namespaces t register a namespace. Please nte the fllwing: An SAP Business One SDK develpment license is a prerequisite t register a namespace. Namespace XX_ can be used fr custmer-specific implementatin prjects. SAP AG Page 8 f 15
Infrmatin abut where t use the namespace is available in the SAP Business One SDK help files (the SAP Business One SDK Help Center) and additinal dcumentatin. (Fr details, see the sectin Related Dcuments in the flder n the prduct CD r find it n SDN.) Plan develpment prject Develpment Guidelines SAP Business One SDK dcumentatin prvides screen design guidelines fr designing the GUI f fully integrated add-n slutins, as mentined in the sectin Related Dcuments (see flder n the prduct CD r find it n SDN). Additinal develpment guidelines are part f the SAP Business One SDK help files. Helpful Online Resurces: Infrmatin, Hw-T, and Tips SAP Channel Partner Prtal In the SAP Business One area f SAP Channel Partner Prtal, the sectin Develp My Slutin cntains helpful infrmatin fr many purpses regarding the develpment f yur slutin. The SAP Supprt Prtal service publishes infrmatin regarding specific prblems r bugs and fficial infrmatin abut the develpment tls supprted (channel.sap.cm/ntes). The Supprt Services area fr SAP Business One in SAP Channel Partner Prtal includes even mre details regarding features f SAP Business One and hw t use them (channel.sap.cm/ knwledge). The SAP Business One Discussin Frum (cpsn-channel.sap.cm/businessnefrum) is a platfrm fr SAP Business One partners as well as SAP emplyees fr discussing all matters and issues regarding the sales and implementatin cycle f SAP Business One. The discussin frum will enable yu t d the fllwing: Get int cntact with ther frum participants Exchange experiences with ther SAP channel partners Address questins t the partner cmmunity and lcal prduct experts Exchange infrmatin with ther members In additin, there is a link t the Glbalizatin Knwledge Base, a Micrsft Excel tl that shws differences between lcalizatins directly in the Supprt Services area in the prtal. SAP Channel Partner Slutin Netwrk Available partner slutins are listed in the slutin directry n SAP Channel Partner Slutin Netwrk, which yu can access frm SAP Channel Partner Prtal by clicking Partner Netwrking. Every ISV is strngly encuraged t list its slutins n this site and t maintain the listing. SAP Channel Partner Slutin Netwrk is the main vehicle fr partners and SAP channel managers t find ut abut yur slutin; withut a listing, it may nt be cnsidered fr pssible custmer engagements. SAP AG Page 9 f 15
SAP Service Marketplace Once yur registratin is cmplete, ne persn in yur rganizatin will receive lgin infrmatin t SAP Service Marketplace. Additinal infrmatin abut develping slutin add-ns is als available n SAP Service Marketplace. SAP Develper Netwrk SAP Develper Netwrk ffers free access fr anyne interested in SAP sftware develpment techniques and interfaces. Check it ut at www.sdn.sap.cm. The develper area fr SAP Business One n SDN is the entry pint t mre detailed dcumentatin written fr a develper audience. The SAP Business One team publishes and psts articles and white papers n SDN t facilitate yur architectural decisins and speed up yur develpment by describing the steps invlved in cvering a specific scenari. We als invite partner develpers t cntribute r t write Weblgs fr SDN where they can share their experiences. In the SAP Business One discussin frum, yu can get advice frm experienced develpers, frm ther ISVs, and frm the SAP slutin management team. Develp Slutin Helpful Online Resurces: Cding and Supprt SAP Service Marketplace In the Supprt area in SAP Service Marketplace, yu can reprt issues, bugs, and questins t SAP regarding the applicatin and the SAP Business One SDK. See channel.sap.cm/sb/supprt. SAP Develper Netwrk In additin t the ptin t reprt issues n SAP Supprt Prtal, the SAP Business One partner develper cmmunity is quite active in the SAP Business One frum n SDN (see www.sdn.sap.cm). Yu may cnsult the experts there at any time usually getting a respnse in less than tw hurs. SDN is accessible t anyne. In additin t the develper area, which will guide yu t dwnlads and articles, there is a public frum where any interested party can read the psts, pst a questin, r reply. Yu d need t apply fr registratin, which is free. Besides supprt frm SAP, yu can reach ut t the develper cmmunity r receive assistance frm the SAP Business One technical staff via the frum. SAP AG Page 10 f 15
Figure 3: SAP Develper Netwrk Hme Page Available Tls A tl called Screenpainter is shipped with the SAP Business One prduct that allws defining screens t be displayed in SAP Business One graphically. Please nte that Screenpainter prvides nly the functins t define a screen layut. Any additinal handling, including adding a menu item in SAP Business One, displaying the screen, and handling further events, must be dne in add-n cde. The SAP Business One develpment envirnment (B1DE) cnsists mstly f add-ins fr Micrsft Develper Studi.NET. Used tgether with Screenpainter, the B1DE might speed up develpment significantly. The B1DE is prvided thrugh SDN including surce cde and sme basic framewrk, but des nt encmpass service thrugh SAP Supprt Prtal. SAP AG Page 11 f 15
Figure 1: B1DE SAP Business One Develpment Envirnment Tls. The SAP Business One test envirnment (B1TE) is a suite f prfiling and checking tls fr transactins n business bjects, add-n frms, and usage f the APIs in case yu use Micrsft.NET. Yu will certainly find the test envirnment helpful in yur QA prcedures r simply use it t find issues in yur cde. Please nte that the tls are used fr slutin certificatin, prvided thrugh SDN, and include surce cde but they d nt encmpass service thrugh SAP Supprt Prtal. SAP AG Page 12 f 15
Figure 4: B1TE SAP Business One Test Envirnment Tls Package and Deply Slutin Packaging Depending n the architecture f an add-n slutin especially if it uses UI API sme prerequisites exist fr building a setup. Please see the infrmatin in the SAP Business One SDK Help Center (Packaging and Deplyment) and the training material fr details. In additin, please determine what infrmatin shuld be prvided t custmers with the slutin. Details can be fund in the certificatin requirements and the SAP Business One SDK Help Center. Please nte that B1DE prvides a wizard fr Micrsft Visual Studi.NET t set up a packaging prject and create a ready-t-g installatin package. SAP AG Page 13 f 15
Figure 5: SAP Business One Develpment Envirnment Installer Wizard Licensing Please nte that yu can reuse the license mechanism f SAP Business One fr yur partner slutins. There is n need t develp a license check mechanism. Please check the fllwing fr the latest infrmatin: The license guide fr SAP Business One (available in the dcumentatin flder n the prduct CD r n SDN) The SAP Business One license key request page n SAP Channel Partner Prtal Check with yur SAP channel manager fr further assistance. Certify Slutin The gal f slutin certificatin is t ensure the same ease f use and maintenance as fr the SAP Business One slutin itself. Partners with certified integratins enjy the fllwing benefits: An fficial SAP integratin certificate Listing in SAP s nline SME slutin database Use f certificatin lg fr the integratin t SAP Business One Please nte that yu may earn Value Pints in the SAP PartnerEdge prgram when yur slutin is certified. Please check with yur channel manager fr details. SAP AG Page 14 f 15
SAP Integratin and Certificatin Center Third-party sftware integratins t all SAP prducts (including SAP Business One) are certified by the SAP Integratin and Certificatin Center (SAP ICC) lcatins. Arund the wrld, there are three different lcatins respnsible fr the Eurpe, Middle East, and Africa (EMEA) regins, the Americas, and Asia-Pacific (APA). Yur integratin must be certified by the SAP ICC lcatin respnsible fr the cuntry in which yur main agreement relating t SAP Business One was executed. The certificatin prcess can be summarized in the fllwing steps: 1. Inquiry 2. Certificatin cntract 3. Preparatin fr the test 4. Certificatin test 5. Certificate Prerequisite Yu must have a signed partner cntract and have an SAP partner number. Detail Infrmatin Fr details, g t the SAP ICC area n SDN fr the SAP Business One slutin certificatin at www.sdn.sap.cm. SAP Integratin and Certificatin Center (under Quick Links) Integratin scenaris (alphabetical) B1-SDK 2006 by SAP AG. All rights reserved. SAP, R/3, mysap, mysap.cm, xapps, xapp, SAP Net- Weaver, and ther SAP prducts and services mentined herein as well as their respective lgs are trademarks r registered trademarks f SAP AG in Germany and in several ther cuntries all ver the wrld. All ther prduct and service names mentined are the trademarks f their respective cmpanies. Data cntained in this dcument serves infrmatinal purpses nly. Natinal prduct specificatins may vary. Printed n envirnmentally friendly paper. These materials are subject t change withut ntice. These materials are prvided by SAP AG and its affiliated cmpanies ( SAP Grup ) fr infrmatinal purpses nly, withut representatin r warranty f any kind, and SAP Grup shall nt be liable fr errrs r missins with respect t the materials. The nly warranties fr SAP Grup prducts and services are thse that are set frth in the express warranty statements accmpanying such prducts and services, if any. Nthing herein shuld be cnstrued as cnstituting an additinal warranty. SAP AG Page 15 f 15