SAP CUSTOMER CHECKOUT BUSINESS ONE INTEGRATION FRAMEWORK SCENARIO EXTENSION GUIDE

Transcription

1 SAP CUSTOMER CHECKOUT BUSINESS ONE INTEGRATION FRAMEWORK SCENARIO EXTENSION GUIDE 01-SEP-2015

2 Document History VERSION DATE CHANGE SEP-2015 First Version 1.1

3 Contents Purpose 4 Target Audience 4 1. Extending the Business One Integration Framework scenario for SAP Customer Checkout Use Case Expectation from this guide The extension concept Creating a new scenario step to do data manipulation: Real example with sample code and screenshots Registration of the scenario to the extension point: Verify that the extension works: Basic explanation about available extension points Using Built-In support for field extension Questions/ feedback on this guide 17

4 Purpose The purpose of this SAP Customer Checkout Business One Integration Framework Scenario Extension Guide is to explain how to extend the existing SAP Business One Integration Framework scenarios developed for SAP Customer Checkout integration with SAP Business One. It is explained: How to extend and verify the scenarios in SAP Business One Integration Framework This document does not replace the official documentation of SAP Customer Checkout. This is not a legal document but is prepared only to assist developers/consultants to extend the SAP Business One Integration Framework scenarios for SAP Customer Checkout. Target Audience Technology consultant / Application consultant / Developer

5 1. Extending the SAP Business One Integration Framework scenario for SAP Customer Checkout 1.1 Use Case Let s us assume a use-case that a customer s has added two User Defined Fields (UDF) called Color and Size in the materials details of SAP BusinessOne. Now he wants that these two fields should also be available in SAP Customer Checkout. Additionally he wants to modify the description of the item so that the description shown in SAP Customer Checkout for the item is different from the description shown in SAP Business One. Customer wants to append the Color and Size to the description in SAP Customer Checkout. 1.2 Expectation from this guide There are two parts to this requirement. First, the SAP Business One Integration Framework service used by SAP Customer Checkout by default does not deliver data about these UDF s that are added to SAP Business One. Second, if the SAP Business One Integration Framework service is enhanced to deliver data maintained in these UDF s, SAP Customer Checkout will by default not store this data in the SAP Customer Checkout system. The focus of this guide is the first part, regarding extending the SAP Business One Integration Framework service so that the SAP Business One Integration Framework service can be extended to deliver data about these new UDF s that are added to SAP BusinessOne and append the color and size to the description fetched from SAP Business One. The second part of storing these UDF s data, viewing this data, searching based on these UDF data can be achieved by developing a Plug-In for SAP Customer Checkout. There will be some in-built functionality that supports storing viewing and searching based on known extension fields. However this in-built functionality is very limited in scope. This feature will also be added in this document once the feature is ready. The partner/customer is responsible to evaluate if this is enough to meet the customer functional expectation. Now that the expectation from this guide is clear, let s go in more details regarding how to extend the SAP Business One Integration Framework scenario.

6 1.3 The extension concept From SAP Business One for synchronizing articles/materials, SAP Customer Checkout uses the SAP Business One Integration Framework scenario step sap.pos.fetchmateriallist from the scenario package sap.customercheckout. In this B1if scenario step, SAP has provided an extension point sap.pos.fetchmateriallist_output. This extension point is executed before the output of the standard step is returned to the caller (SAP Customer Checkout). The partner can create scenario step, where they can manipulate the standard output of the scenario step sap.pos.fetchmateriallist and prepare a new output that is returned to the caller (SAP Customer Checkout). The newly developed scenario step by the partner needs to be registered in the extension point sap.pos.fetchmateriallist_output. How to build such a new scenario step and how to register this scenario step at the extension point is explained below. 1.4 Creating a new scenario step to do data manipulation: You will require basic knowledge of development in SAP Business One Integration Framework to understand this topic. In our use-case, we would like to read the color and size UDF s from SAP Business One and return it along with all other data for articles/materials in the scenario step sap.pos.fetchmateriallist. Additionally we would like to append the color and size to the existing description from SAP Business One so that the description for the item seen in SAP Customer Checkout is SAP Business One Integration Framework item description + Color + Size i.e. different from the description of the item from SAP Business One. Once the partner step is registered at the extension point, the input to the partner step is A) The original input payload of the step sap.pos.fetchmateriallist (/vpf:msg/vpf:body/vpf:payload[./@role='s']) B) The default output of the step sap.pos.fetchmateriallist, provided as atom atomxs. (/vpf:msg/vpf:body/vpf:payload[./@role='xs']) The original input (A) informs the partner step which database to use (based on SystemID etc) and the default output (B) provides the default output which the partner step can use and manipulate. For our use case, we now need to do the following in three steps. Step 1: To loop over all the Materials and prepare the materials list. And then prepare an SQL call to fire to the database (available as SysId in atom with Role= S ) Step 2: Fire the SQL call and find out the Color and Size for these articles.

