Configuring SAP Jam Integration with SAP SD

Transcription

1 Configuration Guide SAP ECC Sales & Distribution Document Version: Delta Information

2 Typographic Conventions Type Style Example Description Words or characters quoted from the screen. These include field names, screen titles, pushbuttons labels, menu names, menu paths, and menu options. Textual cross-references to other documents. Example EXAMPLE Example Example <Example> Emphasized words or expressions. Technical names of system objects. These include report names, program names, transaction codes, table names, and key concepts of a programming language when they are surrounded by body text, for example, SELECT and INCLUDE. Output on the screen. This includes file and directory names and their paths, messages, names of variables and parameters, source text, and names of installation, upgrade and database tools. Exact user entry. These are words or characters that you enter in the system exactly as they appear in the documentation. Variable user entry. Angle brackets indicate that you replace these words and characters with appropriate entries to make entries in the system. EXAM PLE Keys on the keyboard, for example, F2 or EN TER SAP SE or an SAP affiliate company. All rights reserved. Typographic Conventions

3 Document History Version Date Change Initial version Updates for EHP7 SP06: New SAP SE template applied Branding name SAP NetWeaver Gateway changed to SAP Gateway Minor formatting and structural changes implemented Section 5.2 Maintaining the ESJI_SD_SRV OData Service [page 11] enhanced Document History 2014 SAP SE or an SAP affiliate company. All rights reserved. 3

4 Table of Contents 1 Overview Subscriptions in SAP SD SAP Gateway Server Configuring the ESJI_SD_SRV OData Service SAIL on the SAP Gateway Server Activating the ESJI_SD_SRV OData Service SAIL in the Application Back End Registering the ESJI_SD_SRV OData Service Maintaining the ESJI_SD_SRV OData Service SAP SE or an SAP affiliate company. All rights reserved. Table of Contents

5 1 Overview The SAP Jam Integration for SAP Sales and Distribution (SD) scenario allows you to integrate SD processes with SAP Jam, for example to create a SAP Jam group from a business object overview page, or to follow any updates of a SAP Jam group within the SD GUI. The basic integration has been enhanced to send SAP Gateway notifications to SAP Jam about changes to business object SD. SAP Gateway services are used to send the notifications to the subscribers. Users then receive feed entries about these updates in SAP Jam. Scope This document covers the following configuration tasks: Enable subscriptions to SD-specific business objects The SD scenario supports notifications for the following business objects: o Sales Order o Invoice o Quotation o Customer Configure the SD-specific ESJI_SD_SRV OData service to distribute SAP Gateway notifications for the supported business objects The SAIL configuration guide Distributing SAP Gateway Notifications to SAP Jam provides generic descriptions of the required tasks for configuring the Send Notifications scenario. You have to complete these tasks to distribute SAP Gateway notifications. Use the SD-specific information for the Send Notification scenario in SAP ECC SD, as described in this document, when you complete the respective sections in the generic SAIL guide. Prerequisite You have completed the configuration steps as described in the SAIL configuration guide Connecting SAP Jam with SAP ABAP Systems. Overview 2014 SAP SE or an SAP affiliate company. All rights reserved. 5

6 2 Subscriptions in SAP SD To enable users to follow or unfollow particular business objects, the Generic Object Services (GOS) drop-down menu has to be available in the user interface of SAP Sales&Distribution (SD). GOS provides different functions such as adding an attachment, creating a document link, or displaying all attachments. Attachments are specific to a particular SAP object. To activate the GOS drop-down menu in the SD SAP GUI, complete the following procedure. Prerequisites You have activated the following business functions: BC_SRV_STW_03 LOG_SD_JAM_INTEG Procedure 1. Run transaction SU3. 2. On the Parameters tab, in the SET/GET Parameter ID field, enter SD_SWU_ACTIVE. 3. In the Parameter Value field, enter X or *. This activates the GOS button in the following SD transactions: o Update Sales Order (VA02)/Display Sales Order (VA03) o Update Invoice (vf02)/display Invoice (vf03), o Update Quotation (VA22)/Display Quotation VA23) o Update Customer (XD02)/Display Customer (XD03) Result You have activated the Follow/Unfollow function for the supported business objects in the relevant SD transactions SAP SE or an SAP affiliate company. All rights reserved. Subscriptions in SAP SD

