Integratin Framewrk fr SAP Business One DIPrxy Cnfiguratin PUBLIC Glbal Rll-ut Octber 2018, B Zha
TABLE OF CONTENTS 1 INTRODUCTION... 3 2 INSTALLATION... 3 3 CONFIGURATION... 5 3.1 Services in Service Panel... 5 3.2 DIPrxy Cnfiguratin... 5 3.3 DIPrxy Lg Cnfiguratin... 6 3.4 Hw t Create Multiple Instances f DIPrxy... 6 3.5 Using DIPrxy Grups... 7 4 BEST PRACTICE... 11 5 TROUBLESHOOTING... 11 2
1 INTRODUCTION The SAP Business One DIPrxy is used t integrate with the SAP Business One via DI-API (thrugh Jc). 2 INSTALLATION By default, the SAP Business One DIPrxy will be installed tgether with Integratin Framewrk Server and SAP Business One Event Sender; It is pssible t install the SAP Business One DIPrxy in a separated server rather than the Integratin Framewrk Server; It is pssible t create multiple instances f the SAP Business One DIPrxy n ne server; The server, where the SAP Business One DIPrxy will be installed, shuld have the crrect DI-API installed. On Premise cnfiguratin related t DIPrxy 1. B1 Server: This is the database server where the SAP Business One databases are installed. 2. Database Prt: In case f the SQL named instance used, ensure the crrect prt number is specified. 3. SLD Server: This is the server where the System Landscape Directry (SLD service) installed. Nte: Ensure the same value (the same public/internal IP r FQDN address) as the SLD service is prvided. 4. SAP Business One DIPrxy: 32-bit/64-bit. It depends n which versin f the DI-API is installed n the current server where the SAP Business One DIPrxy is installed. 5. B1DI JCO PATH: The lcatin f the SAP Business One DI API prgram file. If yu previusly installed SAP Business One DI API in the default lcatin, the lcatin is \SAP\SAP Business One DI API\JCO\Lib 6. B1i User Name: It is B1i by default. This is a technical user which will be created in each f the SAP Business One cmpany database. 3
Nte: All the infrmatin abve will be used in SLD > SBO-Cmmn entry and will be cpied t each cmpany entry. On Demand cnfiguratin related t DIPrxy 1. SAP Business One DIPrxy: 32-bit/64-bit. It depends n which versin f the DI-API is installed n the current server where the SAP Business One DIPrxy is installed. 2. B1DI JCO PATH: The lcatin f the SAP Business One DI API prgram file. If yu previusly installed SAP Business One DI API in the default lcatin, the lcatin is \SAP\SAP Business One DI API\JCO\Lib. 3. Dmain User / Dmain Passwrd: The user name and passwrd f a database administratr accunt that yu want t use t lg nt the DIPrxy service. 4
3 CONFIGURATION The cmmunicatin between the Integratin Framewrk fr SAP Business One r SAP Business One, versin fr SAP HANA needs t be verified. 3.1 Services in Service Panel There are tw services related t DIPrxy: SAP Business One DI Prxy Service: the main service which is listening n prt 2099 by default fr the DI- API calls. SAP Business One DI Prxy Service Mnitr: the daemn service used t restart the DI Prxy autmatically when the prcess stpped unexpectedly. 3.2 DIPrxy Cnfiguratin The default cnfiguratin is lcated at C:\Prgram Files (x86)\sap\sap Business One Integratin\DIPrxy\diprxyserver.prperties which can be edited by a text editr like Ntepad in Micrsft Windws. Nte: The default installatin settings n clud is a bit different than the settings n premise since SAP Business One 9.3 PL01. Refer t the SAP Nte 2510674 fr the details. The cnfiguratin parameters by default are as belw: HTTPS_PORT=2099 The HTTPS-Prt used fr the B1i server ( diprxyprt in integratin framewrk > SLD > [cmpany] > B1DI cnnectin). Specify the TCP listening prt used by DI-Prxy, 1099 will be used by default if nt value prvided. This shuld be mdified manually when deplying mre than ne DIPrxy instances n the same server. JCOPATH=C:\\Prgram Files\\SAP\\SAP Business One DI-API\\JCO\\LIB If this prperty exists and is nt empty, it specifies the path the DIPrxy uses t search fr the JCO installatin including in the DI-API. In this case, the value in jcpath (integratin framewrk > SLD > [cmpany] > B1DI cnnectin). Nte that using '/' r '\\' instead f '\' as separatr in the value f JCOPATH, therwise an errr will encunter, e.g. C:\\Prgram Files\\SAP\\SAP Business One DI-API\\JCO\\LIB. SINGLECOMPANY=true The parameter cntrls access t the cmpany databases. If the parameter exists and is set t false, cnnectins t the same cmpany database are pssible. If the parameter des nt exist, r is set t true, multiple cnnectins t the cmpany database are pen at the same time, but nly ne can be used. Other cnnectins, even with ther users are rejected. MAXACCESES=0 This parameter is nly relevant, if yu use the tw-phase cmmit prtcl. Define the upper limit f simultaneus accesses that are allwed at the same time. Exceeding this limit, the adapter rejects the request. The default is 0. This means that unlimited accesses are pssible. Especially, if yu must shut dwn the DIPrxy and start it again, this can take a very lng time, if yu have many accesses. 5
MAXCONNECTIONS=0 T cnstrain the number f simultaneusly pen DI cnnectins in the DI prxy, use this parameter. Exceeding the limit, the adapter clses an idle cnnectin, if a new request cmes in. MAXDIERRORS=50 (n premise) / 200 (n demand) If this prperty exists and is set t a value > 0, the value depicts the cunt f DI-errrs that may happen until the DIPrxy will be restarted fr the sake f ptential memry leaking. The default is 0 (n restart). RESTARTPERIOD=60 (n premise) / 0 (n demand) If this prperty exists and is set t a value > 0, the value depicts the time in minutes when the DI-prxy will be restarted fr the sake f ptential memry leaking. The default is 0 (n restart). ORPHANED=20 The value in minutes when a pending and nt yet cmpleted DI-transactin is deemed as rphaned and therefre will be cleaned ut f the internal transactin-list. If this prperty is nt specified r has nt a psitive value, a default f 20 is taken. 3.3 DIPrxy Lg Cnfiguratin The default lg cnfiguratin file fr bth n premise and n demand envirnment is.:\prgram Files (x86)\sap\sap Business One Integratin\DIPrxy\DIPrxylg.prperties which can be edited by a text editr like Ntepad in Micrsft Windws. The lg files will be generated C:\Prgram Files (x86)\sap\sap Business One Integratin\DIPrxy\lg in by default. The parameters are as belw:.level = SEVERE The lg level: SEVERE / WARNING / INFO / CONFIG / FINE / FINER / FINEST. Frm the fewer lg level t the mre lg level. java.util.lgging.filehandler.pattern = lg/diprxy_%g.lg The lg file pattern and the path where t save the lgs. java.util.lgging.filehandler.limit = 10485760 The file size fr each f the lg file. java.util.lgging.filehandler.cunt = 3 Hw many files can be created fr the lgs. Fr a trubleshting purpse, it can be cnsidered t use.level=finer with java.util.lgging.filehandler.cunt = 10. 3.4 Hw t Create Multiple Instances f DIPrxy T enable an additinal instance f the DIPrxy service, prceed as fllws: The default instance f DIPrxy uses prt 2099, s yu need t find anther prt which will be free/nt blcked fr the server n which DIPrxy will be installed (by default, it shuld be the same as fr Integratin Framewrk service). In the example belw, we are taking prt 2098 t create a new instance f DIPrxy. 6
T enable anther cnfiguratin set fr the secnd instance f DIPrxy, cpy the DIPrxy flder (C:\Prgram Files (x86)\sap\sap Business One Integratin\DIPrxy) and paste it inside (C:\Prgram Files (x86)\sap\sap Business One Integratin\). The system creates the DIPrxy - Cpy flder. Rename the flder t DIPrxy2098. In the...\diprxy2098 flder, pen the service.ini file and change the fllwing entries: ServiceName = SAPB1iDIPrxy2098 DisplayName = SAP Business One DI Prxy 2098 Service In the...\diprxy2098 flder, pen the diprxyserver.prperties. Change the HTTPS_PORT parameter t 2098: HTTPS_PORT=2098 Determine whether the default instance f DIPrxy is using 32 bit r 64 bit. In the...\diprxy2098 flder, pen the service.ini file; the 32-bit JavaPath wuld be fr sapjre_32 and fr the 64-bit it wuld be sapjre_64. Chse Start, right-click Cmmand Prmpt and chse Run as administratr. Type cd...\diprxy2098 t g t the installatin flder f DIPrxy2098 and press Enter. T run a 32-bit DIPrxy: Run service.exe -install. T run a 64-bit DIPrxy: Check SAP Nte 1955107 fr a detailed descriptin f the required settings and then run service64.exe -install. Nte: Fr mre instances, repeat the prcedure abve accrdingly. Abut Upgrading Integratin Framewrk: When yu create additinal instances with integratin framewrk versin 1.20.8 and lwer: The upgrade prgram des nt supprt multiple instances f DIPrxy. After the upgrade f integratin framewrk, cpy the *.jar files f the upgraded DIPrxy flder t the same flders as fr the ther instances f DIPrxy. T enable the changes, stp and restart the additinal instances. As f integratin framewrk versin 1.20.9 and higher: The upgrade still des nt exchange the JAR files; hwever, the prcedure was changed t let the DIPrxy instances use nly the files f the default instance (installed in the <installatin flder>\diprxy flder). This was achieved by changing the service.ini file: The path t *.jar files was changed, fr example, frm.\lib\ t..\diprxy\lib\. Thus, if yu enabled additinal instances with integratin framewrk versin 1.20.9 r higher, yu n lnger need t cpy the *.jar files after an upgrade. Hwever, yu still have t stp and restart the additinal instances. This detail is dcumented in SAP Nte 1975033. 3.5 Using DIPrxy Grups T use DIPrxy grups, yu need t have multiple instances f DIPrxy. In the integratin framewrk, yu have the ptin t define DIPrxy grups with multiple instances f DIPrxy. Define the DIPrxy grups and the multiple instances f DIPrxy in the DI adapter glbal cnfiguratin. User needs t refer t belw mentined steps: Create multiple instances f DIPrxy 7
Adding DIPrxy Grups t the DI Adapter Glbal Cnfiguratin T use DIPrxy grups, yu need t have multiple instances f DIPrxy. In the integratin framewrk, yu have the ptin t define DIPrxy grups with multiple instances f DIPrxy. Define the DIPrxy grups and the multiple instances f DIPrxy in the DI adapter glbal cnfiguratin. User needs t refer t belw mentined steps: Glbal Adapter Cnfiguratin in Cntrl Center In the integratin framewrk, chse Tls Cntrl Center Cnfiguratin Glbal Adapter Cnfig: In the Glbal Adapter Cnfiguratin Prperties user interface, fr the B1DI adapter, click the Edit Glbal Cnfiguratin Prperties link. Fr the diprxygruplist prperty, define the DIPrxy grups in the fllwing way: a. [<grupname1> <hstname1>:<prt1>,<prt2>][<grupname2> <hstname2>:<prt1>,<prt2>] b. <grupname1,2> are the prxy grup names c. <hstname1,2> are the hst names r IP addresses f the instances f DIPrxy d. prt1,2 are the prt numbers Glbal Adapter Cnfiguratin 8
Example alpha and beta are DIPrxy grup name. abc is server hst name where the instances f DIPrxy are installed. 2099, 2098,2097,2096,3000 are prts where the instances f DIPrxy are installed n server abc. [alpha abc:2099,2098,2097][beta abc:2096,3000] If the instances f DIPrxy are installed n different servers then yu culd use belw mentined frmat: 2099 DIPrxy is installed n server abc and 2098 is installed n server def. [alpha abc:2099 def:2098] Using DIPrxy Grups in Integratin Framewrk SLD In SLD, enter the DIPrxy grup definitin that yu want t use fr a certain cmpany database in the diprxyhst field f the SAP Business One cmpany database entry in the fllwing way, fr example: [alpha] and [beta]. If yu use a DIPrxy grup, leave the diprxyprt field empty: Using alpha DIPrxy Grup 9
Using beta DIPrxy Grup 10
4 BEST PRACTICE Use 64-bit DIPrxy tgether with 64-bit DI-API fr better perfrmance. Refer t the SAP Nte 1955107 fr the details. Yu can achieve the best perfrmance by deplying ne DI Prxy instance fr each cmpany database. If yu run a high amunt f transactins fr ne cmpany database, deply multiple instances f SAP Business One DIPrxy and set up a DIPrxy grup fr the cmpany database. Refer t the SAP Nte 2245936 fr the best practice fr the DI-API cmmunicatin. Fr mre infrmatin abut perfrmance ptimizatin, see SAP Nte 2192737. 5 TROUBLESHOOTING B1DI Cnnectin issue This culd be due t the cnfiguratin either n DI-API side r DIPrxy side. In rder t slve this issue, please refer t the SAP Nte 2029714. DI-API runtime errr In rder t trublesht and lg an incident fr this issue, please refer t the SAP Nte 2360911. DI-API/DIPrxy crash issue In rder t trublesht and lg an incident fr this issue, please refer t the SAP Nte 2166563. Perfrmance issue In rder t slve this issue, please refer t the SAP Nte 1993784 and 2192737. 11
www.sap.cm/cntactsap 2018 SAP SE r an SAP affiliate cmpany. All rights reserved. N part f this publicatin may be reprduced r transmitted in any frm r fr any purpse withut the express permissin f SAP SE r an SAP affiliate cmpany. The infrmatin cntained herein may be changed withut prir ntice. Sme sftware prducts marketed by SAP SE and its distributrs cntain prprietary sftware cmpnents f ther sftware vendrs. Natinal prduct specificatins may vary. These materials are prvided by SAP SE r an SAP affiliate cmpany fr infrmatinal purpses nly, withut representatin r warranty f any kind, and SAP r its affiliated cmpanies shall nt be liable fr errrs r missins with respect t the materials. The nly warranties fr SAP r SAP affiliate cmpany 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. In particular, SAP SE r its affiliated cmpanies have n bligatin t pursue any curse f business utlined in this dcument r any related presentatin, r t develp r release any functinality mentined therein. This dcument, r any related presentatin, and SAP SE s r its affiliated cmpanies strategy and pssible future develpments, prducts, and/r platfrm directins and functinality are all subject t change and may be changed by SAP SE r its affiliated cmpanies at any time fr any reasn withut ntice. The infrmatin in this dcument is nt a cmmitment, prmise, r legal bligatin t deliver any material, cde, r functinality. All frward-lking statements are subject t varius risks and uncertainties that culd cause actual results t differ materially frm expectatins. Readers are cautined nt t place undue reliance n these frward-lking statements, and they shuld nt be relied upn in making purchasing decisins. SAP and ther SAP prducts and services mentined herein as well as their respective lgs are trademarks r registered trademarks f SAP SE (r an SAP affiliate cmpany) in Germany and ther cuntries. All ther prduct and service names mentined are the trademarks f their respective cmpanies. See http://www.sap.cm/crprate-en/legal/cpyright/index.epx fr additinal trademark infrmatin and ntices.