7 Step 3: Prepare a new output where Color and Size are added to output and the description is modified to append the Color and Size to the description. 1.5 Real example with sample code and screenshots The screenshot below shows the input that the partner step will receive once registered at the extension point. As seen it has original input (A) and the default output (B).

8 As shown in the screenshot below, a new scenario package and a new scenario step was created.

9 In this scenario step there are three main atoms xform, sqlcall and final which performs the three steps mentioned before. In the xform atom, some xlst transformation to prepare material list is performed and the SQL call is prepared. This completes step one. In the sqlcall atom, the actual SQL call is made and this completes step two. In the final atom, the new output is prepared. In this new output Color and Size are added to output and the description is modified. This completes step three. Sample code for xform -> It loops over fetched articles, prepares a list of such articles and then prepares an SQL call to fetch the color and Size for these articles.

10 <xsl:variable name="localapos">&apos;</xsl:variable> <xsl:variable name="localopenpara">(</xsl:variable> <xsl:variable name="localclosepara">)</xsl:variable> <xsl:variable name="localcomma">,</xsl:variable> <xsl:variable name="fetchedarticles"> <xsl:if Material/ItemCode) > 0"> <xsl:value-of select="$localopenpara"/> <xsl:for-each FetchMaterialListResponse/MaterialList/Material"> <xsl:value-of select="$localapos"></xsl:value-of> <xsl:value-of select="./itemcode"></xsl:value-of> <xsl:value-of select="$localapos"></xsl:value-of> <xsl:choose> <xsl:when test="position() = last()"> <xsl:value-of select="$localclosepara"></xsl:value-of> </xsl:when> <xsl:otherwise> <xsl:value-of select="$localcomma"></xsl:value-of> </xsl:otherwise> </xsl:choose> </xsl:for-each> </xsl:if> </xsl:variable> <sql xmlns=""> <xsl:if test="string-length($fetchedarticles) > 0"> Select ItemCode, U_Size, U_Color from OITM where ItemCode in <xsl:value-of select="$fetchedarticles"></xsl:value-of> </xsl:if> ; </sql> Sample for sqlcall -> It s fires the SQL call.

11