7 3 SAP Gateway Server The configuration tasks on the SAP Gateway server for the Send Notifications scenario are described in chapter 3 Configuration of the SAP Gateway Server of the SAIL configuration guide Distributing SAP Gateway Notifications to SAP Jam. This section contains SD-specific information for configuring the ESJI_SD_SRV OData service. 3.1 Configuring the ESJI_SD_SRV OData Service In this step, you register the ESJI_SD_SRV OData service in the Gateway system. This service is defined in and delivered with the add-on of the back-end system. Use the values in the following procedure when completing section 3.7 Configuring OData Services of the SAIL guide. Note You have to log on to the Gateway server as administrator. Procedure 1. In Customizing for SAP NetWeaver, choose Gateway OData Channel Administration General Settings SAP NetWeaver Gateway to SAP System Activate and Maintain Services (or run transaction /IWFND/MAINT_SERVICE). 2. On the Activate and Maintain Services screen, choose Add Service. 3. On the Add Selected Services screen, enter the system alias name you created and choose Ente r. 4. In the External Service Name column, select the service ESJI_SD_SRV. 5. In the Add Service dialog, in the Creation Information group box, select a package. 6. Choose Back (F3). 7. Verify that OData ICF nodes are activated for all registered OData Services as follows: o In the service catalog, select the registered OData Service and, on the OData ICF node, select ICF Node. o Choose Activate and confirm the dialog. 8. Save your entries. Result You have configured the ESJI_SD_SRV OData service on the SAP Gateway server. SAP Gateway Server 2014 SAP SE or an SAP affiliate company. All rights reserved. 7

8 4 SAIL on the SAP Gateway Server The generic configuration tasks for configuring SAIL on the SAP Gateway server are described in chapter 4 Configuring SAIL on the SAP Gateway Server of the SAIL configuration guide Distributing SAP Gateway Notifications to SAP Jam. This sections describes the configuration of the ESJI_SD_SRV OData service in SAIL on the SAP Gateway server. 4.1 Activating the ESJI_SD_SRV OData Service It is mandatory to maintain the notification filter. This filter restricts the number of notifications that are sent. You must specify the OData services for which notifications are to be sent to the service provider. The following views represent the notification filter: CLBV_GW_NOTIFY_S: Entries delivered by SAP CLBV_GW_NOTIFY_C: Customer-defined settings The system, which decides whether a notification is sent, first checks if an entry exists in the C table for your service provider type and OData service. If so, the S table is not taken into account. This means that entries in the C table override the SAP defaults. Use the values in the following procedure when completing section 4.3 Maintaining Notification Filter of the SAIL guide. Procedure 1. In Customizing for SAP NetWeaver, choose Application Server Basis Services Collaboration Gateway Notifications Activate OData Service for Notification (or call up view CLBV_GW_NOTIFY_C). The Change View OData Service Settings for Notifications: Overview screen appears. 2. To activate notifications for the ESJI_SD_SRV OData service, complete the fields as follows: Field Serv. Provider Type Ext. Srv. Name Send Notifications Value Enter the service provider type, for example, Jam. Enter ESJI_SD_SRV. Select All Notifications. Note The Customizing filter entries are related to an external service name. This is the same name that has been registered at the Gateway server (see 3.1 Configuring the ESJI_SD_SRV OData Service [page 7]). 3. Save your entries SAP SE or an SAP affiliate company. All rights reserved. SAIL on the SAP Gateway Server

9 Result You have maintained the notification filter and activated the ESJI_SD_SRV OData service. SAIL on the SAP Gateway Server 2014 SAP SE or an SAP affiliate company. All rights reserved. 9

