Business Add-Ins (BAdIs) for SD Jam Integration Document Version:

Transcription

1 Document Version:

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 First Version Second Version with enhanced documentation for BAdIs Document History 2014 SAP SE or an SAP affiliate company. All rights reserved. 3

4 Table of Contents 1 Business Add-Ins (BAdIs) BAdI: Subscription Service Details (ESJI_SUB_SRV_BADI) BAdI: User Authorization Check (ESJI_SUB_AUTH_BADI) BAdI: Notification Check (ESJI_NOTIF_FILTER_BADI) BAdI: Notification Data Formatting and Subscription Filtering (ESJI_NOTIF_BADI) BAdI: Sales Order Details (ESJI_SO_BADI) BAdI: Sales and Distribution Features (ESJI_SD_BADI) SAP SE or an SAP affiliate company. All rights reserved. Table of Contents

5 1 Business Add-Ins (BAdIs) The following BAdIs are available for SD Jam integration: o BAdI: Subscription Service Details (ESJI_SUB_SRV_BADI) o BAdI: User Authorization Check (ESJI_SUB_AUTH_BADI) o BAdI: Notification Check (ESJI_NOTIF_FILTER_BADI) BAdI: Notification Data Formatting and Subscription Filtering (ESJI_NOTIF_BADI) o BAdI: Sales Order Details (ESJI_SO_BADI) o BAdI: Sales and Distribution Features (ESJI_SD_BADI) 1.1 BAdI: Subscription Service Details (ESJI_SUB_SRV_BADI) Use The ESJI_SUBSRV_BADI BAdI is used in the integration of SAP SD with SAP Jam (SD-BF-JAM) component. When a user subscribes to a business object, you use this BAdI to retrieve the required parameters to create a successful subscription. You can find a description of how to use the four BAdI methods below: Get Gateway Destination for Notification (GET_GATEWAY_DESTINATION) This method returns the system name and the client details of the gateway hub, where the subscriptions are registered. Get the Subscription Title (GET_SUBSCRIPTION_TITLE) This method returns the subscription title of a business object. Get the Service Details for the Business Object (GET_SERVICE_FOR_BO) This method returns the SAP NetWeaver Gateway service details of a business object along with the collection name. Get the Annotation Details for the Business Object (GET_ANNOTATION_FOR_BO) This method returns the URL for the annotation of a business object. Standard settings For more information about the standard settings (filters, single or multiple uses), see the Enhancement Spot Element Definitions tab in the BAdI Builder (transaction SE18). BAdI Implementations ESJI_SUBSRV_BADI_DEFIMPL: The default implementation for the GET_GATEWAY_DESTINATION returns the gateway destination based on the entry made in the SAP Jam configuration. Business Add-Ins (BAdIs) 2014 SAP SE or an SAP affiliate company. All rights reserved. 5

6 Activities For information about implementing BAdIs as part of the Enhancement Concept, see SAP Library for SAP NetWeaver under BAdIs -> Embedding in the Enhancement Framework. More Information For information about implementing BAdIs as part of the enhancement framework, see SAP Library for SAP NetWeaver Platform on SAP Help Portal at Choose a release and then Application Help. In SAP Library, choose SAP NetWeaver Library: Function-Oriented View -> Application Server -> Application Server ABAP -> Application Development on AS ABAP -> ABAP Customer Development -> Enhancement Framework. 1.2 BAdI: User Authorization Check (ESJI_SUB_AUTH_BADI) Use The ESJI_SUB_AUTH BAdI is used in the integration of SAP SD with the SAP Jam (SD-BF-JAM) component. You can use this BAdI to check whether a user is authorized to subscribe to and receive notifications for a business object. You can find a description of how to use these two BAdI methods, below: Check Authorization for Subscription Receiver (CHECK_RECEIVER_AUTH) You use this method to check whether a user has the specific authorizations required to receive notifications for a business object. Check Authorization for Subscription Creation (CHECK_SUBSCRIBE_AUTH) You use this method to check whether a user has the specific authorizations required to subscribe to a business object. Standard settings For more information about the standard settings (filters, single or multiple uses), see the Enhancement Spot Element Definitions tab in the BAdI Builder (transaction SE18). BAdI Implementations: ESJI_SUBAUTH_BADI_DEFIMPL: The default implementation checks whether the user has the authorization to access the business object. If the user has the correct authorizations to access the business object, the user can subscribe and receive notifications for the business object. Activities For information about implementing BAdIs as part of the Enhancement Concept, see SAP Library for SAP NetWeaver under BAdIs - Embedding in the Enhancement Framework. More Information For information about implementing BAdIs as part of the enhancement framework, see SAP Library for SAP NetWeaver Platform on SAP Help Portal at Choose a release and then Application Help SAP SE or an SAP affiliate company. All rights reserved. Business Add-Ins (BAdIs)

7 In SAP Library, choose SAP NetWeaver Library: Function-Oriented View -> Application Server -> Application Server ABAP -> Application Development on AS ABAP -> ABAP Customer Development -> Enhancement Framework. 1.3 BAdI: Notification Check (ESJI_NOTIF_FILTER_BADI) Use The ESJI_NOTIF_FILTER BAdI is used in the integration of SAP SD with SAP Jam (SD-BF-JAM) component. You can use this BAdI to check if notifications can be sent to SAP Jam. You can find a description of how to use the BAdI method, below: Filter Notifications (NOTIFICATION_FILTER) This method is used to check whether notifications can be sent to SAP Jam. If the method returns TRUE, notifications can be sent to SAP Jam. If the method returns FALSE, no notifications can be sent to SAP Jam. The decision is based on the logic of the importing parameter that contains the notification data. Standard settings For more information about the standard settings (filters, single or multiple uses), see the Enhancement Spot Element Definitions tab in the BAdI Builder (transaction SE18). BAdI Implementations ESJI_NOTIF_FILTER_BADI_DEFIMPL: The default implementation returns TRUE and sends all notifications to SAP Jam. Activities For information about implementing BAdIs as part of the Enhancement Concept, see SAP Library for SAP NetWeaver under BAdIs - Embedding in the Enhancement Framework. More Information For information about implementing BAdIs as part of the enhancement framework, see SAP Library for SAP NetWeaver Platform on SAP Help Portal at Choose a release and then Application Help. In SAP Library, choose SAP NetWeaver Library: Function-Oriented View -> Application Server -> Application Server ABAP -> Application Development on AS ABAP -> ABAP Customer Development -> Enhancement Framework. Business Add-Ins (BAdIs) 2014 SAP SE or an SAP affiliate company. All rights reserved. 7