12 Sample code for final -> The new output is prepared. In this new output Color and Size are added to output and the description is modified. <FetchMaterialListResponse xmlns=""> <MaterialList> <xsl:for-each FetchMaterialListResponse/MaterialList/Material"> <Material> <!-- Copies all other elements expect ItemName which is the description --> <xsl:copy-of select="./*[not(name()='itemname')]"/> <xsl:variable name="itemid"> <xsl:value-of select="./itemcode"/> </xsl:variable> <!-- Adds a new element for Size --> <Size> <xsl:value-of select="/vpf:msg/vpf:body/vpf:payload[./@id=&apos;atom1&apos;]/ jdbc:resultsets/jdbc:resultset/jdbc:row[string(./jdbc:itemcode) =string($itemid)]/jdbc:u_size"/> </Size> <!-- Adds a new element for Color --> <Color> <xsl:value-of select="/vpf:msg/vpf:body/vpf:payload[./@id=&apos;atom1&apos;]/ jdbc:resultsets/jdbc:resultset/jdbc:row[string(./jdbc:itemcode) string($itemid)]/jdbc:u_color"/> </Color> <!-- Append the Size and Color to the existing description from SAP BusinessOne --> <ItemName> <xsl:value-of select="./itemname"/> <xsl:value-of select="string(' Size ')"/> <xsl:value-of select="/vpf:msg/vpf:body/vpf:payload[./@id=&apos;atom1&apos;]/jdbc:resultsets/jdbc:resultse t/jdbc:row[string(./jdbc:itemcode) = string($itemid)]/jdbc:u_size"/> <xsl:value-of select="string(' Color ')"/> <xsl:value-of select="/vpf:msg/vpf:body/vpf:payload[./@id=&apos;atom1&apos;]/jdbc:resultsets/jdbc:resultse t/jdbc:row[string(./jdbc:itemcode) = string($itemid)]/jdbc:u_color"/> </ItemName> </Material> </xsl:for-each> </MaterialList> <!-- Copies all other elements--> <LastReturnedObjectId> <xsl:value-of select="/vpf:msg/vpf:body/vpf:payload[./@role=&apos;xs&apos;]/ FetchMaterialListResponse/LastReturnedObjectId"></xsl:value-of> </LastReturnedObjectId> <ErrorMessage> <xsl:value-of select="/vpf:msg/vpf:body/vpf:payload[./@role=&apos;xs&apos;]/ FetchMaterialListResponse/ErrorMessage"> </xsl:value-of> </ErrorMessage> </FetchMaterialListResponse>

13 1.6 Registration of the scenario to the extension point: In SAP Business One Integration Framework, select Scenarios > Setup. Select the scenario package sap.customercheckout. Click on the button Data Mgt. and select the entry Table: vtbl.includelist.xml. The extension point sap.pos.fetchmateriallist_output is predefined. By clicking on the button, partners can assign their step to the selected extension point. This is explained in the screenshot below. The newly created partner step is now registered to be executed at the extension point sap.pos.fetchmateriallist_output.

14 1.7 Verify that the extension works: To store the additional Color and Size attributes now coming back from the service, a plugin development is needed. For how to use the in-built functionality that supports storing viewing and searching based on known extension fields check the appropriate section of the guide. However the description modification for the materials/articles that was made we can see it immediately in SAP Customer Checkout.

15 A very non-technical way to verify that the extension works is that now we can do Article Synchronization in SAP Customer Checkout, and after the Synchronization is complete, verify that the description is modified and Size and color are added to the description. As in the screenshot below, for the article A00001, the description in SAP Business One is J.B. Multifunktionsdrucker 1420, however in SAP Customer Checkout the description is J.B. Multifunktionsdrucker 1420 Size Medium Color Royal Blue. However a more technical developer would like to verify this in SAP Business One Integration Framework itself. You will basic knowledge of development in SAP Business One Integration Framework to understand this topic. As in this sample screenshot below, when we execute the sap.pos.fetchmateriallist step in B1if, we can see the output of the extension step and the final output of the scenario step. Marked as in the screenshot below is the point where the output of the extension step can be seen.

16 Marked as in the screenshot below is the point where the output of the scenario step can be seen. By looking at these outputs it can be verified that the color and size elements were added and the description was modified. 2. Basic explanation about all available extension points This section is in progress and will be extended in the next version of the guide. 3. Using Built-In support for field extension

17 This functionality is not available until SP03 PL03 of SAP Customer Checkout. Once this is available this guide will be added accordingly. 4. Questions/ feedback on this guide If you have questions or would like to provide feedback on this guide, you can write an to We will be happy to hear from you and support you.

18 2015 SAP SE or an SAP affiliate company. 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 SE or an SAP affiliate company. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE (or an SAP affiliate company) in Germany and other countries. Please see for additional trademark information and notices. Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided by SAP SE or an SAP affiliate company for informational purposes only, without representation or warranty of any kind, and SAP SE or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP SE or SAP affiliate company 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. In particular, SAP SE or its affiliated companies have no obligation to pursue any course of business outlined in this document or any related presentation, or to develop or release any functionality mentioned therein. This document, or any related presentation, and SAP SE s or its affiliated companies strategy and possible future developments, products, and/or platform directions and functionality are all subject to change and may be changed by SAP SE or its affiliated companies at any time for any reason without notice. The information in this document is not a commitment, promise, or legal obligation to deliver any material, code, or functionality. All forward-looking statements are subject to various risks and uncertainties that could cause actual results to differ materially from expectations. Readers are cautioned not to place undue reliance on these forward-looking statements, which speak only as of their dates, and they should not be relied upon in making purchasing decisions.