10 5 SAIL in the Application Back End The generic configuration tasks for configuring SAIL in the application back end are described in chapter 5 Configuring SAIL in the Application Back End of the SAIL configuration guide Distributing SAP Gateway Notifications to SAP Jam. This section contains SD-specific information for defining the SD-specific entries in the OData service registry. 5.1 Registering the ESJI_SD_SRV OData Service The Social Media ABAP Integration Library (SAIL) provides an OData service registry as a reuse component for SAP applications. The registry allows you to define a subset of OData services that can be exposed in a specific application context to external or on-demand platforms. In contrast to the notification filter, the service registry is not integrated into the Gateway or SAIL part of the notification process. It represents an independent service that applications can use. There are the following use cases: Supply OData URIs that are part of the notification. Example OData URIs for addressing the annotation resource Supply resource URL of the OData service for a subscription (base URL). Note The metadata link is implicitly derived from this base URL. Use the values in the following procedure when completing section Defining OData Service Registry of the SAIL guide. Procedure 1. In Customizing for SAP NetWeaver, choose Application Server Basis Services Collaboration Gateway Notifications Define OData Service Registry (or run transaction CLB_GW_SRV_C). 2. On the Change View Services: Overview screen, choose New Entries. 3. Enter the following: Field Bus. Object Type Appl. Context Ext. Srv. Name Value The Business Object Type is mandatory to determine your business context. Enter ECC_OTC. Enter ESJI_SD_SRV. The value must correspond to an entry in Customizing for the Gateway server (See Customizing for SAP NetWeaver under Gateway Service Enablement Service SAP SE or an SAP affiliate company. All rights reserved. SAIL in the Application Back End

11 Field Value Development for Backend OData Channel Maintain Services). Request URI Enter the static part of the OData service. Example OData services delivered by SAP have the following format: /sap/opu/odata/{namespace}/{service}/{collection}/ 4. Save your entries. Note o The service registry can be evaluated by calling method IF_CLB_CUST_QUERIES~ GET_REGISTRY_SERVICES_BY_PTYPE( ). In this convenience method, the internal URI prefix for addressing the Gateway system is added from the information that has been maintained in the Customizing activity Server Settings through the Gateway server s RFC destination. This means applications calling the method IF_CLB_CUST_QUERIES~ GET_REGISTRY_SERVICES_BY_PTYPE( ) must not add the URI prefix to the Request URI field of the view cluster. o Applications can also call IF_CLB_CUST_GW_SRV~GET_SERVICES_BY_PTYPE directly. This access class returns the Customizing content as it is, without adding the URI prefix. Result You have defined the SD-specific entries in the OData service registry. 5.2 Maintaining the ESJI_SD_SRV OData Service In this step, you customize the ESJI_SD_SRV OData service. Procedure 1. Run transaction SM Open view CLBV_APPLI_CONT, and check for the following entries: o ECC_OTC - ECC Order To Cash Scenario o SAIL - Social Media ABAP Integration Library (Default) 3. Open view CLBV_APPLI_PLATF, and check for the following entries: o Application ID: SAIL o Service Provider Type: Jam o Server: Jam productive 4. Open view CLBV_GW_SRV_C, and check for the following entries in the OData service registry. SAIL in the Application Back End 2014 SAP SE or an SAP affiliate company. All rights reserved. 11

12 Business Object Type External Service Name OData Request URI BUS2032 ESJI_SD_SRV /sap/opu/odata/sap/esji_sd_srv;o=<sap System Alias>/ BUS2032/ANNO ESJI_SD_SRV /sap/opu/odata/sap/esji_sd_srv;o=<sap System Alias>/AnnotationCollection('x')/Content/$value BUS2037 ESJI_SD_SRV /sap/opu/odata/sap/esji_sd_srv;o=<sap System Alias>/ BUS2037/ANNO ESJI_SD_SRV /sap/opu/odata/sap/esji_sd_srv;o=<sap System Alias>/AnnotationCollection('x')/Content/$value BUS2031 ESJI_SD_SRV /sap/opu/odata/sap/esji_sd_srv;o=<sap System Alias>/ BUS2031/ANNO ESJI_SD_SRV /sap/opu/odata/sap/esji_sd_srv;o=<sap System Alias>/AnnotationCollection('x')/Content/$value KNA1_ESJI ESJI_SD_SRV /sap/opu/odata/sap/esji_sd_srv;o=<sap System Alias>/ KNA1_ESJI/ANNO ESJI_SD_SRV /sap/opu/odata/sap/esji_sd_srv;o=<sap System Alias>/AnnotationCollection('x')/Content/$value Note The variable <SAP System Alias> in the table refers to the system alias of the back end you created earlier as described in section 3.3 Creating System Alias for Application Systems of the SAIL guide Distributing SAP Gateway Notifications to SAP Jam. 5. In the Application Context field, enter ECC_OTC. 6. Open view CLBV_SERV_PTYPE_C, and enter the ODATA Service UUID of the services you have maintained in the view CLBV_GW_SRV_C. Note o You can retrieve the OData Service UUID by double clicking on the entry maintained in view CLBV_GW_SRV_C. You can copy the service UUID and register the service provider type as Jam for the services you have added in the view CLBV_GW_SRV_C. o Similarly, open view CLBV_SRV_PTYPE_S, and verify that the service provider is Jam for the services maintained in the view CLBV_GW_SRV_S SAP SE or an SAP affiliate company. All rights reserved. SAIL in the Application Back End

13

14 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. The information contained herein may be changed without prior notice. 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 or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP 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. 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. All other product and service names mentioned are the trademarks of their respective companies. Please see for additional trademark information and notices.