SAP Jam Collaboration Developer Guide Company
Total Page:16
File Type:pdf, Size:1020Kb
PUBLIC SAP Jam Collaboration Document Version: May 2019 – 2019-03-28 SAP Jam Collaboration Developer Guide company. All rights reserved. All rights company. affiliate THE BEST RUN 2019 SAP SE or an SAP SE or an SAP SAP 2019 © Content 1 Introduction................................................................4 1.1 The SAP Jam Collaboration Developer Guide..........................................4 2 SAP Cloud Platform..........................................................7 2.1 Use SAP Jam with SAP Cloud Platform..............................................7 Register for SAP Cloud Platform and SAP Jam Collaboration developer access..............10 How to use the SAP Jam Developer Edition........................................15 Jam and SAP Cloud Platform integrations........................................35 Develop Collaborative Business Apps with SAP Web IDE and SAP Jam....................48 3 External Applications........................................................61 3.1 Integrate new business records.................................................. 61 Prepare the external application or platform.......................................63 Add a Trusted Certificate Authority.............................................65 Configure SAP Jam Collaboration as a SAML Local Identity Provider......................67 Add an OAuth Client........................................................68 Add a SAML Trusted IDP.....................................................70 Register the external application in SAP Jam Collaboration............................73 Develop an OData annotations file to display business records..........................77 Register the business records in SAP Jam Collaboration..............................113 Configure a business record filter..............................................116 Configure a business record sort order..........................................117 Configuring access to business records in SAP Jam Collaboration.......................118 Manage "external objects" (business records) using the SAP Jam Collaboration API..........119 4 Branding.................................................................122 4.1 Custom Headers............................................................122 5 OpenSocial Gadgets........................................................124 5.1 Develop SAP Jam OpenSocial gadgets.............................................124 Gadget Contexts......................................................... 126 Gadget Content Types......................................................127 Register your gadget with SAP Jam Collaboration..................................128 OpenSocial Gadget XML Structure.............................................139 SAP Jam Collaboration OpenSocial Tutorials......................................141 Using OpenSocial Gadgets to extend SAP Jam Collaboration..........................185 SAP Jam OpenSocial JavaScript API reference....................................193 6 Integrate Webhooks........................................................244 SAP Jam Collaboration Developer Guide 2 PUBLIC Content 6.1 Push notifications for webhooks.................................................244 Webhooks - Alias Users.................................................... 244 Webhooks - Alias Users - WAR file.............................................249 Webhooks - Groups.......................................................254 Webhooks - Groups - WAR file................................................259 7 UI5 Embeddable Widgets....................................................265 7.1 UI5 Embeddable knowledge base widget...........................................265 8 SAP Jam embeddable widgets................................................270 8.1 About SAP Jam embeddable widgets.............................................270 SAP Jam Collaboration div-embedded widgets....................................272 9 SAP Jam API............................................................. 288 9.1 About the SAP Jam API.......................................................288 SAP Jam API Reference....................................................288 SAP Jam OData API Tutorial.................................................289 Authentication and Authorization API...........................................451 SAP Jam REST API........................................................501 SAP Jam Collaboration Developer Guide Content PUBLIC 3 1 Introduction 1.1 The SAP Jam Collaboration Developer Guide This document, the SAP Jam Collaboration Developer Guide, presents developer-oriented information for integrating SAP Jam with other business-critical applications to enable work patterns. Work patterns are repeatable business processes that bring together people's expertise, content, tools, and business data, in a clearly laid out, purpose-built, collaborative workspace—SAP Jam groups—to efficiently and effectively deliver business results. Work patterns combine the collaborative features and tools of SAP Jam with external data, applications, and business best practices. It is the goal of the SAP Jam Developer Community to support customers and partners in building their own SAP Jam work patterns that can solve their specific business problems. While each work pattern is unique, they are built with a common set of building blocks, which include: ● SAP Jam Group Templates: SAP Jam groups act as the collaborative workspaces for work patterns. Group templates organize the content in a way that provides guidance to users on the best way to approach the work required to support a particular repeatable business process. The available SAP Jam group templates, and the use and customization of group templates, is discussed in the SAP Jam Collaboration Administrator Guide. ● Incorporating External Content into SAP Jam: Incorporating external content into SAP Jam allows data from both other SAP business systems and third party business systems to be displayed within SAP Jam groups. The procedure for doing this involves the following steps: ○ Register access to the External Application: This is done by configuring the access in SAP Jam's Admin console External Applications section, which is explained in the External Application section of the SAP Jam Collaboration Administrator Guide. ○ Develop the display component for the imported data: This is done by your organization's developer/integrators developing the components that display data retrieved from these external applications' OData APIs using SAP Jam Annotations, which is documented in the External Application [page 61] section of this SAP Jam Collaboration Developer Guide. These External Data objects can then be bound to specific group templates to allow organizations to easily build groups designed for collaboration around that external data. Development is an important part of integrating other software and services with SAP Jam to create the most effective work patterns for your organization. To make your development efforts as easy as possible, SAP invites you to register for free developer accounts of SAP Cloud Platform, SAP Jam, and to post your questions, comments, and solutions to the SAP Cloud Platform Developer Center and the SAP Jam Developer Community . (Click "Register [page 10]" in the image below.) SAP Jam Collaboration Developer Guide 4 PUBLIC Introduction ● Register for SAP Cloud Platform and SAP Jam Collaboration developer access [page 10] SAP Jam integrations The integrations of external applications with SAP Jam that are of interest to SAP Jam developer/integrators are shown in the following diagram. SAP Jam integrations In summary, there are five major sections in this SAP Jam Collaboration Developer Guide: ● SAP Cloud Platform: [page 7] This section introduces developers to the particular requirements and procedures for performing integrations using the SAP Cloud Platform. ● External Applications: [page 61] This section contains information on integrating business records data from business-critical applications into SAP Jam. This is done by pulling in data from the business application's OData API, or from an intermediary platform that provides an OData API (such as SAP NetWeaver Gateway or SAP Cloud Platform), creating an annotations file that maps that data into UI elements of SAP Jam's Business Record Viewer, and registering the external application with SAP Jam (in the Admin console's External Applications section). ● OpenSocial Gadgets: [page 124] provides documentation on the development of web apps that utilize SAP Jam's implementation of the OpenSocial specification, which extends the capabilities of SAP Jam to interact with any software or service. This section includes a tutorial, a reference section detailing SAP SAP Jam Collaboration Developer Guide Introduction PUBLIC 5 Jam's OpenSocial APIs, and information on configuring these gadgets for use in SAP Jam via the Admin console's OpenSocial Gadgets section. ● Embeddable Widgets: [page 270] This section describes two mechanisms for adding SAP Jam content to external web pages: ○ SAP Jam div-embedded widgets [page 272]: use the SAP Jam Admin console's Widget Builders section to generate the JavaScript required to paste a customized Feed Widget, Recommendations Widget, or Share Widget into an HTML page, without requiring knowledge of JavaScript. ● SAP Jam API: [page 288] provides the following sections of API Documentation for incorporating SAP Jam content into external applications, or for manipulating SAP Jam via