Document Version: 1.0 2012-09-25 PUBLIC Administrator's Guide for the Integration Component All Countries
2 PUBLIC 2012 SAP AG. All rights reserved. Administrators's Guide for the Integration Component Table of Contents
Table of Contents Introduction ................................................................................................................................................................. 3 Performing Post-Installation Activities ................................................................................................................... 4 1.1 Maintenance and Monitoring .................................................................................................................................. 4 1.2 Licensing .................................................................................................................................................................. 5 1.3 Technical User B1i ................................................................................................................................................... 5 1.4 Changing Integration Framework Server Ports .................................................................................................... 5 1.5 Using the Latest SAP Business One DI API 32-Bit Version.................................................................................. 5 1.6 Activating Dashboard Widgets for the Cockpit..................................................................................................... 6 1.7 B1 Event Subscriber ................................................................................................................................................ 7 1.8 RFQ Scenario with Online Quotation ..................................................................................................................... 7 1.8.1 Performing Post-Installation Activities ................................................................................................. 7 1.8.2 Maintenance ............................................................................................................................................ 9 Managing Security ..................................................................................................................................................... 11 1.1 Security Aspects Related to the DATEV-HR Solution ......................................................................................... 11 1.2 Security Aspects Related to the Mobile Solution ................................................................................................ 11 1.2.1 Using HTTPS ......................................................................................................................................... 12 1.2.2 License Control ..................................................................................................................................... 12 1.3 Security Aspects Related to the Dashboards Solution ...................................................................................... 12 1.4 Security Aspects Related to the RFQ Scenario with Online Quotation ............................................................ 12
Administrator's Guide for the Integration Component Introduction PUBLIC 2012 SAP AG. All rights reserved. 3
Introduction The Administrator's Guide for the integration component or integration framework provides a central point of reference, both before and during the technical implementation of the component. To set up the integration framework after installation, select Start All Programs Integration Framework for SMEs Integration Framework, and then choose Help Ref 04 Operations, section System Administration. NOTE After installation use the B1iadmin user and the password provided during the installation. Note that the user B1iadmin is case sensitive. For information about creating dashboards, see How to Develop Your Own Dashboards for SAP Business One. For information about the dashboard services in the integration framework, choose Start All Programs Integration Framework for SMEs Integration Framework, and then choose Scenarios Scenario Package Control Report sap.Xcelsius Documentation.
4 PUBLIC 2012 SAP AG. All rights reserved. Administrator's Guide for the Integration Component Performing Post-Installation Activities
Performing Post-Installation Activities 1.1 Maintenance and Monitoring Integration framework is implemented as a Microsoft Windows service under the identifier SAP Business One Integration Service and starts automatically after a successful setup. NOTE You find the services by choosing Start Control Panel Administrative Tools Services. For monitoring purposes, choose Start All Programs Integration Framework for SMEs Integration Framework, and then choose Monitoring. You can use the Message Log, access the Error Inbox, display B1 Events and use other monitoring features. For optimal performance, the Message Log is deactivated by default. SAP does not recommend activating it in a productive environment. For additional documentation, choose Start All Programs Integration Framework for SMEs Integration Framework, and then choose Help Ref 03 Operations, section 2. To maintain systems connecting to the integration framework and maintain scenarios, choose Start All Programs Integration Framework for SMEs Integration Framework, and then choose SLD (System Landscape Directory), Maintenance, or Scenarios. SAP recommends checking the performance aspects in the related documentation, as follows: Choose Start All Programs Integration Framework for SMEs Integration framework, and then choose Help Ref 03 Operations, section 5. In the case where the integration framework is installed on top of an existing SAP Business One (B1) installation and this SAP Business One installation is connected as a subsidiary to SAP Business One integration for SAP NetWeaver (B1iSN) server, it is necessary to add entries to the Event Dispatcher manually. Refer to the latest B1iSN documentation for details of how to pass the SAP Business One events, relevant for your subsidiary integration processing, to your centralized B1iSN server, and how to register B1 events in the Event Dispatcher. When using 64 Bit Windows, to improve performance when larger amounts of data or a high number of parallel accesses need to be handled, you can assign more RAM to the Integration framework server by double-clicking the tomcat6w.exe on your local drive C:\Program Files\SAP\SAP Business One Integration\B1iServer\tomcat\bin\tomcat6w.exe, if C:\Program Files\SAP\SAP Business One Integration is the installation directory. In SAP Business One Integration Service Properties, select the Java tab, and increase the Maximum memory pool amount as follows: Tomcat supports max. 1024 MB on a 32 Bit OS, which is also the default setting. On a 64 Bit OS, the Maximum memory pool amount for Tomcat is 2048 MB. In the SLD (system landscape directory) make sure to keep the entry for b1Server in the SAP Business One system in sync with associatedSrvIP for the WSforMobile systems.
Administrator's Guide for the Integration Component Performing Post-Installation Activities PUBLIC 2012 SAP AG. All rights reserved. 5
1.2 Licensing Ensure that the user B1i has been assigned with the following two (free) licenses: B1iINDIRECT_MSS B1i No further license is required for the B1i user. 1.3 Technical User B1i A user with code B1i is created for each new company database. Ensure that the password for this user is properly initialized since it is required for integration framework to connect to SAP Business One. SAP recommends changing the password for the B1i user through the user Manager or another super user. 1.4 Changing Integration Framework Server Ports The integration framework server uses port 8080 for http and 8443 for https. If other applications already use one of these ports, you can change the integration framework ports in the following way: 1. If SAP Business One Event Sender Service already runs, stop the service. 2. Change settings in the server.xml Tomcat file at: \Program Files (x86)\SAP\ Integration Framework for SMEs\B1iServer\Tomcat\conf. You can find the settings in the connector port tabs. Do not change any other settings in the file. 3. Log on to the integration framework and select Maintenance Cfg Runtime and change the port. The integration framework additionally updated the setting in the SLSPP table of SAP Business One. 4. Restart the SAP Business One Integration Service. 5. Choose Start All Programs Integration Framework for SMEs EventSender Setup, follow the steps of the wizard, and in the Configure B1i Parameters section change the B1i Server Port entry, and test the connection. 6. Restart the SAP Business One EventSender Service. 7. Change the properties for the menu entry, using the correct port number: Start All Programs Integration Framework for SMEs Integration Framework. 1.5 Using the Latest SAP Business One DI API 32-Bit Version SAP Business One integration requires the latest SAP Business One DI API 32-bit version. If you have not installed it during installation, the following can happen in the integration framework:
6 PUBLIC 2012 SAP AG. All rights reserved. Administrator's Guide for the Integration Component Performing Post-Installation Activities
You have installed the 64-bit DI API version instead. If you click on Test connection button in the SLD for the corresponding SAP Business One system, the integration framework displays the following message: ! Connect to CDD1(B1DI) failed Detailed Information com.sap.b1i.adapter.dia.exception.ConnectionFailedException: java.lang.ClassCastException: class java.lang.NoClassDefFoundError:null incompatible with class java.lang.Exception:null You have installed the DI Proxy, but you have not installed the DI API. If you click on Test connection button in the SLD for the corresponding SAP Business One system, the integration framework displays the following message: ! Connect to SBO-COMMON(B1DI) failed Detailed Information com.sap.b1i.adapter.dia.exception.ConnectionFailedException: java.lang.RuntimeException:java.lang.ClassNotFoundException: com.sap.smb.sbo.api.SBOCOMUtil
Solution 1. Install the 32-bit DI API version in the \SAP\SAP Business One DI API folder. This is the default folder. If you have selected another folder for your installation, go to your specific folder. For more information, see the Administrators Guide for SAP Business One, section Installing SAP Business One Integration Installation Prerequisites Installing the Latest SAP Business One DI API 32-Bit Version 2. Set the JCOPATH property in the diproxyserver.properties file in the \SAP\SAP Business One Integration\DIProxy folder to C:\\Program Files (x86)\\SAP\\SAP Business One DI API\\JCO\\LIB. 3. Restart the SAP Business One DI Proxy service. 1.6 Activating Dashboard Widgets for the Cockpit From the SAP Business One Main Menu, choose Administration System Initialization General Settings. If the B1i user password is not correct or licenses are not properly assigned to this user, the error 401 not authorized will be displayed in the Dashboard widgets. To fix this, correct the B1i user password in the SLD (system landscape directory) within the integration framework and ensure licenses are assigned as specified in section Licenses in this document. In case Dashboards have been activated, but not deployed properly within the SAP Business One integration framework (or more precisely, within the B1i Server), the error 404 file not found mentioning the word DASHBOARD is displayed. To fix this, check that all services for the integration framework are running. First deactivate the Dashboard widgets, logoff and logon again, and activate the Dashboard widgets. Ensure that Adobe Flash Player 10.0 is installed on the client workstation to support the display of dashboards.
Administrator's Guide for the Integration Component Performing Post-Installation Activities PUBLIC 2012 SAP AG. All rights reserved. 7
For information about creating dashboards, see How to Develop Your Own Dashboards for SAP Business One. 1.7 B1 Event Subscriber You can configure the B1 (SAP Business One) Event Subscriber to send B1 events to a remote integration server. For documentation, choose Start All Programs Integration Framework for SMEs Integration framework, and then choose Help Ref 03 Operations, section Configuring the Event Subscriber 1.8 RFQ Scenario with Online Quotation SAP Business One customers can send purchase quotations to business partners electronically. The process of sending and gathering purchase quotations is implemented in SAP Business One using the integration component in a process called the Request for Quotation (RFQ) process. This process allows customers to generate a Web based quotation submission form which is hosted on the integration framework Server. Business partners can directly submit their offers over this Web based interface to the buyer. This section describes the process itself, how to customize certain parts of the process, and how maintain it. 4. After you have successfully installed SAP Business One, the SAP Business One administrator or user (SAP Business One user) must make sure that business partner details are maintained in the system. Most importantly the email address of the contact person from the business partner. 5. As of 8.81, PL06 the system supports language-dependent settings for sending emails to business partners. The following section describes how to customize language-dependent settings in the respective languages. 1.8.1 Performing Post-Installation Activities 1.8.1.1 Maintaining Contact Details in SAP Business One The RFQ process consists of two child processes. One is generating a purchase quotation that is automatically sent to the business partner. In the second step, the business partner updates the original purchase quotation document. Contact details of the business partner and the SAP Business One user play a vital role for the successful execution of the RFQ process. You can find the business partner contact details in SAP Business One by choosing Modules Business Partners. Then choose the business partner code, and select the contact person and edit the email address or add new contacts. Ensure that the default contact person details are maintained. Choose Modules Administration General Settings Users, to select the SAP Business One user, and to maintain the users contact details. If you do not provide the e mail address of the contact person and the Create Online Quotation checkbox is enabled, the SAP Business One user gets a message in the Alerts box about this error. If the e mail address is not correct, outdated, or if the recipient has an active out of office alert, the SMTP email client (for example, Outlook Express) gets a notification of this error.
8 PUBLIC 2012 SAP AG. All rights reserved. Administrator's Guide for the Integration Component Performing Post-Installation Activities
1.8.1.2 Creating Email Text in the Integration Framework When creating a new purchase quotation, the customer has the option to send the quotation to the respective partner electronically. This option is disabled by default. To enable the option, select the Create Online Quotation check box on the Logistics tab of the Purchase Quotation Screen. Once you select the checkbox, the system triggers the RFQ process, and the system creates the purchase quotation. The RFQ process takes certain parts of the document and generates a Web page hosted in the integration framework server BizStore. Once the system has generated the Web page, the page URL is wrapped along with some text and emailed to the business partner contact person. The system derives the email content from an XML template that is available for modification in the BizStore. Customers can change the e mail content by adding or editing their own text in their own respective language or languages. NOTE Do not change the name or the location of the XML template in the BizStore. To open the e mail document EmailContent.xml, use a WebDav client such as Microsoft Windows Explorer (Windows XP and above) and open the file under the BizStore path http://YOUR_INTEGRATION_FRAMWORK_SERVER:PORTl//B1iXcellerator/exec/webdav/com.sap.b1.webapps /PurchaseQuote using a text editor. Alternatively, you can open the document using an XML editor and browsing to the BizStore path mentioned above.
Access the XML template using the Control Center Maintenance BizStore Download menu path of the integration framework in the package com.sap.b1.webapps.PurchaseQuote. The template name is EmailContent.xml and it contains four major parts: Language Culture Name This is a two letter ISO name as defined in http://msdn.microsoft.com/en- us/library/ee825488%28v=cs.20%29.aspx Take the first two letters written in lower case only. The language code attribute is the one that is available in SAP Business One in the OLANG table for language codes. <emailMsg> <subject> <en code=3></en> Subject This is the subject of the email that the B1 user sends to the business partners. In English the subject is Request for Quotation. Take care to enter your customized text for the subject between the corresponding culture names. <emailMsg> <Subject> <en code=3>Request for Quotation</en></Subject> Body This is the body text of the email the system sends with the link to the Web based purchase quotation form. Take care to enter your customized text for the body between the corresponding culture names. <emailMsg> <Body> <en code=3>Some text</en></Body> Closing This is the closing greeting of the email. Take care to enter your customized text for the subject between the corresponding culture names. <emailMsg> <Closing> <en code=3>Some text</en></Closing> 1.8.1.3 Providing Server Information in the Integration Framework Specify connectivity parameters and runtime parameters in the Integration Framework. 1. Start the integration framework and select Maintenance Cfg Connectivity.
Administrator's Guide for the Integration Component Performing Post-Installation Activities PUBLIC 2012 SAP AG. All rights reserved. 9
2. Specify the SMTP server and port details. Without these details, the system cannot send an e mail to the business partner. Provide the user and password if the SMTP server requires authentication. 3. To test the connection, click on the Test Email button. 4. Select Maintenance Cfg Runtime to enter the HTTP port and the integration framework server name. 5. If the integration framework (B1iF) is newly installed, there is no remote B1i node. Configure the B1i Server to receive events from the SAP Business One system. You must activate the EventSender for the particular company database. 6. When a new remote B1i node is created, a default subscriber is also created inside this remote B1i node with all filter criteria set to *. This means that all B1 events coming to this local B1i server will be sent to the remote B1i server as well. 7. You can define the SMTP server properties for individual scenarios: 1. Go to Scenarios Setup Data Mgt. 2. Select the SMTPConfig.xml document. A window opens that allows you defining the SMTP settings for this scenario. 3. Select the System ID from the SLD. 4. Enter appropriate parameters for the SMTP Server port, and the associated user credentials for this particular system. 5. Save your changes. The RFQ scenario uses these details when sending emails. 1.8.1.4 Adding a Custom Logo on the RFQ Template You can change the SAP Business One logo on the HTML page the business partner can display. To change the SAP Business One logo: 1. Create a folder called rfq in the <B1i installation folder>\Tomcat\webapps\B1iXcellerator folder. 2. Create a PNG file containing your logo with the name logo.png (note that you must use lower case letters only for the file name). 3. Copy the file containing your logo to the <B1i installation folder>\Tomcat\webapps\B1iXcellerator\rfq folder. For example, C:\Program Files (x86)\SAP\SAP Business One Integration\B1iServer\Tomcat\webapps\B1iXcellerator\rfq\logo.png When you create a new purchase request, the system adds your logo to the HTML page the business partner opens. 1.8.2 Maintenance Once the system has sent the purchase quotation, the business partner fills it out and submits it using the user interface available on the Web page. The system parses the data and directly updates it in the existing purchase quotation document on reception.
10 PUBLIC 2012 SAP AG. All rights reserved. Administrator's Guide for the Integration Component Performing Post-Installation Activities
Simultaneously, the system creates a message alert in the SAP Business One users inbox. The alert is linked to the respective purchase quotation document. If the SAP Business One user clicks on this message, the purchase quotation document opens. The process remains the same when generating bulk quotations using the Wizard. The BizStore com.sap.b1.webapps.PurchaseQuote.Data stores the generated purchase quotations that are visible to the business partner. A SAP Business One Administrator can delete old requests from this folder using a WebDav client.
Administrator's Guide for the Integration Component Managing Security PUBLIC 2012 SAP AG. All rights reserved. 11
Managing Security This section explains how to implement a security policy and provides recommendations for meeting security demands. Choose Start All Programs Integration solution for SAP Business One Integration framework, and then choose Help Ref 03 Operations, section 6, Security Guide. 1.1 Security Aspects Related to the DATEV-HR Solution This scenario requires maximum levels of data security and sensitivity, because personal data is exported, The DATEV-HR scenario generates employee data for DATEV eG from SAP Business One data. The integration framework writes the data to a specified directory of the file system. Make sure that only authorized persons have access to the folder. Ensure that only authorized persons have access to the integration framework administration user interfaces. Alternatively, collect confirmations from all users who have access that they are aware that this data is sensitive, and that they may not distribute any data to third parties or make data accessible to non-authorized persons. 1.2 Security Aspects Related to the Mobile Solution Before being authorized to use the system, add the mobile user to the mobile user list in SAP Business One user administration. In the SAP Business One Main Menu, choose Administration Definition Setup Users Users Setup. Provide the user mobile phone number, mobile device ID (IMEI), and relevant SAP Business One user code and user name. In the SAP Business One user administration Users - Setup screen, select Mobile User. After launching the SAP Business One mobile front end from the mobile device, the user must authenticate entering a user name and password. This is the same user name and password for logging on to the SAP Business One application. After the user enters the correct user name and password, the front-end application passes the mobile phone number and mobile device ID (IMEI), together with the user name and password, to integration framework. After receiving the information, the integration framework verifies the following: Whether the phone number and IMEI pair can be found in the SAP Business One user administration Whether the user name matches the phone number and IMEI Whether the user has been blocked by the SAP Business One system Whether the password is the correct one Then the user is allowed to access the system. The password is encrypted while it is transmitted to the integration framework, which decrypts the password after receiving it.
12 PUBLIC 2012 SAP AG. All rights reserved. Administrator's Guide for the Integration Component Managing Security
1.2.1 Using HTTPS To make communication safer, the user has the option to use HTTPS for the sessions with the integration framework. On the server side you can configure the communication protocol (HTTP or HTTPS). On the client side, the user has the option to switch to the HTTPS protocol. By default, the solution runs with HTTPS, and the integration framework allows incoming calls through HTTPS only. You can change this in the integration framework. For additional documentation, choose Start All Programs Integration solution for SAP Business One Integration framework, and then choose Help Ref 03 Operation. Consider that HTTPS is the basis for a secure interaction. Check options to use certificates for enhanced security. 1.2.2 License Control All mobile users have to be licensed before being allowed to access the SAP Business One system through the mobile channel. License administration is integrated with the SAP Business One user and license. As well as being assigned an SAP Business One application license, the user must also be assigned with a mobile user license. Authorization within the SAP Business One application depends on the users SAP Business One application license. 1.3 Security Aspects Related to the Dashboards Solution Permission and authentication rules for dashboards: The system administrator can decide whether to grant each user full or no permission, for each dashboard, in the Authorizations form. By default, with a new company and for all dashboards, a non-super user has no permissions. At runtime, the user should be able to view the full dashboard even if this user does not have permissions for underlined user-defined queries. During the SAP Business One startup, the SAP Business One username and password are sent with basic authentication through HTTP or HTTPS to the Integration framework server. The integration framework server uses the username and password to authenticate the user and to return the session. After that, SAP Business One pings the integration framework server from time to time to keep the session active. The dashboard retrieves the data through the connection through HTTP post functions. 1.4 Security Aspects Related to the RFQ Scenario with Online Quotation You must provide vendors included in the RFQ process access to the online purchasing document on the integration framework server.
Administrator's Guide for the Integration Component Managing Security PUBLIC 2012 SAP AG. All rights reserved. 13
You can accomplish this by restricting access to the server to a minimum. To restrict access to the server, you must configure network (NAT) firewall as shown below: Only allow external access to the particular hostname / IP-address Only allow external access to the configured server port. Default: port 8080 for HTTP, or port 8443 for HTTPS If applicable / available for the particular firewall, configure the restricting URL: http://<hostname>:<portnumber>/B1iXcellerator/exec/ipo/vP.0010000100.in_HCSX/com.sa p.b1i.vplatform.runtime/INB_HT_CALL_SYNC_XPT/INB_HT_CALL_SYNC_XPT.ipo/proc?
www.sap.com/contactsap
2012 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. Microsoft, Windows, Excel, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, System ads, System i5, System p, System p5, System x, System z, System z10, System z9, z10, z9, iSeries, pSeries, xSeries, zSeries, eServer, z/VM, z/OS, i5/OS, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server, PowerVM, Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes, BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM Corporation. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. SAP, R/3, xApps, xApp, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP Business ByDesign, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.