8 1.4 BAdI: Notification Data Formatting and Subscription Filtering (ESJI_NOTIF_BADI) Use The ESJI_NOTIF_BADI BAdI is used in the integration of SAP SD with SAP Jam (SD-BF-JAM) component. You can use this BAdI to filter subscriptions and format the display of the notification on the SAP Jam page. You can find a description of how to use the BAdI methods, below: Filter Notification Endpoints (NOTIFICATION_ENDPOINTS) You use this method to check whether notifications can be sent to SAP Jam. If the method returns TRUE, notifications can be sent to SAP Jam. If the method returns FALSE, no notifications can be sent to SAP Jam. The decision is based on the logic of the importing parameter that contains the notification data. The updated data is available in the data field of the changing parameter CT_ENDPOINTS as a table. The notification text is in the field text of the table CT_ENDPOINTS. Here you can add necessary HTML tags to format the text. For example, if you want to draw the user's attention to some text, you can include html tags to highlight the font in red color. Handle Available Subscriptions for BO Notification (NOTIFICATION_SUBSCRIPTION) You use this method to filter the list of subscriptions based on the notification data. Standard settings For more information about the standard settings (filters, single or multiple uses), see the Enhancement Spot Element Definitions tab in the BAdI Builder (transaction SE18). Activities For information about implementing BAdIs as part of the Enhancement Concept, see SAP Library for SAP NetWeaver under BAdIs - Embedding in the Enhancement Framework. More Information For information about implementing BAdIs as part of the enhancement framework, see SAP Library for SAP NetWeaver Platform on SAP Help Portal at Choose a release and then Application Help. In SAP Library, choose SAP NetWeaver Library: Function-Oriented View -> Application Server -> Application Server ABAP -> Application Development on AS ABAP -> ABAP Customer Development -> Enhancement Framework. 1.5 BAdI: Sales Order Details (ESJI_SO_BADI) Use The ESJI_SO_BADI is used in the integration of SAP SD with the SAP Jam (SD-BF-JAM) component. You can use this BAdI to retrieve employee details for a sales document. You can find a description of how to use this BAdI method, below: Retrieve Details for Sales Employee (GET_SALES_EMPLOYEE_DETAILS): You can use this Business Add-In (BAdI) method to get details about a sales employee for a sales document SAP SE or an SAP affiliate company. All rights reserved. Business Add-Ins (BAdIs)

9 Standard settings For more information about the standard settings (filters, single or multiple uses), see the Enhancement Spot Element Definitions tab in the BAdI Builder (transaction SE18). BAdI Implementations ESJI_SO_BADI_DEFIMPL is the default implementation that retrieves the employee responsible details for a sales document. Activities For information about implementing BAdIs as part of the Enhancement Concept, see SAP Library for SAP NetWeaver under BAdIs - Embedding in the Enhancement Framework. More Information For information about implementing BAdIs as part of the enhancement framework, see SAP Library for SAP NetWeaver Platform on SAP Help Portal at Choose a release and then Application Help. In SAP Library, choose SAP NetWeaver Library: Function-Oriented View -> Application Server -> Application Server ABAP -> Application Development on AS ABAP -> ABAP Customer Development -> Enhancement Framework. 1.6 BAdI: Sales and Distribution Features (ESJI_SD_BADI) Use The ESJI_SD_BADI BAdI is used in the integration of SAP SD with the SAP Jam (SD-BF-JAM) component. You can use this BAdI to retrieve the sales and distribution features. You can find a description of how to use this BAdI method, below: Generate URL (GET_URL_LINK): You use this method to create a URL for a business object that you use to navigate from SAP Jam to the business object details in the back-end. Standard settings For more information about the standard settings (filters, single or multiple uses), see the Enhancement Spot Element Definitions tab in the BAdI Builder (transaction SE18). BAdI Implementations ESJI_SD_BADI_DEFIMPL: The default BAdI Implementation creates a URL for business objects such as customer or invoice that you use to navigate from SAP Jam to the SAP GUI for HTML interface. Activities For information about implementing BAdIs as part of the Enhancement Concept, see SAP Library for SAP NetWeaver under BAdIs - Embedding in the Enhancement Framework. Business Add-Ins (BAdIs) 2014 SAP SE or an SAP affiliate company. All rights reserved. 9

10 More Information For information about implementing BAdIs as part of the enhancement framework, see SAP Library for SAP NetWeaver Platform on SAP Help Portal at Choose a release and then Application Help. In SAP Library, choose SAP NetWeaver Library: Function-Oriented View -> Application Server -> Application Server ABAP -> Application Development on AS ABAP -> ABAP Customer Development -> Enhancement Framework SAP SE or an SAP affiliate company. All rights reserved. Business Add-Ins (BAdIs)

11

12 SAP AG 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 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. National product specifications may vary. 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. SAP 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 other countries. Please see for additional trademark information and notices.