SAP Jam Communities Administration Guide 1902 · 1 About SAP Jam Communities Objectives SAP Jam...

PUBLICDocument Version: February 2019 – 2019-03-06

SAP Jam Communities Administration Guide 1902

© 2

019

SAP

SE o

r an

SAP affi

liate

com

pany

. All

right

s re

serv

ed.

THE BEST RUN

Content

1 About SAP Jam Communities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

2 System requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

3 Personal data and privacy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

4 Overview and subscription. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

5 Custom domains. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

6 Private or public community. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

7 User Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207.1 SCIM Provisioning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207.2 Identity Authorization and Provisioning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22

Architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Configuration and workflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

7.3 Alias accounts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267.4 User account settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Edit profile page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28Profile management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29E-mail settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

7.5 Private community. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307.6 Public community. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

8 Home Page Customization and Branding. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328.1 Web. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

Pre-authentication landing page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368.2 Email templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378.3 QR codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .408.4 Customize the home page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Persistent site navigation and links. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Global edit mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Announcement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Widgets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

8.5 Import and export home pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

9 Group Management and Administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519.1 Configure and enable groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519.2 Group templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52

2 P U B L I CSAP Jam Communities Administration Guide 1902

Content

Community administrator tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Group administrator tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

9.3 Groups management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549.4 Create a group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559.5 Design a group with page designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

About widgets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Add a widget to a page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Add rows and columns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Adjust column width. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Delete rows and columns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Save or delete draft. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Publish a page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Edit a page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Rename a page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Page versions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Copy a page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Delete a page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87Translations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Dimensions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89Mobile settings and preview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

9.6 Edit group settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Participation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

9.7 Invite people to join group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979.8 Group reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Activity summary by week or month. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Content ranking. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Content views by week or month. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Contribution by object week or month. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Group member activity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Group member list. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Ideas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105Terms of use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105User page views by week or month. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Purged content report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

9.9 Copy a group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1079.10 Delete a group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1089.11 Restore a group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1089.12 Import and export groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

10 Product Setup and Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

SAP Jam Communities Administration Guide 1902Content P U B L I C 3

10.1 Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11110.2 Hashtags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11410.3 Knowledge base. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

Knowledge base templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11710.4 Content templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12010.5 Third party analytics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12310.6 Search engine configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Google Site Verification HTML tag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12410.7 Audio and video management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Record a video by webcam or screen (with WebRTC technology). . . . . . . . . . . . . . . . . . . . . . . .125Upload supported audio and video files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Thumbnail images. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

11 Integrations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13111.1 Add a SAML Trusted IDP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13111.2 Configure a SAML Local Service Provider. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13211.3 Content syndication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13411.4 SAP Commerce and External Product Sync. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13711.5 Gamification with Badgeville. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139

Leaderboard widget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

12 Compliance and Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14212.1 Terms of service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Cookies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14312.2 Content administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14312.3 Compliance monitoring. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14612.4 Security options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14912.5 Legal / disclosures and privacy policy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

13 Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15213.1 Administrator Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Activity summary by month or week. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153Community settings changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154Community user detail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Compliance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Content views by week or month. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Contribution by object by week or month. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158Engagement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Expertise. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Group activity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Group administrators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Group member activity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164


Content

Group template activity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165Newsletter subscribers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Questions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Search summary by week or month. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Terms of service compliance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169Top disk usage per group or per user. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170User contribution activity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171User contribution by week or month. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173User page views by week or month. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

14 Dashboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17514.1 About the Dashboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Top panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Summary panels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Detailed panels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Login activity example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

15 Languages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18215.1 About languages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

16 UI5 Embeddable Widgets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18516.1 UI5 Embeddable knowledge base widget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

17 SAP Jam Communities API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19017.1 About the SAP Jam Communities API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

SAP Jam Communities API Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190Introduction to OData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .190Authentication and Authorization API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .194

SAP Jam Communities Administration Guide 1902Content P U B L I C 5

1 About SAP Jam Communities

Objectives

SAP Jam Communities enables B2B (business-to-business) and B2C (business-to-customer) companies to:

● Easily set up pre-built customizable pages with reusable widgets and to manage and moderate community content.

● Work with a seamless integration between content syndication within SAP Jam Collaboration to SAP Jam Communities.

● Use secure user and identity management processes for self-registration, the ability to join private communities, and single sign-on between applications.

How it works

As community members, participants can navigate through public and private community groups to:

● Self-serve by reading syndicated knowledge base articles created by product experts and asking questions in community forums.

● Follow exchanges on various topics and express their opinions through comments and contribution likes.● Interact and engage with your business and their peers.

Ease of management

Community administrators can easily manage users, groups, custom home pages, branding, and much more through the administration console.


About SAP Jam Communities

2 System requirements

System Requirements for SAP Jam Communities web application

SAP Jam Communities is a cloud-based offering that requires a connection to the Internet and a supported web browser. Working with SAP Jam Communities also requires the following:

Internet browser

Browser Version Notes

Microsoft Internet Explorer 11 Support for IE 8, 9, and 10 was dropped as of March 4, 2016. Internet Explorer 9 and 10 are no longer supported because Microsoft ended support for these browsers on January 12, 2016.

Microsoft Edge latest

Mozilla Firefox latest

Safari latest

Google Chrome latest

Google Chrome configuration and third-party cookies

By default, Google Chrome allows third-party cookies. If your IT department chooses to block third-party cookies, you'll need to configure Google Chrome to allow third-party cookies from SAP Jam Communities domains.

To allow third-party cookies

1. Open the Google Chrome browser and type the following in the address bar: chrome://settings/content/cookies

NoteThe toggle for Block third-party cookies will be enabled.

2. Scroll to the Allow section.3. Click Add and enter the SAP Jam Communities (*.sapjam.com or *.sapsf.cn) domains used by your

communities instances.

SAP Jam Communities Administration Guide 1902System requirements P U B L I C 7

Allow third party cookies

Browser configurations

Configuration Requirements

Cache size ● 250 MB.● SAP Jam Communities is a Web 2.0 application that uses caching heavily for

static content. Do not clear your community's web proxy cache as this will significantly impact performance.

● Newer web pages must be enabled.

HTTP 1.1 and JavaScript ● Enable.

Browser session cookies (non-persistent)

● Enable for authentication purposes.

Pop-up windows ● Allow for SAP Jam Communities domains.

Adobe Flash plug-in ● SAP Jam Communities supports Adobe Flash Player 10.0 or higher.

Oracle Java Runtime Environment (JRE)

● 1.7 or higher is required for recording audio and video.

Video encoding ● Videos are encoded at two levels: standard definition (480p) and high definition (1080p)

Network bandwidth ● speeds of 300-400 Kbit/s


System requirements

NoteThere are additional requirements for the learning management system package (LMS) and for the virtual learning classroom. Please check with your SAP Jam Communities representative to ensure your users' equipment meets these requirements if you purchase either of these packages.

Security and clickjacking prevention

When using one of the supported browsers listed in this topic to access SAP Jam Communities, malicious attempts at user interface redressing known as "clickjacking" will be prevented. Unsupported browsers may not benefit from this security feature.

Exceptions to consider:

● If you have a custom integration with SAP Jam Communities, please note that you may no longer be able to embed SAP Jam Communities on your own website except through officially supported embed widgets (for example, home feed widget).

● If a third-party website includes a hyperlink to SAP Jam Communities content from within an embedded frame, that link will not work unless it you open it in a new browser tab or window.

In all other cases, hyperlinks from third-party websites to SAP Jam Communities will continue to work as expected.

SAP Jam Communities Administration Guide 1902System requirements P U B L I C 9

3 Personal data and privacy

To comply with EU General Data Protection Regulation (GDPR) requirements (effective May 25, 2018), SAP Jam Communities provides the following functionalities to help adhere to data privacy standards.

Consent and personal data collection: Community Terms of Service and Group Terms of Use

Users may be required to accept a community's custom Terms of Service and custom extranet Terms of Service before they are permitted to access SAP Jam Communities. When they accept the custom Terms of Service, the acceptance details - including the time stamp of when they accepted the terms, and the version of the accepted Terms of Service - are logged in a compliance report. Community administrators can view and specify the date range for the Terms of Service [page 169] report.

Before SAP Jam Communities users join a group, they may be required to accept the group's Terms of Use in order to participate in the group's specific workflows and information sharing. When they accept a group's Terms of Use, the acceptance details - including the time stamp of when they accepted the terms, and the version of the accepted Terms of Use - are logged in a compliance report. Group administrators can view and specify the date range for the Terms of Use [page 105] report.

Logged changes for personal data

Any profile changes made by a user within SAP Jam Communities are logged within its product audit logs. Data changes to the core profile data that is synchronized into SAP Jam Communities from SAP Cloud Platform Identity Provisioning Service is logged by that system.

To obtain the logs for these changes, you can contact SAP Support .

Sensitive personal data

Information is limited to basic personal information that is useful for those using SAP Jam Communities, and does not contain sensitive personal information.


Personal data and privacy

http://help.sap.com/disclaimer?site=https%3A%2F%2Fwww.sap.com%2Fsupport.html

Personal data erasure: Alumni profile page access

When a user leaves the community, in the Admin console Product Setup Features page, as the communities administrator, you have two options to restrict viewing access to their information, now as a community alumni:

● Show profile pages for alumni: An alumni's profile page can still be viewed.● Clear profile info for alumni: If selected, this option allows the administrator to remove the user's avatar

images, location information, and personal contact information from SAP Jam Communities, although the user's manager and job title information is retained. Their profile contributions for example, wiki pages, images, or any content they have created and uploaded to their profile) are still available for others to reference. If deselected to not show profile pages, this option allows the administrator to block access to, and the visibility of, the user's alumni profile page. Their profile contributions (for example, wiki pages, photos, any content they have created and uploaded to their profile, or content that they are tagged in) are then no longer available for others to reference.

When either option is enabled, their alumni personal information is removed from SAP Jam Communities' underlying database tables. All posts, uploads, and activity performed by them is now attributed to the text string, 'Alumni' or its corresponding localized strings in languages other than English.

Personal data erasure: User account deletion

When a user is finished using SAP Jam Communities and no longer requires their account, from their Account Settings they can click Delete My Account which permanently removes their User ID and prevents reactivation of their account. For any work associated with their ID (for example, comments, content items), their name will be replaced with the label "Alumni".

If a user user chooses not to accept the custom Terms of Service, they can click Delete My Account on the Terms of Service dialog to log out and delete their account. This account cannot be recovered.

Retention period

If the "Clear profile info for alumni" option is enabled, the retention period for alumni data is 30 days.

Profile data disclosure

Under Account Settings Profile Data Disclosure , a user can view a list of their personal data stored in SAP Jam Communities. Disclosure details satisfy the compliance requirements for national and regional data privacy standards. Personal data from SuccessFactors Platform or SCIM (for example, e-mail addresses, phone numbers, location addresses) can also display on this page.

SAP Jam Communities Administration Guide 1902Personal data and privacy P U B L I C 11

4 Overview and subscription

The Overview page shows some general information about your instance of SAP Jam Communities, and provides an option to subscribe to product news and updates.

To view your SAP Jam Communities information

1. As a community administrator, go to the Admin console and select Overview.2. The following information is shown:

○ Host: The domain name of the SAP Jam Communities server group that your community instance runs on. The domain name uses the form jam#.sapjam.com, where jam# is the word "jam" followed by a one or two-digit number that indicates the specific data center.

○ Revision: The particular revision of the SAP Jam Communities software load that your instance is running.

○ Product Version: The package of features and capabilities that are available in your instance of the SAP Jam Communities service.

○ Product Instance name: This is the name set in the Branding page of the Admin console.○ Custom Domain: A custom domain that distinguishes your instance of SAP Jam Communities.○ Storage Usage: The horizontal bar indicator shows the percentage of the purchased storage space

used, as well as numeric values for the total amount of cloud storage that your community has purchased, and the amount of that storage used in both percentage and gigabyte (GB) values.

NoteNotifications are sent to community administrators when storage use reaches 80% and 100% of their allocation. If you receive an "80% usage" notification, you should free up storage by deleting old content or contact your SAP Jam Communities Support representative to purchase more storage space. If you receive a "100% usage" notification, your users will no longer be able to upload content. Repeated notifications, which are not configurable and cannot be disabled, will be sent every Wednesday until the situation is resolved. If your community has purchased additional storage space, an email notification will be sent when you have only 90% available storage space rather than 80%.

NoteAn email notification is sent to community administrators when there are only 20 extranet accounts available.


Overview and subscription

Product news and updates

As a communities administrator, you can opt in to receive SAP Jam Communities product news and updates. If there is more than one communities administrator for your organization, they will also be subscribed or unsubscribed based on your selection.

To subscribe all community administrators to receive product news and updates

1. Click the toggle beside Subscribe community admins to receive product news and updates to enable it.

SAP Jam Communities Administration Guide 1902Overview and subscription P U B L I C 13

5 Custom domains

To tightly align your SAP Jam Community with your brand, add a custom domain to your site to make it easy for your customers to remember and access your site.

Introduction

Companies with a custom domain defined will still have their tenant deployed in one of the production data centers, however the URL to access the tenant will use the customer’s custom domain instead of the sub domain of sapjam.com that is provided as a default when the tenant is delivered to you.

Custom Domain Types

1. Custom Subdomain: Your tenant will be delivered with a custom subdomain of sapjam.com that includes the name of your company such as https://example.sapjam.com or https://example-preview.sapjam.com. SAP manages the SSL certificate and DNS entries for custom subdomains.

2. Fully Custom Domain: A domain name managed entirely by the customer, such as https://collab.example.com. Using a fully custom domain requires more technical expertise, because the customer is responsible for creating the DNS entry and for obtaining (and renewing) the SSL certificate.

Who will handle the change

The change itself will be scheduled and handled by SAP, but there are some parts that only you are capable of doing.

Change preparation

1. Precisely identify all the tenants that need to be changed, as well as exactly what the new custom domain for each should be. SAP recommends that customers with a preview and production tenant change both to use custom domains (which must be different, e.g. “example” and “example-preview”) to make it easier to be logged into both tenants at the same time for testing purposes.

2. Once a tenant is changed to use a custom domain, the tenant cannot be accessed by the previous default sub-domain name of sapjam.com.

3. When your tenant is changed from a custom subdomain to a fully custom domain (e.g. https://example.sapjam.com -> https://collab.example.com), the previous custom subdomain will be


Custom domains

removed from the DNS system entirely. It will not resolve, and any attempt to use it will result in a “404” error from the web browser.

4. Given the consequences of this change, you will want to make this change before you launch your community to your users.

5. During the change, your source SAP Jam tenant will be unavailable for use. This process usually takes up to an hour for DNS changes to propagate through the Internet.

6. Your integration with SAP Cloud Platform Identity Authentication Service (IAS) and Identity Provisioning Service (IPS) will need to be configured to reflect the new URL for the tenant.

Fully Custom Domain Restrictions

The SAP Jam Communities tenant must have its own hostname which resolves to an SAP Jam Communities DNS name. For example, https://jam.example.com is allowed, but https://www.example.com/jam is not possible.

The name must also be in a domain that the customer has control over. In the DNS system, the name must resolve to “custom-“ followed by the generic data center domain. For example, a customer in DC17 must ensure that the DNS entry for the fully custom domain is a CNAME record referring to “custom-jam17.sapjam.com”

You must also:

● supply an SSL certificate and private key for the requested fully custom domain name● keep track of when this SSL certificate will expire● upload a new certificate via the SAP Jam administration interface before this SSL certificate expires.

If the SSL certificate expires before it is replaced, any users trying to access the SAP Jam tenant will see an “expired certificate” error in their browser, and be unable to continue.

Effect on URLs

After the change, any URLs that refer to the old generic data center domain will need to be updated to refer to the new data center.

URLs you can choose to have automatically updated by the migration process are in the following SAP Jam textual content:

● wikis● blogs● comments● forum discussions● ideas or questions

URLs in all other textual content will not automatically update with the migration process. This includes textual content that may be uploaded to SAP Jam such as:

● Microsoft Word documents● PDFs

SAP Jam Communities Administration Guide 1902Custom domains P U B L I C 15

● PowerPoint presentations● external links● existing email messages● web browser bookmarks

If you choose to automatically update the links in textual content, that will require the migration process to take longer, and may delay the process as it requires scheduling the migration with the SAP Jam operations team. If you choose to not update these links automatically SAP Jam will automatically redirect to the new URL when following these links, however there are cases where this redirection cannot be done seamlessly, and your users may be unable to use those links.

It is recommended that you assess the impact of what links need updating, and how to communicate this information to your SAP Jam Communities users.

Effect on Email Addresses

After the change, email that SAP Jam sends to your users (e.g. notification emails) will remain generic and continue to be from [email protected] because of DKIM and SPF requirements. Additionally, email to SAP Jam (status document updates via email functions) will continue to be sent to an email address at the old data center domain as shown below:

Example 1 – (@collab.example.com -> @jam4.sapjam.com)

● document.QK3iitd1zzWfRE6NoVqJiY.d0DLOo8r5RFGtp0A9ND2dW@updates-jam4.sapjam.com

SAP Jam tenant will be disabled during the change

Once your tenant migration is scheduled, SAP Jam will be unavailable during the change. Once it is completed, and the necessary configuration changes have been applied on the identity provider (SAP Cloud Platform IAS/IPS), the customer will be able to use their newly migrated tenant.

Migration Process

Once you have decided to switch to a custom domain, the steps to follow are:

1. Contact your SAP Jam customer support representative to request the custom domain. They will discuss the process and schedule the migration.

2. For a fully custom domain:1. create the SSL certificate and the required DNS entry.2. give the SSL certificate and private key to SAP Jam customer support, who will install it. The private

key must not be encrypted or password protected.3. Before the scheduled date, inform your users that the URL used to access SAP Jam will change.4. At the scheduled date, SAP Jam customer support and operations staff will switch your tenant to use the

custom domain, and (if requested) update the URLs in your SAP Jam tenant. They will also update any


Custom domains

integrations (such as with SAP Cloud Platform Identity Authorization Service and Identity Provisioning Service) as planned in the initial discussion.

5. Update any custom integrations that remain.

SAP Jam Communities Administration Guide 1902Custom domains P U B L I C 17

6 Private or public community

After you make you request to SAP to convert your SAP Jam community domain to a custom domain set up, and before you proceed with any configuration steps, you must first determine whether your community will be private or public.

NoteCustom domain [page 14] set up can be scheduled and handled by SAP, but there are some steps for change preparation that are to be completed by you.

Private community

If you are creating a private community where access and content is restricted to logged in members only, you can:

● Go to the SAP Cloud Platform Identity Authentication Administration (IAS) console, and access Applications & Resources Applications Authentication and Access tab to review and understand

the authentication type. For a private community set up, Risk-Based Authentication is the default.● Create a custom landing page [page 36] using the page design editor in the SAP Jam Communities Admin

console.

Public community

If you are creating a public community to allow all anonymous participants to view public community pages, you can:

● Go to the SAP Jam Communities Admin console under Product Setup Features Feature management , select the Enable Anonymous Access for Public Groups option to allow non-registered users to view public group pages.

NoteWhen you select Enable Anonymous Access for Public Groups, you will see Search Engine Configuration under Product Setup. On this page, you can allow the public community to be indexed for searching on Google, Bing, or Baidu.

● Go to the SAP Cloud Platform Identity Authentication Administration (IAS) console, and access Applications & Resources Applications Authentication and Access tab to choose User Application

Access and select:○ Public: Everyone can access the application; new users can register using the self-registration process.

When a non-registered user likes or comments on something, they will be redirected to self-register.


Private or public community

Next steps for both community types

After you determine the user workflow (as in, private versus public, self-registration allowed or not, public search enabled, user authentication), you can set the following:

● Set up your community's legal compliance using the SAP Jam Community hosted Privacy Policy [page 151], Cookies [page 151], and Terms of Service [page 142].

● Custom home page design featuring:○ Row settings with background images and color○ Page design up to a 6 column width maximum○ Addition of page tabs with links to existing content, another site, or group pages○ Persistent home page navigation [page 45] to help users navigate their way back from group pages

top the main community home pages.○ Use of widgets to surface user-generated content published in groups to the community home page.

SAP Jam Communities Administration Guide 1902Private or public community P U B L I C 19

7 User Management

7.1 SCIM Provisioning

If the Users SCIM Provisioning page appears in your Admin console menu, then your user identity, authentication, authorization, and single sign-on (SSO) capabilities are supplied by an SCIM-compliant identity management system. SAP's SCIM offering is SAP Cloud Platform Identity Authentication, which is the likely identity management system that you are using and explained further in this section.

If you are using a third-party SCIM-compliant identity management system, please refer to their documentation for details on its use.

NoteYou should not make any changes to the form on this page, as it is configured by SAP Jam Communities Support to manage user identity services in the manner requested by your community. If you do want to make changes, please contact your representative.

Although changes should not be made in the Users SCIM Provisioning page, SAP Cloud Platform Identity Authentication does offer its own web-based administrator console in which your user identity features can be managed.

If your community's instance has been configured to use SAP Cloud Platform Identity Authentication, you will receive an email with a link to the SAP Cloud Platform Identity Authentication administrator console. Click that link to open the SAP Cloud Platform Identity Authentication administrator console in your web browser.


User Management

The SAP Cloud Platform Identity Authentication administrator console

The following procedures are performed in the SAP Cloud Platform Identity Authentication administrator console.

Add users to your SAP Cloud Platform Identity Authentication manager

● Add a single user via the SAP Cloud Platform Identity Authentication administrator console's interface● Add multiple users by importing a CSV file● Create users programmatically via API

SAP Jam Communities Administration Guide 1902User Management P U B L I C 21

https://help.sap.com/viewer/6d6d63354d1242d185ab4830fc04feb1/Cloud/en-US/348deef7f29b40909b151c8dc9a11d53.html

https://help.sap.com/viewer/6d6d63354d1242d185ab4830fc04feb1/Cloud/en-US/33838e0760f8411daf758a1c11818cc4.html

https://help.sap.com/viewer/6d6d63354d1242d185ab4830fc04feb1/Cloud/en-US/cea87780bee94c6994b8005c6d6a4815.html

Remove users from your SAP Cloud Platform Identity Authentication manager

● Delete users via the administration console● Delete users programmatically via API

Give a user administrator privileges

● Add Administrators via the administration console

Access SAP Jam Communities from the SAP Cloud Platform Identity Authentication administrator console

1. Access your community's SAP Cloud Platform Identity Authentication manager, and in the Applications & Resources section, click Applications.

2. From the left sidebar, click SAP Jam Communities.3. Just below the title of the application on the main pane of the page, click Home URL and select Visit from

the context menu.SAP Jam Communities displays in a new tab.

NoteYou can click the Branding and Options tab, below the Home URL link, where you can set the appearance of the SAP Jam Communities login page.

7.2 Identity Authorization and Provisioning

SAP Jam provides integration with robust authentication and provisioning services to support private and public communities.

Requirements for public communities

In a public community, anyone can discover and read content within a community; a user only needs to register to contribute to the community, or receive notification on activity within the community. Public communities are well-suited for sharing information amongst current and future adopters of a product or service.

In a public community, a member of the public can:


User Management

https://help.sap.com/viewer/6d6d63354d1242d185ab4830fc04feb1/Cloud/en-US/bbfaf5f308084a769c32ace3908effd8.html

https://help.sap.com/viewer/6d6d63354d1242d185ab4830fc04feb1/Cloud/en-US/436015d66dad4c129a87604eda2f7134.html

https://help.sap.com/viewer/6d6d63354d1242d185ab4830fc04feb1/Cloud/en-US/bbbdbdd3899942ce874f3aae9ba9e21d.html

● Access the community page without authentication.● Browse community pages.● View public community groups.● Choose to register with the community, to be able to contribute content to, or receive notifications from,

the community, or to join private groups (by invitation).

Requirements for private communities

Private communities are best suited for users of products or services where a higher level of privacy is required. For example, a company may wish to set up a private community to enable collaboration amongst their business partners. Private communities require authorization prior to accessing the community.

In a private community, access is restricted to specific individuals where:

● The community cannot be browsed by members of the public.● Only pre-authorized users can access the community.● Pre-authorized users who access the community will be provisioned at access. For example, in a partner-

network where hundreds of partners are authorized to join a community, only a subset of these partners may choose to join.

7.2.1 Architecture

SAP Jam Communities works with SAP Identity Authentication Service (IAS) and SAP Identity Provisioning Service (IPS) to provide a robust means for creating, authenticating, and provisioning community users.

SAP Jam Communities

As a modern cloud-enabled service, SAP Jam Communities delegates user management to external services. A SAP Jam Communities tenant is delivered with an SAP Identity Authentication Service tenant for user management, and an SAP Identity Provisioning Service tenant for user provisioning.

SAP Jam Communities is configured to accept users provisioned to it from the IPS tenant, and user authentication from the IAS tenant.

SAP Identity Authentication Service

IAS provides a platform for managing user identity in the cloud. An administrator uses IAS to create user accounts, manage authentication services, and specify service access.

With IAS, you can:

● Create user accounts or enable self-registration.


● Define authentication requirements for users, including options to specify login IP address ranges, two-factor authentication, and password requirements.

● Support single-sign-on between services.● Set proxy authentication requests to a corporate IDP.● Accept social logins.● Connect services that require authentication, and specify the users or user groups that have access to

these services.● Provision users directly to services, or call the SAP Identity Provisioning Service to provision users to

disparate services.

IAS can be used to manage many applications other than SAP Jam Communities. Users within IAS can be assigned to groups, and access to application can be based on membership within a group. Consequently, a key mechanism for managing users and their authorized access to applications is through the use of IAS groups.

SAP Identity Provisioning Service

IPS automates identity lifecycle operations by provisioning user identities and authorizations from a source system to a target system. IPS supports provisioning services between a range of SAP services, between Microsoft Azure, Google G Suite, Microsoft Active Directory, LDAP, and other services. IPS also supports the open SCIM (System for Cross-domain Identity Management) protocol for service provisioning.

IPS reads users and profiles from a source system, transforms or maps user attributes within these profiles, provisions based on user attributes, and writes users and profiles to target systems. For example, an IPS service can be created to read from one system, selectively provision users with a specified attribute (for example, a user type field), transform data between different models, and provision the resulting users to a target service.

Overall architecture of SAP Jam Communities

IPS, IAS, and the SAP Jam Communities tenant work together to deliver public and private communities. Accounts for users are created in IAS (either directly by an administrator, or through self-registration). IPS provisions users from IAS to the SAP Jam Communities tenant.

7.2.2 Configuration and workflow

Public community

In a public community, non-members should be able to browse the community and register with the service so that they can contribute and comment on content. When a public member access the community, they will be


User Management

redirected to IAS for authentication. IAS will be configured (through the "User Application Access" setting) to allow anyone to access the application.

Configuration for public community

To support a public community, configure IAS with:

● User Application Access set to "Public".○ This ensures that all public members accessing the community are allowed to access the community

page.○ Members of the public are allowed to register with the community in order to receive notifications from

the community.● A provisioning group created for the community.

Go to the SAP Jam Communities Admin console under Product Setup Features Feature management , select the Enable Anonymous Access for Public Groups option to allow non-registered users to access public groups, if desired.

Workflow for public community

The community can provide a means for members of the public to self-register with the community. Then the community will re-direct the user to a self-registration page. After the user registers, the:

● user is authenticated to the community.● community accepts the authentication, but does not have a profile established for the user.● community makes an API call to IAS to add the user to the provision group for the community (for

example: "community-provision"). Adding the user to the group will trigger the real-time provisioning process to immediately provision users with an attribute change (in this case, the addition of the user to a group) to SAP Jam Communities.

● IAS invokes IPS to initiate provisioning when a user is added to the access group.● IPS provisions the user to the community.● community page refreshes in SAP Jam Communities, and shows the user as logged in to the community.

Private community

With a private community, only specified members are allowed to access the community.

When a public person accesses the community, they will be redirected to IAS for authentication. IAS will be configured (through the "User Application Access" setting) to only allow existing users to access the application. It will also be necessary to determine which users in IAS are allowed to access the application - this will be done by assigning authorized users to a specified access group.


Private community configuration

To support a private community, configure IAS with the following:

● User application Access set to "Internal".● A provisioning group created for the community (for example: "community-provision").● An access group created for the community (for example: "community-access").● Users authorized to join the private community have accounts created in IAS and assigned to the

community-access group.● Risk-based authentication has been configured to allow access to the community based on a member

being authenticated and part of the community-access group.

Workflow for private community

When a user accesses the community (for example: "https://community.corp.com") for the first time:

● The user will be redirected to the IAS login page for the community.● After the user is authenticated by IAS and their authentication is asserted to the community:

○ If the user is not in the community-access group, the user will be presented with a notice indicating that they have been authenticated, but do not have access to the community.

○ If the user is in the community-access group, the user authentication will be accepted by the SAP Jam community tenant.

● If the user has been accepted into the community, but does not have a profile in the community, the user will be provisioned as per the same process for public communities described earlier in this topic.

7.3 Alias accounts

Community administrators can create up to 100 alias user accounts where one or more users can be assigned to use the alias user account on behalf of their community. An alias user account enables community participants to easily identify a point of contact for specific interaction. For example, if a user has questions about a product discussed in the community, it is easier to contact a user named "Product Support" with product questions than it is to find the name of the exact person.

Create an alias account

To create an alias account

1. Go to the Admin console and choose Users Alias Accounts .2. Click New Alias Account. Complete the following steps for the Basic Profile section:

○ Below the automatically generated Alias User ID, enter the Alias Account Name. This name will be visible and used for interaction.


User Management

○ Enter some text to describe the purpose of the alias in the Description text box.○ Click Save changes to save the basic profile information. You can return to this section later to enter

more information after you save information in the other sections of this account configuration.3. Complete the following steps for the Users section:

○ In the Add users to alias account text field, enter the name of each user that you want to add to the alias account. If you want to remove any of these users, then click Remove beside their name in the Users list.

○ Click Save changes to save the users information.4. Complete the following steps for the API Access section and when the alias user is defined as a system

user (for example, bot):○ Click Add OAuth2 Access Token.○ From the drop-down list, select the OAuth client and then click OK. The token information will update

and display in this section, along with the name of the OAuth client.5. Complete the following steps for the Email Settings section:

○ From the dropdown list, you can choose to enable or stop all email notifications.○ Click Save changes to save the email settings.

6. Click Back to main page.

Once a user is assigned to an alias user account, they will be able to go the the gear icon above the global menu bar and select their alias user account, under the Switch User section of the menu. A banner appears above the Search field to indicate that the user is "Currently acting as an Alias User". Alias users can create groups and design group pages with their group administrator privileges.

Edit an alias account

To edit an alias account

1. On the Alias Accounts page, beside the alias account that you want to modify, choose Action Edit .2. Edit the basic profile, users, API access, email settings, and contact information.3. Click Save changes to save the profile changes.

Delete an alias account

To delete an alias account

1. On the Alias Accounts page, beside the alias account that you want to delete, choose Action Delete .2. Click Confirm on the delete confirmation message to remove the alias account.


7.4 User account settings

Account settings allow you as a user to control features specific to your experience in SAP Jam Communities.

From the top menu bar, on the far right side is a gear icon. When you click it, a dropdown menu appears.

Click Account Settings to access any of the following:

● Change Password: Reset your password as per your community's password policy requirements.● Email: Select the types of high priority or daily e-mails you want to receive; select the frequency of group

notifications.● Applications: Lists any authorized applications that have access to your account.● Profile Data Disclosure: View a list of your personal data stored in SAP Jam. Disclosure details satisfy the

compliance requirements for national and regional data privacy standards. Personal data from SCIM (for example, e-mail addresses, phone numbers, location addresses) can also display on this page.

● Language: Select your preferred language. All pages in SAP Jam Communities will reflect your language preference. This does not apply to text written by other users, unless they have been written in your preferred language.

● API Access: Change your API password to grant access to SharePoint or an RSS reader.● Time & Calendar Settings: Set your time zone preference and the first day of the week for your personal

calendar.● Designate Blog Post Author: Choose another user to publish and edit blog posts on your behalf.● Trash: Contains items which you previously deleted, which can be restored.● Delete My Account: Removes the current user's ID, profile information (for example, display name, job title,

avatar), replaces name with "Alumni", and prevents reactivation of the account. See Personal data and privacy [page 10] for more details.

NoteSome features may not be enabled. For more information about which features are available to you, contact your community administrator.

7.4.1 Edit profile page

On your profile page, you can control who sees your basic profile information such as your job title.

To set your profile information visibility

1. Beside the profile information field, from the dropdown, choose Everyone to make the information fully visible, or Only me to restrict visibility for your viewing only.

2. Click Save changes.


User Management

7.4.2 Profile management

Your personal information, password changes, contact preferences, and data reports can be managed from the Profile Management page.

To access the profile management page

1. From the global menu bar, click the gear icon and choose Account Settings.2. Click Change Password. This opens the Profile Management page.3. Scroll to the section you want to view or make changes to. Sections include Password, Company

Information, Contact Preferences, Two-Factor Authentication, Social Sign-on, and My Data.

7.4.3 E-mail settings

From the Settings icon at the top of the page, choose Account Settings from the dropdown menu, and select Email to display the Email Settings page. There, as a community participant you can control when and how often you receive update e-mails from SAP Jam Communities, and even choose not to receive any e-mails. On the Notifications tab, you can select which e-mail notification you want to receive based on activities that involve you, or your need for daily summary emails. On the Groups Notification tab, set the email frequency for all groups you belong to. To select all the events for each category, you can click the select all checkbox beside each heading.

When community users log in, they will see a prompt to subscribe to the community newsletter. When they select the newsletter option, they will receive important updates and information at the email address configured with their account.

Community newsletter opt in through E-mail settings

Note

As a community administrator, you can go to the SAP Jam Communities Admin console Reportspage, choose the Newsletter Subscribers report and view a list of subscribers for the entire community, or a list of guest users only.


7.5 Private community

As the administrator of a private community, you can control who accesses the community.

All tenants are configured as private communities by default. If you would like to open a community to the public see Public community [page 31].

User management in SAP Cloud Platform Identity Authentication Administration (IAS) console

Step 1: Add users to your SAP Cloud Platform Identity Authentication manager

1. Add a single user via the SAP Cloud Platform Identity Authentication administrator console's interface.2. Add multiple users by importing a CSV file.3. Create users programmatically via API.

Step 2: Grant user access to your private community

1. In IAS under Users and Authorizations User Management , select the user and view the User Details page.

2. Click User Groups. The list of available groups displays.3. Select the community access group and click Save.

NoteIf you do not provide access (either not set up, or removed access), when the user tries to log in to the community with their email and password, while the user is authenticated in IAS, they see an authenticated but not authorized page, prompting them to contact their administrator for assistance.

User activation and set up

Once the user receives the activation email, they will need to complete the following steps:

1. From the email, click the Activate link or copy and paste the link into their browser window.2. On the profile page under the “Tell Us About Yourself” section, enter the following:

○ First Name○ Last Name○ E-mail

3. Under the “Set Password” section, enter the following:○ Password○ Re-enter Password

4. Click Save. An “Account Successfully Activated” page displays.5. The welcome page for the Community displays. It prompts the user to enter a public name and optionally

upload their photo or avatar. Once they complete this step, they can access the community.


User Management

https://help.sap.com/viewer/6d6d63354d1242d185ab4830fc04feb1/Cloud/en-US/348deef7f29b40909b151c8dc9a11d53.html

https://help.sap.com/viewer/6d6d63354d1242d185ab4830fc04feb1/Cloud/en-US/33838e0760f8411daf758a1c11818cc4.html

https://help.sap.com/viewer/6d6d63354d1242d185ab4830fc04feb1/Cloud/en-US/cea87780bee94c6994b8005c6d6a4815.html

7.6 Public community

To switch your private community to a public one, use the SAP Cloud Platform Identity Authentication Administration (IAS) console.

Use the IAS console to reconfigure a private community to a public community

See the following help topics for configuration steps:

1. Configure User Access to the Application2. Configure Risk-Based Authentication

After you complete the IAS setup, go to the SAP Jam Communities Admin console under Product SetupFeatures Feature management , select the Enable Anonymous Access for Public Groups option to allow non-registered users to view public group pages.


https://help.sap.com/viewer/6d6d63354d1242d185ab4830fc04feb1/Cloud/en-US/8b147c46269243dd8e5a42feb8b5a2ef.html

https://help.sap.com/viewer/6d6d63354d1242d185ab4830fc04feb1/Cloud/en-US/bc52fbf3d59447bbb6aa22f80d8b6056.html

8 Home Page Customization and Branding

8.1 Web

There are many options available for customizing your community home page experience to help users identify your brand.

To configure style and support options for the communities web experience

1. Go to the Admin console and select Branding Web from the navigation menu.2. On the Branding and Support page, you can set the following options:

Note○ Each color attribute contains a color picker so you can choose a color rather than manually

entering the hexadecimal value.○ After making color changes, ensure that elements remain visible within the application.○ For each section, when you click the information icon, it shows which parts of the screen are

affected by the attributes within the SAP Jam Communities experience.

Branding Designer Tips Pictogram


Home Page Customization and Branding

Branding and Support Options

Section Attribute Special Notes

Product Instance name

The name that users see in various places in the SAP Jam Communities.

Global Navigation Bar Default text color

Hover text color

Default background color

Hover background color

Keyline and Overview Tabs

Default text color


Keyline and tab color

Font type The font applies to home page menu titles, group overview menu titles, and widget titles. Choose from up to 30 standard fonts or upload your own custom font. Acceptable custom font file types include .woff. Please ensure you have the proper license to the custom fonts before you upload. Click Reset to default font for standard fonts.

Left Hand Navigation Default text color

Hover text color

Selected text color


Selected background color

Widgets on Overview Header text color

Header background color

Font size The minimum allowed font size is 12px and the maximum is 40px. If you enter a value outside of those ranges (for example, 11px, 50px), the value will automatically adjust to the nearest minimum or maximum pixel value allowed.

SAP Jam Communities Administration Guide 1902Home Page Customization and Branding P U B L I C 33

Section Attribute Special Notes


Widgets on Home Page Header text color

Header background color

Font size The minimum allowed font size is 12px and the maximum is 40px. If you enter a value outside of those ranges (e.g., 11px, 50px), the value will be automatically adjusted to the nearest minimum or maximum pixel value allowed.


Side panels Default text color

Hover text color



Hyperlink color

Group Header Navigation Hover text color

Primary Button Default text color


New Feed Update Default text color




NoteCommunity administrators can reset their instance of SAP Jam Communities to the default branding by clicking Reset colors.

3. Community Logo: You can click Browse to select a new community logo from your local drive that you want to upload and use. A thumbnail image of the logo will display as a preview. This community logo will appear in various places in the application. The image will be resized to 64 x 32 pixels. You can also delete the logo by clicking the X beside the thumbnail.

4. Custom Header: You can include or remove any of the variables within HTML tags listed in the following table. For the site header, you can also add, remove, rearrange, and edit the HTML, CSS, and Javascript in the global navigation tags now contained in the customizable header code. If a user does not have access to a given menu, they will not see it on the global navigation.

Custom Header tags

HTML Tag Supported Attributes Description

<jam-search></jam-search>

color

color-hover

only-icon

Provides filtered search functionality. A dropdown filter beside the search box helps users refine their search.

<jamprofile></jamprofile> border-radius Displays the user's profile avatar, provides access to the user's profile page, and allows the user to enable browser notifications.

<jamnotification></jamnotification>

color

color-hover

Represents the bell icon used to access a notifications list. Shows the number of unread notifications for current user.

<jam-settings></jam-settings>

color

color-hover

Represents the cog icon used to access account settings, the Admin console (only for community admins), and to log out.

<jam-help></jam-help> color

color-hover

Represents the Help icon used to access help pages and a getting started tour.

<jam-string></jam-string> For content that has already been translated in one or more languages for the custom header for the community home pages.

<jam-instance-name></jam-instance-name>

color

font-family

font-size

Displays the product instance name.

<jam-company-logo></jam-company-logo>

Displays the community logo image.


HTML Tag Supported Attributes Description

<jam-menu></jam-menu> color Menu for global navigation, settings, and recently accessed items.

5. Custom Footer: You can set a Custom Footer that will appear on most pages of the application.You can replace the footer displayed throughout the application with any HTML content entered in this text box. Again, you are responsible for the impact of any such changes upon the appearance of your product instance.

6. Email Settings: You can choose to:○ Include the current community logo in the email header.○ Include the SAP Jam Communities logo in the email footer.

These settings will affect the email notifications sent by SAP Jam Communities.7. Help Settings: You can set the following options:

○ Display on-line help in Settings drop-down menu or via global help icon: The default if this option is selected is to present a link to the SAP Jam Comunities Support Center group.

○ Enable a custom help page This option allows you to have the help links that are enabled in the preceding option to link to an online help URL of your choice. This URL must be set in the Help Page URL text box below this option.

8. Support Contact: You can set the SAP Jam Communities support contact email address.This contact information appears in the following situations:○ If a user's account has been disabled and they try to log in, a message advises them to contact their

administrator and they are shown a link to this email address.○ If a user encounters a SAML authentication error, a message advises them to contact their

administrator and they are shown a link to this email address.○ If a user attempts to sign in to SAP Jam Communities in response to an invitation that was sent out

when the product instance was configured without integration with SuccessFactors Platform, but it has since been integrated, the user will be shown a message advising them to contact their administrator and they are shown a link to this email address.

9. If anonymous access is disabled, using page designer to create a landing page [page 36] to act as an unauthenticated page for private communities.

10. When you have all of the Branding and Support settings as you want them, click on Save changes to apply your settings.

Default HTML example

Go to the Github repository to view a sample of the custom header HTML.

8.1.1 Pre-authentication landing page

For private communities, when anonymous access is disabled, a default IAS log on page displays for community participant authentication. As a Communities administrator, you can create a more informative and familiar custom landing page to display before your users log in through the IAS log on page. Through the SAP Jam Communities Admin console, you can customize a landing page using a default template in page designer.



http://help.sap.com/disclaimer?site=https%3A%2F%2Fgithub.com%2FSAP%2FSAPJamSampleCode%2Ftree%2Fmaster%2FCustomHeader

Landing pages can provide helpful information such as the purpose of the community, and what is required to access the site.

To create a landing page

1. From the admin console under Branding Web , click Create Landing Page, and then:○ Use text and image widgets to design your page.○ Remove, edit or replace any existing widgets from the default template to customize as needed for

your community.

NoteIf you delete the Log On button, but later decide that you need to add it again, you can use the text widget to recreate the button, and link it to the Login page URL.

2. Before you publish the landing page, click Preview to see how it will appear to community users. The page opens in a new browser tab.

3. As you are about to publish your community landing page, you can select the Make landing page public option. By default, this option is not enabled.

After the landing page is created, you can click Edit landing Page to edit it. If a landing page is no longer required, you can disable the Make landing page public option.

Links to the Terms of Service and Privacy pages display at the bottom of the landing page when you copy the URL file paths to the custom footer under web branding.

8.2 Email templates

The Email Templates page allows you to alter the style of email notifications sent from your community instance to users. If preferred, you can set separate email templates for internal and external recipients. You can edit and save email template changes without affecting the appearance of your current emails, allowing you to preview those changes, and publish them only when your email template changes are satisfactory.

Modify email templates

When sending emails, SAP Jam creates a multipart message (per https://www.w3.org/Protocols/rfc1341/7_2_Multipart.html) that contains two versions of the same email: an HTML version and a plain text version. When a user opens an SAP Jam email, their browser or email client application shows the HTML version if it supports HTML emails, or the plain text version.

To make sure all users can view your changes, you must provide both HTML and plain text messages for some of the fields.

For the HTML version, use the following:

● Email Background Style: some Cascading Style Sheet (CSS) rules● Page Background Style: some Cascading Style Sheet (CSS) rules


● Page Header HTML: HTML elements● Page Footer HTML: HTML elements● Footer HTML: HTML elements

Any text provided here is shown to users with email clients that do not support HTML emails. For the plain text version:

● Page Header Plain Text● Page Footer Plain Text● Footer Plain Text

To edit email templates

1. Go to the Admin console and select Branding Email Templates from the navigation menu.2. Select the Enable custom email template checkbox to activate this feature and to enable you to make email

template changes.A panel displays with a pair of tabs and a preview image of the email layout, with two edit boxes.

The Email Templates page (enabled)3. Click (Edit) beside Background & Page in the preview image of the email, and make your changes to the

style settings for the Background & Page Design.You can set any of the following CSS properties for either the Email Background Style or the Page Background Style:○ background-color○ border○ border-color



○ border-width○ box-shadow

4. As you click through each section - page header, page footer, and footer - specify the language and enter the translated text for that section:○ Click (Edit) beside Page Header in the preview image of the email, and make your changes in the Page

Header HTML or the Page Header Plain Text edit boxes.○ Similarly, click (Edit) beside○ Page Footer○ and Footer in the preview image.

If any field for the header and footer does not have a translation available for a language, the corresponding value for the "Unspecified" language is used. For example, if "Page Footer HTML" is left blank for Deutsch, the value of "Page Footer HTML" in the Unspecified locale is used.

5. When you have the email template changes set as you want, click Update to save them. This does not change the look of your system's emails until you click Publish.

To preview your email template changes

1. To preview your changes, ensure that you have saved them by clicking Update.2. Once your changes have been saved, click Preview. A Send Email Template dialog box displays.3. In the text box, enter the email addresses of those who should preview the revisions. Multiple email

addresses can be entered by entering them in a comma-separated list.4. Click Send. Emails are sent to the specified recipients using your email template revisions.

To revert your email template changes

Once you save the changes that you have made to an email template by clicking Update, a notification panel appears between the Enable custom email template option and the template editing tabs, advising you that "The template is saved, but is not yet published".

Click Revert to Published Version if you decide to roll back your saved changes. The changes will be reverted, and the published email template settings are restored.

To publish your email template changes

Once you have reviewed your template changes, and you are ready to use them, click Publish, either below the template editing tabs, or above them.


To configure a different email template for external users

To set a different email template for external users, do the following:

1. Click on the External tab, and deselect the Same settings used for Internal Email Template checkbox. A preview image of the email layout and editable text boxes appears in the tab, like those in the Internal tab.

2. Make the changes that you want, just as you did for the Internal template.3. Save, preview, and publish the changes, just as you did for the Internal template.4. If you decide to return to using the same email template for email to both internal and external users,

select the Same settings used for Internal Email Template checkbox. The preview image of the email layout and the editable text boxes disappears in the tab, like those in the Internal tab.

NoteYou must click Publish to enable this change back to using the same template for emails from to internal and external users.

To disable the use of email templates

If you decide that you no longer want to use customized email templates, clear the Enable custom email template checkbox.

The preview image of the email layout and the editable text boxes disappears from the page.

NoteYou must click Update to save this change.

8.3 QR codes

The QR Code scanner supports SAP Jam Communities specific QR codes or any other QR codes encoding a valid web URL. You can customize the QR code that's shared and used to join groups.

Brand the QR Codes

To brand your community QR Codes with custom colors

1. Go to the Admin console and select Branding QR Codes from the navigation menu.2. Customize the following:

○ Foreground color: Choose a color that can be easily distinguished from the background.○ Background color: Choose a color that can be easily distinguished from the foreground.



○ Logo: Click choose file to select a logo from your local machine.

○ NoteLogos must fit square size dimensions and have width and height less than or equal to 200 pixels.

3. Click Save changes.

8.4 Customize the home page

Home pages are a way to better inform your users of community-wide information, announcements, and much more. You can create separate custom home page layouts for full access, restricted access, and external users. For full access users and external guests, you can also customize branding.

Anatomy of a home page

While home page design is similar to using the page designer to customize group overview pages, there are some notable differences:

● Custom home pages provides a layout of up to six columns layout. The width available for multi-column widgets should include the width for each column plus the spanned gutters.

● For example, when using an image widget, keep the following recommended width sizes in mind for an up to four column span to ensure highest viewing quality:○ image spanning width of one column: 288 pixels○ image spanning width of two columns: 585 pixels○ image spanning width of three columns: 883 pixels○ image spanning width of four columns: 1180 pixels

● For an up to six column span, when using an image widget, consider the following for highest viewing quality:○ image spanning width of one column: 188 pixels○ image spanning width of two columns: 386 pixels○ image spanning width of three columns: 585 pixels○ image spanning width of four columns: 783 pixels○ image spanning width of five columns: 981 pixels○ image spanning width of six columns: 1180 pixels

● The feed widget displays the community feed, not a group feed.● The people widget displays selected members only.● The action widget contains a smaller list of actions (add a blog post or wiki page, create a poll, feed and

email settings, and access trash).● An announcement can be added to the top of the home page in its own section. Designed with one or more

widgets it can be used to communicate important news or events that must be shared community-wide.

To create a custom home page

1. Go to the Admin console and select Product Setup Home Page Management from the left side navigation.

2. To design the layout of your custom home page, click Manage Home Page.The page layout displays. When you click the Edit icon from the Page Settings wand, your view switches to Edit mode for the page you are currently viewing.


Note**Deprecation has begun on this option as of the February 2019 release** You can enable the alignment of widgets by row when selecting the Optimize Page Layout option. The widgets with the smaller height dimensions in a row will automatically expand to align with the widget with the largest height dimension. The optimize layout options do not apply when trying to align widgets in a row containing feed and image widgets, namely because of their specific and typically larger height requirements.

NoteYou can show or hide the white background colour and one pixel border around each widget by setting the Show Widgets as Tiles toggle while in edit mode on the custom home page.

Note○ When you click and drag the bottom edge of an image widget to resize it, a new guideline appears

to help you align the edge with another widget on the same row. As you drag the guideline, it will automatically snap to the bottom edge alignment matching the other widget.

○ The feed widget can display the home feed or community feed.

When you hover your cursor near the top right corner of a row, an icon appears for row settings. For each row on the home page, you can set the following options:○ Extend the row to full width. This helps maximize the use of space on the page while providing a clean

design.○ Include a row background color or image. You can select an image from your local drive or choose one

from the home page content repository.○ Set top and bottom row padding in pixels.

There are four default menu navigation tabs that display to help you get started with your community home page design. Please remove and replace any item with italicized text.○ Home: Includes text widgets with tips on how to use the page settings wand, linking to groups,

inserting rotating banners and forums.○ Q&A: Includes text widgets with tips on how to link to the questions section for a group and edit this

page.○ Blogs: Includes text widgets with tips on how to link to include blog posts and edit this page.○ About: Includes a text widget with tips on how to use a text widget to provide a description of your

community.While in the page designer, beside the page title text box at the top, there are buttons on the right side that allow you to:○ Publish: Save the page design and use it as your community's home page.○ Preview in mobile: View the page in a responsive web setting to simulate the single column layout

mobile experience. You can also choose the order in which to display pinned widgets in a single column layout applicable for mobile devices or accept an optimized default order. Use the up and down arrows that appear when you hover your cursor near the top of any widget in preview mode to move them.

NoteWhen you have multiple widgets in a row with applied background settings, you can select Show in Mobile so that those widgets appear when viewed on mobile devices. However, the Pin to Top setting is disabled for rows with background styles.



○ Save Draft: Save the page design without setting it as your community's home page.○ Delete Draft: This button only appears if you have saved a draft home page and you have elected to

edit it again. Click this button to delete the draft version.○ Cancel: Exit the page designer without saving changes.

3. Once you have created the layout of your home page, you are returned to the Product Setup Home Page Management creation page in which you can make further modifications.1. Click Upload File to upload content.2. Click Create to create blog posts, wiki pages, links, multimedia, and folders.3. You can copy, move, tag, edit, download, and delete items that have been created or uploaded on the

Homepage Customization section.

Multiple level menu navigation

Below the default global navigation header, you can create and manage a two-level menu hierarchy (navigation tabs): a top menu tab with sub menus . To create a multiple menu experience, for each top menu, one or more sub menus can be added.

When in edit mode, you can click the Rearrange icon to open the Rearrange Tabs dialog. There, you can click and drag to move a first level tab to a second level tab, or from second to first, for custom home and area pages. You can also move a second level tab to the second level of another tab.

Revert to an earlier version

As a community administrator, you can revert to a previous version of a custom home page by clicking the Version History icon from the Page Settings wand and selecting the version you wish to revert back to. When reverting the header, the change is applied to all home pages, including area home pages. As an area administrator, you can revert to a previous version of a custom home page for the area.

When you create or edit a custom home page and supply text, the text is considered untranslated. To support community users who understand multiple languages, you can provide translations for image captions, menu tabs, text widgets, and widget titles in one or more available supported languages.

NoteOn the custom home page, click Translate on the page settings wand, and then select your preferred language from the Language dropdown on the following page.


Select the preferred language for translation

To translate a text widget, enter the translated text directly into the text box. To translate a menu tab, enter the translated text into the page title text box.

If a translation is unavailable, the non-translated locale that was used when creating or editing the page displays. All image captions, menu tabs, text widgets, and widget titles must use the same language per instance of translation. For example, if you want to view or translate from English to French, German, and Spanish, you can only select one language at a time. If an item is not translated, for example, the title of a widget, you can click Translate beside the title to edit it and manually enter your translation.

Similar to saving a custom home page as draft, you can also save translations as a draft. Draft translations are not visible to end users. As an administrator, you can view draft translations or published translations. You can resume editing a draft, delete a draft, or publish a draft. Each time you publish a translation, a new version of the custom home page is created in the version history.

Home page content repository

On the Page Settings wand, there is a Home Page Content icon that allows you as a community administrator or page content administrator to conveniently access the home page content repository. When you want to switch back to the home page, you can click the same icon.

Post publicly visible comments

When maintaining your community pages through the Admin console Product Setup Home Page Management , you will see an Allow users to post publicly visible comments on community content option which allows users to comment on, like, tag or rate documents, videos, and images that are uploaded and displayed on the community home page. Comments are publicly visible and searchable by everyone in the community. By default, this option is enabled but you can toggle it to disable.



NoteWhen you select this option, it does not apply to content that's uploaded or posted to public groups and displayed on the home page.

Delete home page and content items

If you delete a custom home page or content such as documents and images in the home page repository, the deleted content is now moved to a Trash folder.

Main page and sub tabs: If you delete a main page tab with sub tabs, only the main page tab appears in the Trash. If a sub tab is deleted and then restored, if the main page tab still exists then the sub tab is restored under the main page tab. If the main page tab no longer exists, the sub tab is restored as a main page tab. From the Trash, you can restore or purge the deleted tabs.

8.4.1 Persistent site navigation and links

When branding the custom header for your custom home page, you can create a custom site navigation that includes links to specific content, group overview pages, or external web pages.

To make this navigation display throughout all pages in your community, from the Admin console Product Setup Features page, you can enable the Persistent Navigation Bar option under the Feature Management section. When navigating to different pages, the custom site navigation then displays on every page to help users find their way throughout your community.

Site Navigation with links

To add tabs that with links to specific content, groups, or external pages

1. Go to the edit mode for the custom home page.2. On the site navigation bar, click the + icon.3. Enter a the name of the content, group, or external page you want to link to in the Tab Name field.4. Select the Link to existing content or external pages option.5. Enter a valid URL for the link.6. Click Create. Your new tab is added to the site navigation bar.

The background color (default background color) and font color (default text color) for the tab can be customized under the Keyline and Overview Tabs section of the Branding Web page.If you want to delete a tab, provide a translation, or rename and edit the URL, click the Rearrange/Manage Tabs icon beside the +. Select the dropdown beside the tab.


8.4.2 Global edit mode

From any navigation tab on the home page or group page, if you have access to design mode as an administrator, you can easily access the Edit mode function.

On the top right corner of a home page or group overview page (below the global menu bar), click the Enter admin mode button to switch to the view where you can manage page content. To leave the admin mode and return to the regular page view, click the Exit admin mode button below the global menu bar at the top.

8.4.3 Announcement

As a community administrator or page content administrator you can create and maintain a single announcement. You can add any number of widgets to the announcement and fill them with content from the community repository or public groups.

When an announcement is created, you can optionally include the announcement at the top of the home page by selecting a checkbox prior to publishing.

Step 1: Create an Announcement section and use widgets to create announcement

To create a new announcement section

1. From the Admin console Product Setup Custom Home Page click Manage Announcement.2. On the Edit Announcement page, use one or more widgets to create the announcement. You can save a

draft version, preview it in mobile view, publish it, or cancel your changes. Drafts can later be edited, translated, deleted, or published.

3. When you are ready to publish this for use with custom home pages, click Publish. The announcement is now available to include when designing home pages.

If an Announcement section is created but the announcement has yet to be added or published, when the Include Announcement checkbox is selected in page design mode, a message informs the page designer that the announcement itself has not been created yet. Once it is published, the announcement will display in the Announcement section.

Step 2. Include announcement

To include the announcement in a custom home page

1. From the Admin console Product Setup Custom Home Page click Manage Home Page.2. Above the body of the home page, you can select the Include Announcement checkbox. This displays the

announcement in edit mode. When you publish the home page, users will be able to see the announcement.



Delete an announcement

When you delete an announcement, it is not recoverable from Trash.

8.4.4 Widgets

Widgets are containers for a variety of content types, information, and activities.

For more information on how to design pages with widgets, refer to the About Widgets topic. It includes a list of widgets that can be used for group overview pages and custom home pages.

The widgets explained in this section are available for community home pages in addition to the ones listed in the About Widgets topic.

8.4.4.1 Name

A "Name" tile provides community participants with a space that displays their avatar, name, job title, and a link to edit their profile.

Name widget

To include a name widget

1. In edit mode for the custom area or company home page, click the Name widget icon. The name tile will automatically insert on the page.

8.4.4.2 Notification

A "Notification Summary" tile provides your users with a list of all the notifications they have for request, social updates, informational updates, invitations, and tasks.

Notification widget

To include a notification widget

1. In edit mode for the custom home page, click the Notification widget icon. The notification summary tile will automatically insert on the page.


https://help.sap.com/viewer/u_groupadmin_help/3fa1581ed85b46aa8ff6688835366e7f.html

8.4.4.3 Recent items

A "Recent items" tile provides your users with access to a list of recently visited groups or recently viewed content.

Recent items widget

To include a recent items widget

1. In edit mode for the custom home page, click the Recent items widget icon to open the widget dialog box.2. From the Type dropdown, choose to display one of the following:

○ Recently Visited○ Recently Viewed

3. Click OK to save the widget.

8.4.4.4 Recommendation

A "Recommended" tile provides your users with quick links for further engagement with people, content, or groups.

Recommendation widget

To include a recommendation widget

1. In edit mode for the custom home page, click the Recommendation widget icon to open the widget dialog box.

2. From the Type dropdown, choose to display one of the following:○ Recommended Content○ People to Follow: can include a list of people with shared connections or groups○ Groups to Join

3. Click OK to save the widget.



8.5 Import and export home pages

When importing and exporting content from the home pages of SAP Jam Communities, there are some content types and configurations that are not currently supported during the copy process. This topic lists the content types and configurations that are supported.

In the SAP Jam Communities Admin console under the Product Setup Home Page Management Import and Export Home Page tab, as a community administrator you can import or export home pages and home page content between tenants. Files are in .zip file format.

NoteBefore you import content, be sure to

● Back up any content you may need for future use.● Check that every content creator's user account permissions match between source and destination

tenants.

When you import a home page and its content, the following information displays on the Import tab:

● Imported file name and home page names● Date and time of the import● Status (for example: In progress, Import Completed)

When you import or export a community home page and its content between tenants, you can expect the following to be included when copied:

Home page and content

Location Content type, configuration, or tab

Content repository ● Folders● Blog posts● Documents (for example: .txt, .docx, .xlsx files)● Links● Images● Polls (without voting results)● Videos (mp4 files only)● Wiki pages● Tags

Pages ● Home page tabs● Sub tabs● Page settings● Row settings

Widgets ● Settings● Title translations

NoteHistorical versions, drafts, and items that are already in the trash are not exported or imported.


Import home pages

For pages and items that exist in both the zip file and the target tenant, tenant content will be moved to the trash before the zip content is imported. For example, if "budget.xls" is in the zip file and "budget.xls" also exists in the target tenant, then "budget.xls" from the target tenant will be moved to the trash before "budget.xls" from the zip file is imported.

To import home pages

1. On the Home Page Management page, click Import and Export Home Page.2. On the Import tab, click Import.3. Read the important notes and then click Import.4. Select the zip file from your local drive and then click Open.5. The zip file will be imported to the top level of your content repository. Click Import. A progress indicator

displays and let's you know when the upload is complete.

Export home pages

When you want to export a zipped file containing home pages from a tenant, from the Export tab view, select the home pages that you want to export from your current tenant. All home page items in the repository are automatically included in the exported zip.

To export home pages

1. On the Home Page Management page, click Import and Export Home Page.2. Go to the Export tab and click Export.3. Select the home pages you want to export and then click Export Home Page.4. Click Export on the confirmation dialog. A zipped file will download to your local drive.



9 Group Management and Administration

9.1 Configure and enable groups

Community and group administrators have a few tasks to complete before community participants can start working with groups. As an administrator, please refer to the table below for a list of recommended steps to help you get started with your group configuration and enablement.

Steps to configure and enable groups

Step To be completed by Task Description

1 community administrator enable group templates [page 52] To create a group, a group administrator must first select a group template from which to configure the group. The template is a layout with widgets that can be customized to suit the participation goals and requirements for the group. In the Admin console, you can enable or disable pre-built group templates, create a new group template, or import a group template from your local drive.

2 community administrator enable various features [page 111] for group

In the Admin console, you can extend the power of content by enabling features such as video and audio, a knowledge base, and the ability to designate a blog post author.

3 group administrator create group In the Admin console, you can create and manage [page 54] groups.

4 group administrator design [page 57] pages for group After you create a group, you can explore the group page layout, and insert the widgets that are required for displaying and promoting content while engaging community participants.

5 group administrator configure group settings [page 90]

From the Group Admin menu, you can review and change settings for group privacy, invite policy, and collaboration level. You can also configure group settings at step 3.

6 group administrator activate [page 55] group You can activate the group at step 3 or wait until you've completed the design and settings configuration.

SAP Jam Communities Administration Guide 1902Group Management and Administration P U B L I C 51

Step To be completed by Task Description

7 group administrator send invitations [page 97] Now that you've designed your group pages, set permissions and activated the group, you can send invitations to join the group.

9.2 Group templates

Group templates are used to replicate group content quickly and consistently. These professionally designed templates can be customized to meet your community's business needs and requirements.

As a community administrator, you can make the default group templates visible to or hidden from your entire community. You can also create custom group templates that would best serve your community's requirements. Community members can create new groups based on any visible templates.

9.2.1 Community administrator tasks

Manage group templates

To manage group templates

Go to the Admin console and select Product Setup Group Templates from the left side navigation. The Group Templates page displays, showing a catalog of community group templates.

Each template has a visibility toggle in the first column and an Actions dropdown menu in the last column. A custom template also displays the date and the name of the administrator who last modified it. The list is searchable using the search box on the top right.

To create a custom group template

1. Click Create a template near the top left of the page.2. Enter details for the following:

○ Name: [Required] The template name displays in the catalog.○ Description: [Optional] Helps an end user understand the purpose of the template.○ Language: [Optional] Defaults to "All Languages". The language the template is written in. By

specifying a language, end users will see the template at group-creation time only if it matches their individual preferred language/locale. By not specifying a language, the template is always visible at group-creation time.

3. Click Create. The <template_name> (Group Template) page displays, from which you can do the following:○ Click Group Admin settings to edit the group options.


Group Management and Administration

○ Click Create An Overview Page to use the page designer to create the overview page.

NoteA custom template can also be created by saving an existing group as a template.

4. To manage the visibility of a group template, click the visibility toggle in the first column of the Group Templates catalog.○ A toggled "check mark" switch position indicates a visible group template.○ An "x" switch position indicates a hidden group template, not available to users.

A template must be set to visible (published) before it can be used by the community users. All pre-built templates are set to visible by default, while all newly-created custom templates are not visible by default. An administrator can toggle the visibility of any template at any time in the template catalog to customize what end users see in the template selection list at group creation time. The maximum number of custom templates that can be set to visible at any given time can vary.

Actions dropdown menu

The Actions menu options include:

Group Templates catalog, Actions menu options

Pre-built, Hidden template Pre-built, Visible template Custom, Hiden template Custom, Visible template

Copy Preview Edit Preview

Copy Properties Properties

Create a Group Copy Copy

Export Create a Group

Delete Export

Available options vary according to the type of group template and whether it is set to be visible or hidden:

● Preview: Displays a preview of the group.● Edit: Opens the template in the <template_name> (Group Template) page for editing.● Properties: Shows the options set in the Create Template dialog box.● Copy: Opens a Copy Template dialog box, which is nearly identical to the Create Template dialog box,

allowing you to set a new name, description, language choice, and business record options for a copy of the group template that is otherwise identical to the source group template.

● Create a Group: Opens the Create a Group dialog box.

Import a custom template

To import a custom template, access the template catalog under Admin Product Setup Group Templates . Click Import a template, locate the zip file for the template you want to import, and then click


Upload. An email notification is sent to you once the process is complete. Any processing errors are noted in the email.

9.2.2 Group administrator tasks

As a group administrator about to create a group, you can choose a template to quickly and consistently create group content. Use page designer to further customize the layout.

All templates contain a professionally-designed overview page as well as placeholder content and group structure. For example, discussion forums that help the group owner quickly set up a group that’s optimized to address specific business scenarios.

After you select the template, you can still edit, add, and delete widgets on the layout as you would if you had designed the layout without a template.

To access group templates for a preview

1. On the global menu bar, choose Groups Create a Group .2. From the Actions dropdown, you can select one of the following templates and click Preview to see if the

template will suit your community:○ Communications group template: Drive community engagement and participation by showcasing

important content, upcoming community events, and announcements.○ Support group template: To create an efficient and useful support process, support teams can

present timely and relevant information to community members using blog posts and knowledge base articles.

If you like the preview and want to create a group immediately, click Create a group from this template.

9.3 Groups management

As a community administrator, in the Admin console you can go to Product Setup Groups Managementand access all groups for your community.

You can also conveniently manage groups where you are also the group administrator. This saves you time in navigating outside the Admin console; you can access all the groups you administer from one page view.

Manage Group Content

From the Actions dropdown, click Manage Group Content to manage your group's content, forums, and knowledge base. You can also work with Administration specific tasks such as reports, group dashboard, content approvals, group settings, and group trash.



Create a group

On the Groups I Administer tab, you can also click Create a Group to create a new group.

Enable Content Administration

From the All Groups tab (only visible to community administrators), you can click Enable Content Administration to allow administrators to access all groups and content for your community.

9.4 Create a group

Groups typically contain participants with similar projects, interests, or some other commonalities where one objective is to share information with people who were invited or approved to join a group. Group members and group administrators can create main groups. Only those designated as group administrators can create subgroups.

Create a group

To create a group

1. From the Admin console, go to Product Setup Groups Management and choose Create a Group. The Create a Group dialog displays.

2. Select a pre-designed page layout template from the dropdown menu. The templates you see may be different from the images presented in this guide as your community administrator may also publish custom templates.

3. Enter a name for your group. Choose a name that would help users distinguish your group from others.

NoteGroup names are globally unique; if there is an existing group with the same name as yours, you must choose a different name before you can proceed.

4. Enter a description for your group. It can include the group's objectives and helps to inform others who might be interested. If the group is public, the description is visible to others and they can search for the group's description. When the group is private, the description is visible to members only after they have been invited or they join the group.

5. Select the privacy level for your group:○ Public Group: any community participant who is logged in can join.


Note

In the Admin console under Product Setup Features Feature Management , the Enable Anonymous Access For Public Groups option must be enabled if you want anonymous users to find public group content on the internet.

○ Private Group: only invited users can join.6. (optional) Click Options and set the following settings:

○ Select a Collaboration Level:○ Read-only: Group administrators can share, view, tag, and download content in a group and

comment on items. Non group administrator users can view and download group content, but they are not allowed to comment, tag, post or edit. This group type is most suitable for broadcasting information only.

○ Limited: Group administrators can share, view, tag, like, and add comments on content and create tasks. Non group administrator users can post questions on forums, view, like, and add comments on content.

○ Full: Group administrators can create, edit, post, comment, like, tag, and view group content, and customize the upload policy. Non group administrator users can create, edit, post, comment, like, tag, and view group content.

○ Set Invite Policy:○ All members: All members are allowed to invite new members. This option is only available for

public groups.○ All group members: All group members are allowed to invite new members.○ Only group admins: Only the group administrators are allowed to invite new members.

○ Set Visibility Policy:○ Allow others to discover this group: The group becomes searchable to non-members, and they will

be able to see the group name and description. They must submit a request to join the group and be accepted before they can access the group content. Selecting this option also automatically selects Allow others to request to join this group. You can disable either or both options when required.

NotePrivate group discoverability is not currently supported for sub groups.

○ Allow others to request to join this group: Non-members can submit a request to become a member. Once accepted they can access the group content.

○ Set Upload Policy (if you choose the full collaboration level, you can restrict the upload policy according to your needs):○ All members: All members of your community can upload new content items. This applies to

public groups only.○ All group members: All members of your group can upload new content items.○ Only group admins: Only group administrators can upload new content items. All group members

are allowed to comment or edit content.○ Content Approval: Under Full collaboration, when group members upload documents, photos, videos,

wikis or blogs, the group administrator must first review and approve this content before it is visible in the group. This provides content publishing safe-guards to ensure content is appropriate for the business context within a group.



NoteAn Activate this group now checkbox at the bottom of the Group Creation dialog allows group creators to override the group activation default. The following defaults have been designed to support standard scenarios:○ Private groups: Activated

○ Group is automatically enabled and visible.○ Group administrators or page designers prepare layout and content, and then invite users

when ready.○ Public groups: Inactive

○ Most of the time, creators of public groups want to prepare the layout and content before members see it.

○ Users do not have to be members to see content in active public groups.○ API-generated group (for example, Account groups created for SAP CRM Accounts): Activated

○ Workflow assumption is that group is active.

7. Click Create at the bottom of the page.8. (optional) From the group's page, click Group Admin and select Edit to view group settings. You can edit the

following:○ General tab: Change the group name, enter a description, change the group type to Public, Private, or

External, set the invite policy, and select the group URL (for copying and pasting elsewhere, such as an email or wiki page).

○ Setup tab: Enter a Terms of Use user agreement, create a welcome announcement, set the group avatar, select the group navigation style, indicate whether the Overview page displays as the landing page, specify the default calendar view (as in: month, week, day, list), under Customize what is available in this group, enable or disable various navigation sections (for example: Content, Events, Forums, Knowledge Base), and enable external folders for integrated applications.

○ Participation tab: Set the collaboration level (as in: Read-only, Limited, Full) and task policy (i.e., Read-only, Limited, Full). Enable @@notify so users can send notifications to all group followers. You can also disable @@notify to help minimize unwanted notifications in large groups. Enable Content Rating allow users to rate group content.

NoteIt is possible for group administrators to change the group privacy level to Public or Private after a group has been created.

On the group page, when uploading an image for the group avatar, you can now rotate, pan, and zoom into the image or enable Auto fit so the image is sized to fit within the crop box without stretching or pixelation. When you are done, you can preview before saving the image.

9.5 Design a group with page designer

After you create a group, you can work with page layouts for presenting group content and information.

The page designer enables you to add and organize the layouts in your group overview pages by using widgets in a page editor. Widgets provide a way for you to collect and share information from colleagues, customers, or


other members within the group. For example, you can use the Event widget to allow customers to register for an event, create a question and answer forum for product experts and interested consumers with the Forum widget, or show a link to a product demonstration video with the Video widget.

The drag and drop convenience in the page designer enables you to create pages without any knowledge of HTML. You can add, move, resize, align, configure widgets, and modify the overall layout of a page. As you design a page, your work is automatically saved so that you don't lose your changes prior to publishing or saving as a draft. The Overview page is also searchable. Content on the Overview page (such as text widgets, widget titles, and widget captions) is indexed and searchable using the global search box.

Getting started with page designer help

● To switch to page designer view while you are in regular page view, select the page tab that you want to work on and then click Edit from the Page Settings wand.

● To move a widget, click it, drag, and drop it in the preferred location on the page.● To delete a widget, click the "X" icon on the top right hand corner of the widget.● To edit a widget's property, click the edit icon on the top right corner of the widget.● To show page designer tips, click the information icon that displays in Edit view, above the Publish, Save

Draft, Delete Draft, and Cancel buttons.● To save a draft of the page without publishing it, click Save Draft.● To display your completed page to the group, click Publish.



Publish and save draft actions

9.5.1 About widgets

Widgets are containers for a variety of content types such as video, feeds, and photos. When you add a widget, you are specifying that a section, whether for group overview pages or custom community home pages, contain some particular content. You can insert, remove, edit, and reposition widgets as needed.

The following is a table of all widgets (follows the icons shown in the web app from left to right), what they are used for, and the settings associated with each widget type.

Type Purpose Settings

Multimedia Show a link to an external audio or video file, display multimedia saved to the group content library, or a group playlist.

Source: Enter a multimedia link (as in, URL for YouTube or Vimeo, embed code for SAP Jam or Kaltura video, select an existing multimedia file from the group content library, or choose a playlist.

Image Select an image from a local computer folder or directly from the group content repository.

Widget Title: Free textAdd an image hyperlink: Enter a URL to make the caption a clickable hyperlink; the link will launch in a new browser tab.Caption: A label that appears on top of the image.Caption Layout: Inline or Overlay; Left, Center, Right

Text Insert and format text within a rich text editor. Can also include tables and lists.

Title: Free text

Search Search all content for the group. Title: Free text

People Show a list or carousel rotation of group members based on a selected filter.

Filter by: Most Active, Featured, Recently Joined, Most Endorsed, SelectedLayout options: Carousel, ListMaximum number of items: 25Title: Free text

Feed Insert activity feed based on selected filter.

NoteOnly for group overview pages.

Feed event filter: All Feed Events, Content Updates Only, Forum Events Only, Group Status OnlyLayout options: Standard, Emphasized (for bold broadcasting of events that meet a specific, customizable tag criteria)Title: Free textMaximum number of items: 25



Filter by tag: Filter by one or more hash tags. Multiple tags aggregates content with any of the listed tags associated with it, does not equate to filtering for only content associated with all of the tags listed (‘or’ selection operation, not ‘and’ operation)

Content Show content such as documents, blog posts, videos, images, links, and much more.

Layouts: List, Carousel, Gallery, ThumbnailType: Filter to Featured only, or sort by Content by Title, Last Updated, Most Replies, Most Viewed, Most Liked, Most Rated, Highest RatedMaximum number of items: 25Select Folder: All Content, or select folder to show content fromFilter by type: All, All Files (uploaded content only), Blogs and Wikis, Decision Making Tools, Documents, Folders, Images, Planning Tools, Videos, WikisFilter by tag: Filter by one or more hash tags. Multiple tags aggregates content with any of the listed tags associated with it, does not equate to filtering for only content associated with all of the tags listed (‘or’ selection operation, not ‘and’ operation)Title: Free text

Forum Show questions, ideas, and discussions. Filter by: All, Questions only, Ideas only, Discussions only, Topics onlyMaximum number of items: 25Topic Filter: All Topics, or restrict to a specific forum topicSort by: Last Activity, Most Replies, Most Likes/Votes, Most ViewedFilter by tag: Filter by one or more hash tags. Multiple tags aggregates content with any of the listed tags associated with it, does not equate to filtering for only content associated with all of the tags listed (‘or’ selection operation, not ‘and’ operation)Title: Free text

Groups Show links to related groups or subgroups. Title: Free textType: UserDefined or SubgroupsGroups: Type-ahead search box with ability to select from results

Action Show a list of popular actions for the user to choose from.

Actions to display: Ask a Question, Add a Discussion, Add an Idea, Upload a File, Record a Video, Post on the Group Wall, Create an Event, Add a Wiki, Add a Blog Post, Add a Wiki, Add a Task, Add a Playlist, Invite someone to this groupTitle: Free text

Tag Cloud Show list of most popular tags for the group.

Title: Free textMaximum number of items: 25




Slideshow Show Microsoft PowerPoint presentation files.

Choose a slideshow that has been uploaded to the group content folder. You can click Edit to enter a title for the widget.

Event Show an upcoming or recent event. Filter by: Upcoming Events, Recent EventsCategory: All, Brainstorm, Conference, Meeting, Milestone, Other, Social, Training, Webinar, UncategorizedFilter by tag: Filter by one or more hash tagsMaximum number of items: 25

Rotating Banner

Show up to 10 rotating images that can highlight important announcements, topics, and events.

+ Slide: For each slide, include an image, link the slide to existing content or a hyperlink, enter title, description, and then select where the text should be placed (as in: bottom left, bottom right, top left, or top right)

Knowledge Base

Shows list of published knowledge base articles.

Type: Featured, Article by Type, Last Updated, Most Replies, Most Viewed, Most Liked, Most Rated, and Highest Rated.

Layout: List view.

Maximum number of items: 25.

Filter by category: Choose one or more categories to filter the list of articles that display.

Filter by tag: Filter by one or more hash tags.

Title: Free text.

Add, Move, Delete, or Edit a Widget

To add a widget anywhere it is allowed on a page, click the corresponding Add Widget button.

By default, a widget is added to the bottom of a column. It can be moved easily elsewhere on the page.

● To move a widget, simply click, drag, and drop.● To delete a widget, click the X on the top right corner of the widget.● To edit a widget's property, click the edit icon on the top right corner of the widget.

There is no need to position any “cursor” for insertion and deletions on a page. In the page designer, cursor placement is now only relevant when editing the contents of a text widget.

9.5.1.1 Multimedia widget

When you insert a multimedia widget, you can copy and paste an link to a video from YouTube, Vimeo, or your group, embed code for Kaltura videos, select an existing multimedia file from the group content folder, or


choose an existing playlist. When the group member views the page, they will be able to play the audio, video, or playlist within the same page.

You can also provide a name for the multimedia file or playlist.

Multimedia playlist

NoteYou can view, select, and search for audio and video files in the main group, but not the subgroup.



Kaltura videos in playlist example


Select existing content from the main group

The "Restrict modification to the creator and group admins" option, when selected, only allows the content owner and group administrator to make changes to the video.



Example of multimedia widget with video as viewed on group overview page

Kaltura videos

To include Kaltura videos on video.sap.com into a playlist, you must click the Share Externally tab and then include the Embed code from the Share Externally tab into the playlist.

NoteIf you use the Embed code from the Share tab, an error message displays recommending that you share the video externally and use the embed code from the Share Externally tab. Direct URLs are not supported.

HTML 5 support

Video playback with HTML5 is supported for Microsoft Edge and non Microsoft Internet Explorer browsers (for example, Mozilla Firefox, Google Chrome, Safari, iOS Safari, Android browser, and Android Chrome). Code embedding for HTML5 videos is supported for wikis and overview pages. Switching videos between high definition and standard definition is supported with HTML5.


9.5.1.2 Image widgetWhen you insert an image widget, it allows you to choose an image that can be viewed by a group participant.

There are three options for uploading an image:

● Drop an image to upload: You can click and drag an image file from a folder on your computer into the widget space. The minimum acceptable height is 45 pixels.

● Click here to select an image: You can click the link to browse for an image file on your computer.● Click here to choose an image from this group: You can click the link to browse for an image that was

previously added to the group space.

Image widget

Once you add the image, you can click the pencil icon on the image formatting toolbar that appears when you place you cursor over the top right corner of the image. The toolbar includes actions for adjusting the scale, clearing, editing (as in, widget title, image hyperlink, caption, inline or overlay left, center, or right caption placement, and caption background opacity), and removing the image widget.

Image formatting toolbar

NoteImage captions use a white font color. Using a dark colored image to contrast the text works best. If your image is light colored, adjust the opacity of the caption background to achieve the optimal effect.

To easily replace an image within an image widget while preserving its position on the page, you click the Clear icon to remove the image rather than clicking the X to delete the widget and then inserting a new widget with a new image

NoteBy default, small images (as in, more narrow than the column it is placed in) can be scaled to fully fit the column. It can also be centered with whitespace on either side. With centering however, zooming, panning and cropping actions are unavailable.



When you click and drag the bottom edge of an image widget to resize it, a guideline appears to help you align the edge with another image-based widget on the same row. As you drag the guideline, it will automatically snap to the bottom edge alignment matching the other widget.

The image opens within the same page.

Embedded images

Images can be embedded within image, rotating banner, and catalog search widgets. Those images are "bundled" as part of the group overview or custom home page and cannot be searched or browsed for independently.

Content repository images

When your image, rotating banner, or catalog search widget uses an image that already exists in the content repository, and you update that image by uploading a new version, the image is also automatically updated in those widgets.

Image album browser

When images are uploaded to the same Content folder, as you select a single image item to view for a group or via another user's profile wall, album browser actions are enabled to allow you to click through to next and previous images. You can also use the left and right arrows of your keyboard to browse the images.

9.5.1.3 Text widget

When you insert a text widget, a text editor displays where you can enter content such as text, lists, simple tables, and URL links. A formatting table is available for you to select fonts, colors, spell check, and other commonly used features for text editing. Entering a text name for the widget is optional; click the pencil icon that appears when you hover the cursor over the right side of the text box.

You can also copy and paste content from other sources into this text editor.

NoteWhile you can copy and paste images from external resources or web pages, some users may not be able to see these images. If you upload those images to the group, this ensures that all group members have visibility.


Text widget

Example of text widget with title as viewed on group overview page

Hyperlinking images

If you are using the text widget as a means of creating hyperlinked images, please note that the Text field in the URL tool is currently disabled for images. While you can insert a hyperlink, the text that appears when you hover over the image will say "Image" by default.

Insert links

From the rich text toolbar, you can choose Insert Link and enter text that you want to hyperlink to any of the following:

● People, groups, or documents● A new document● Other content● A forum topic● URL



Insert link

9.5.1.4 Search group widget

When you insert a search widget, you enable the group member to use a search text box to search the group pages. They can enter their own text, or type a few letters and then choose a suggestion if available from the dropdown list. The list of suggestions that appear in the dropdown list are based on titles or names that match the search criteria. Any other matching search results will appear on a "Search Results" page. Only one search widget is allowed per page.

You can set the following details:

● Widget title: Enter a name for the search box, or accept the default "Search".

Search widget● Hint text: Enter text that can help the user when entering criteria.● Include border overlay: You can choose the color, opacity, and thickness for the border.


Example of search widget on group overview page, with matching results in dropdown list

9.5.1.5 People widget

When you insert the people widget, you enable group members to view a photo gallery of other group members based on a specific category or intentional selection.


● Filter by: Select the list of members to display (for example, most active, featured, recently joined, most endorsed, and selected members). When you filter by featured members, you can sort by name, most recently featured, and most recently joined.

NoteIf you are designing a custom home page, you select specific users to display.

● Select layout: A list displays member photos at the same time. A carousel displays members, one at a time, in a constant rotation.

● Select maximum number of people: You can choose to set a maximum between 1 and 25 members to display.

● Widget title: You can enter a name for list or carousel, or accept the default (as in, the name of the member list that your previously selected).



People widget

If you choose to select specific members then1. From the Filter by dropdown menu, choose Selected Members.2. Click Select.3. To select a member, do any of the following as required:

○ Use the Filter by name or email box to enter the partial or full names of the members.○ Select up to 25 members from the list.○ Select or delete individual members from the list.

When you select specific members you can see a list of those you selected while in page design mode. You can drag and drop members to reorder the list of how they appear in the widget.


Select members4. Click Done to save your selection.5. The list of members you selected will display in the People Widget dialog. If you want to remove them,

place your cursor over the row with their name until you can see the X; click it to delete.When you choose the "Featured Members" filter, or "Selected Members" filter and you select a member that has been previously featured, the member's name as well as any featured text displays. If the member has not been featured, or they have been featured but without a specific message, then their name and job title displays in the widget.



Example of people widget, carousel style, as viewed from the group overview page

9.5.1.6 Related groups widget

When you insert a related groups widget, you enable group members to click links to view other groups.

You can set the following details for related groups:

● Widget title: Enter a name for the content section or accept the default name provided by the selection in for Type.

● Type: Choose to display subgroups that belong to the main group or create a list of groups that you want to show.

● Groups: If you've chosen to create a list of groups, enter the group name and click to select each group.


Related groups widget

Example of related groups as viewed on the group overview page



9.5.1.7 Tag cloud widget

When you insert a tag could widget, you enable group members to view the most popular tags used by and within their group. The most popular tags will display in a larger font size.

You can set the following details for the tag cloud:

● Widget title: Enter a name for the cloud or accept the default name, "Popular Tags".● Type: Choose "Selected Tags" when you want to limit the tag cloud widget's display of tags based on a

specific selection of up to 200 tags. Choose "Most Popular Tags" from when you want to also exclude specific tags from the set.

● Maximum number of items: Click and drag the scale slider to set a maximum between 1 and 200 tags to display when you select "Most Popular Tags".

Tag cloud widget with most popular tags


Selected tags in tag cloud widget

Example of tag cloud widget with three popular tags displayed on the group overview page

On the page view, the widget displays with an information icon. When you place your cursor over it, it shows the maximum number of popular tags that can display. As you hover over the tags, the number of times the tag has been used will appear. By clicking on the tag, a list of search results will display to show the items using that tag.



Example of tag search results

9.5.1.8 Slideshow widget

The slideshow widget allows page designers to choose one presentation (Microsoft PowerPoint format or PDF file) from the group Content repository to display in the widget. Group members can preview the slideshow within the widget, jumping to specific pages or browsing from slide to slide, before they choose to engage further with it by viewing in a light box view and posting comments.

NoteIf the slideshow is removed, in a folder that you don't have access to, or does not upload completely, you will see a message on the group page indicating that the slideshow is unavailable.

Slide widget

To include a slideshow, click to browse a group content folder for the Microsoft PowerPoint or PDF file. If you want to enter a title for the slideshow widget, after you select the slideshow, hover your cursor to the right of the widget and click the Edit icon. The Widget Title text box displays.


Example of Slide widget on group overview page

9.5.1.9 Event widget

When you insert an event widget, you enable the group member to view a current and recent list of events. A member can also click Go To Events near the bottom of the widget to add a new event.

You can set the following details for events:

● Select group: Community administrators have the option to select a public group with scheduled events.● Event type: Choose to display upcoming events in ascending order by date or recent events in descending

order by date.● Category: Choose a color-coded category to help the group member visually identify the type of event (for

example, brainstorm, conference, meeting, milestone, other, social, training, webinar, uncategorized, or custom event).

● Priority: Choose to display events of high, normal, low, or all priorities.● Maximum number of items: Click and drag the scale slider to set a maximum between 1 and 25 event

items to display.● Filter by tag: Enter text that refines what appears in the events list; one or more tags are allowed, comma-

separated.● Widget title: Enter a name for the events list or accept the default name provided by the selection for event

type.



Event widget

Example of event widget as viewed on the group overview page

For an event that is scheduled over multiple days, it displays as a single event instead of a separate event for each day it's held.

9.5.1.10 Rotating banner widget

A carousel-style rotating banner widget can be used to display announcements or headlines in a visually prominent way with up to 10 slides contained in a single banner that automatically rotates through the image sequence every few seconds. Users can click "next" and "previous" to move through the slides, or let the slides in the banner automatically advance to the next one in the sequence.


Rotating banner widget

To include a rotating banner widget

1. In edit mode for the page, click the Rotating banner widget icon to open the widget dialog box.2. With the first slide selected, include an image by using drag and drop, clicking the first link to upload an

image, or clicking the second link to select an existing image stored in the home page content folders. Once you include an image, you can zoom in or zoom out using the image scale bar, click and drag the image within the box, and you can click the Center/Scale to Fit button on the top right side to center or scale the image. The minimum height is 270 pixels and the maximum is 500 pixels. For custom home pages, the width size for a○ 4 column-wide banner is 1180 pixels○ 3 column-wide banner is 883 pixels○ 2 column-wide banner is 585 pixels○ 1 column-wide banner is 288 pixels

Note○ When added, images are automatically cropped and resized. You can then manually scale each

image. As you resize the height for one image, the other slides in the banner will also apply the new image height dimension.

○ For mobile devices and responsive view, the rotating banner widget behaves similar to the image widget where images are scaled to fit the width of the device, preserving the aspect ratio, and without cropping. Any titles or description are also scaled to fit the device width, and truncated where necessary to fit the underlying image.

Example: Scale to fit

NoteWe recommend that all images used for a rotating banner widget have the same image dimension (height and width). For example, avoid mixing extremely wide and tall images as that will result in undesirable auto zooming and cropping. Multiple heights and whitespace are not permitted.

3. In the Link content to section, enter a URL hyperlink that will open when the image is clicked, or choose existing content from the home page repository. When you choose existing content, the title of that file will automatically fill the Title field.

4. In the Title field, you can keep it blank, enter new text, or accept the default text based on the previous step.



5. In the Description field, enter some text to describe or accompany the Title. The description will display directly below the title.

6. Choose where you want to place the text:○ Bottom Left○ Bottom Right○ Top Left○ Top Right

7. On the left side of the panel, click + Slide to add a new slide and repeat the previous steps. The sequential order of slides can be re-arranged using click and drag for each slide.

NoteIf you want to delete a slide from the banner rotation, click the x beside the slide on the left.

When you click and drag the bottom edge of an image widget to resize it, a guideline appears to help you align the edge with another image-based widget (for example, image widget for group overview pages and catalog search and rotating banner widgets for custom home pages) on the same row. As you drag the guideline, it will automatically snap to the bottom edge alignment matching the other widget.

In group overview or home page view, an indicator displays to let you know which slide you are viewing in a series. When you click a slide, the link to existing content will open in a dialog box, or a new browser tab for external SAP Jam content.

Embedded images

Images can be embedded within image, rotating banner, and catalog search widgets. Those images are "bundled" as part of the group overview or custom home page and cannot be searched or browsed for independently.

Content repository images

When your image, rotating banner, or catalog search widget uses an image that already exists in the content repository, and you update that image by uploading a new version, the image is also automatically updated in those widgets.

9.5.1.11 Knowledge base widget

When you add a Knowledge Base widget, knowledge base articles that are available to all group members are shown. You can configure the widget's title, type, number of items to display, and tags.


● Type: Select the type of knowledge base articles to display (for example, featured, article by type, last updated, most replies, most viewed, most liked, most rated, and highest rated).


● Select maximum number of items: You can choose to set a maximum between 1 and 25 articles to display.

● Filter by category: Choose one or more categories to filter the list of articles that display.● Filter by tag: Enter text that refines what appears in the list of knowledge base articles; one or more tags

are allowed, comma-separated.● Widget title: You can enter a name for the widget, or accept the default (for example, "Featured Articles").

List view layout is currently supported for this widget.

List view layout

9.5.1.12 Poll widget

To increase awareness and visibility of a poll, as an administrator, you can add a poll widget to a community or group page that references an existing poll created within the community or group.

Users can add or change their vote, view poll results, and see when a poll is due to close directly within the widget.

To include a poll widget on a home page, area page or group overview page

1. In page designer mode, click Add Widget.2. From the Standard Tools section, select Poll.3. In the Poll Widget dialog, enter a widget title.4. Select a poll from the content list.5. Click Add.



Select a poll for the poll widget

9.5.2 Add a widget to a page

To make the most of page designer, it's recommended that you plan your design first by performing an inventory on the types of content and activities that the group members will be working with. Once you have that information, you will be able to add widgets with ease and efficiency.

To add any widget to a page

1. Go to the Overview section and select the group page tab.2. In the page designer view, click Edit.3. Click Add Widget or the + icon to view the pop-up widget menu. As you place your cursor or focus over

each widget, you can view information that explains its purpose.4. Click the widget you want to insert on the page.5. A settings dialog appears for that widget. Enter or select the settings and then click OK if available for that

widget.6. Once you've finished working with a widget, click Save Draft to save your settings.7. When you complete all your changes and additions, click Publish to make the page accessible to group

members.


9.5.3 Add rows and columns

You can edit the page layout while you are creating a new page or after its creation. You can add a maximum of three columns within a row and one row within a column. A page can have several rows, however this may cause the user to scroll vertically to view and access all the page content.

To add a new row or column in page designer view

1. Click the + icon on the vertical or horizontal edge nearest to where you want to add the row or column. For example, if you click + on the left side edge of a row or column, the widget is added to the left. If you click + on the top edge of a row or column, the widget is added above the current widget.

Add rows and columns

9.5.4 Adjust column width

Column widths can be adjusted within two-column rows. The following column sizes are allowed: 240px (1 standard column), 300px, 360px (2 equal columns), 420px, and 480px (2 standard columns).

To adjust the width of a column

1. Place your cursor over the left or right border of the column until the cursor changes to the resize arrows.2. Click and drag the border to the left or right as needed. The other widget in the column will automatically

resize and align itself within the column.

9.5.5 Delete rows and columns

You can edit the page layout while you are creating a new page or after its creation. Rows and columns can be deleted once widgets have been removed.

To delete a new row or column in page designer view

1. If there are widgets contained within the row or column, place your cursor or focus on the rop right corner of the widget and click X to remove. You can only delete a row or column after you delete all widgets from that area.



2. Place your cursor or focus on the top right corner of the column or row and click X to remove the row or column.

Delete row or column

9.5.6 Save or delete draft

You can save a draft of the page tab you are working on before publishing for all group members to see. If you change your mind and do not wish to save, you can also choose to delete the draft.

To save a draft of your page

1. If the Title text box is blank, enter a title for the page.2. When you are finished making edits to your page, click Save Draft beside the Title text box. The page will be

saved and added as the last page. If it has never been published, the page tab name will appear in italics and the message "This page is a draft and has not been published yet" appears.

If the page has been previously published, you will see the message "This draft has not been published yet." with a hyperlink to view the published version.

To delete the draft

1. Go to the draft version of the page by clicking the page tab and selecting View draft version.2. On the yellow banner with the message "This draft has not been published yet", click Delete Draft.3. On the confirmation dialog, click OK to confirm your draft deletion.

9.5.7 Publish a page

When you publish a page, you are enabling group members to view and work with a completed version of the page.

To publish a page

1. When you are finished making edits to a page, beside the Title text box, click Publish.2. The Publish dialog displays. You can accept the default option, Show in Feed Updates, if your edits were

significant and you want to inform group members via the feed that the page was updated. Or, if the edits were not as significant, you can disable that option and the update will not appear in the feed.


3. If it's a major change, enter some comments to describe the changes. This information will display in the feed and version history.

4. Click Publish. You can view the assigned version number when you click Versions.

9.5.8 Edit a page

You can edit pages for a group within page designer. Edits can include updates to selected widgets, rearranging their presentation, or adding and removing content to name a few.

To edit a page

1. On the group page, click the page tab that you want to edit.2. Click the Page Settings wand and then click the Edit icon.3. Proceed to make your changes.4. Once you have completed your changes, click Save Draft or click Publish if you are ready to display the

page to group members. If you no longer want to save a draft of or publish the version, you can click Cancel.

9.5.9 Rename a page

Page tabs can be renamed as you work on a draft or even after it's been published. The new page tab name appears when you save the draft or publish it. If you revert to a version prior to the name change, you will see the previous page name when it's published.

To rename a page tab

1. From the Overview section, click the page tab you want to edit, and then from the Page Settings wand, click Edit.

2. Below the "Edit Overview Page" header, enter the page name for the page tab. The page will be auto-saved with your latest name change.

3. Once you are finished your changes, click Publish or Save Draft to save a version of the page tab with the new name.

9.5.10 Page versions

After you create and edit group pages, versions of your work are stored. You can view previous saved versions of your pages, see when it was last updated, and also view the name of person who last updated it. You can also revert to a previous version to make it the latest version.

To use the Versions feature

1. Select the tab you want to view version history for, and then click Versions from the Page Settings wand. The Version History pop-up displays.

2. To view a particular version, click the version and number under the Version column.3. The Overview page appears with a banner message to indicate which version of the saved changes you are

viewing.



4. If you want to undo your most recent changes on a selected page tab and go back to a previous version, click Revert to this Version on the blue banner.

5. Return to the Version History dialog by clicking Versions. Notice that another version has been added to the history; this is the reverted version.

6. Click OK to close this window.

9.5.11 Copy a page

To save you time and effort in designing similar pages for one or more groups, you can use the Copy action to make a copy of an existing published page. The layout and all the widgets will be copied. You can then select the page and make changes as necessary.

To copy a page

1. Select the page tab that you want to copy. A blue bar underlining the page tab name will indicate that it has been selected.

2. Click Copy from the Page Settings wand. The Copy To pop-up displays.3. Enter a new title for the page tab and choose the group that you want the page copied to.4. Click Copy. A "page copied successfully" message displays. You can click View Page to look at the copied

group page or click Close. The copied group page appears as the last page tab.

NoteWhen copying a group overview page, ensure that you update any image, multimedia, and slideshow widgets to reference content belonging to the group you've copied the page to.

9.5.12 Delete a page

You can remove any and all pages for a group. If you've deleted a page in error, the page can be restored by the group administrator.

To delete a page

1. In page designer view, click the page tab that you want to remove and click Delete from the Page Settings wand.

2. A confirmation message displays. Click Confirm to confirm the page deletion. The page is moved to the "Trash" section where it can be restored or purged.

9.5.13 Translations

When you create or edit an overview page and supply text, the text is considered untranslated. To support communities with users who understand multiple languages, you can provide translations for individual text for


image captions, menu tabs, text widgets, and widget titles in one or more languages supported by SAP Jam Communities.

Translate menu tabs, text widgets, widget captions, and widget titles

To translate elements of the group overview pages

1. On the group overview page, click Translate from the Page Settings wand.2. Select the language you want to work in for your translations from the Language dropdown.3. Click the Translate icon on the top right corner of the individual images and widgets and then enter the

translations to the widget captions and widget titles on the Translate dialog.

Translate the widget title4. Enter the translations for the menu tabs at the top of the overview pages, to the left of the Publish and

Cancel buttons.5. Enter the translations for the content of the text widget.6. Repeat all the previous steps for all other languages you wish to translate, and then click Publish. This

creates a new version for your overview pages. If you are not ready to publish your translations, you can save your work in Draft mode.

If a translation is unavailable, the non-translated locale that was used when creating or editing the page displays. A user will see the translations based on their preferred language setting. If their preferred translation is unavailable, they will see untranslated text.

Similar to saving an overview page or custom home page as a draft, you can also save translations as a draft. Draft translations are not visible to end users. As a group administrator, you can view either draft translations or published translations. You can resume editing a draft, delete a draft, or publish a draft. Each time you publish a translation, a new version of the overview page is created in the version history.

When you click Publish to publish the translated overview page, this creates a new version. You will be prompted to enter a comment about your changes relating to translation, or you can accept the default prefilled comment indicating that this version update is due to translation.



9.5.14 Dimensions

Understanding the dimensions of group pages and their components can help you when designing widgets and placement of images.

Overview pages in full width resolution

● Overview full page width: 880 pixels.● Overview page by column:

○ 270 pixels per column with pixel padding width of 20 between columns 1 and 2 and 2 and 3.○ Margins on both sides are 20 pixels each.

Widgets containing images

● Suggested image size: 267.8 pixels for 1 column widget

9.5.15 Mobile settings and preview

As a group or community administrator responsible for designing page layouts to display content and information, you can enable or disable widgets as needed for viewing within a single column on a mobile device.

Show widgets in mobile view

When designing the view of group pages on mobile devices, you should decide which widgets will display best in a single column layout. For example, for custom home pages viewed on a laptop browser, rotating banner widgets that use a larger amount of the screen may display better than they would than on the more compact screens of the mobile browser. You could then disable the "Show in Mobile" toggle for the rotating banner widget.

To designate which widgets to display in mobile view

1. In Edit mode for your group overview, area, or custom home page, hover your cursor over the top right corner of the widget title to see the toolbar.

2. Move the Show in Mobile toggle so that the check mark displays, indicating that it is enabled. You can always switch the toggle to disable it.

3. Repeat the steps above for all widgets you wish to show or hide.4. Click OK to save your settings.


Pin widgets to the top of screen for mobile view scrolling

After you've decided which widgets you'd like to display in mobile view, you can then choose which of those widgets should display closest to the top of the screen for immediate visibility. You can also re-order them.

To pin the displayable mobile-view widgets to the top of the screen

1. In Edit mode for your group overview, area, or custom home page, hover your cursor over the top right corner of the widget title to see the toolbar.

2. Move the Pin to Top toggle so that the check mark displays, indicating that it is enabled. You can always switch the toggle to disable it.

3. Repeat the steps above for all widgets you wish to show at the top.4. Click OK to save your settings.

Reorder widgets and Preview mode

In edit mode, you can switch to a preview mode of the single column layout for mobile devices. You can also re-order your pinned widgets to set which ones display from top to bottom.

To preview and reorder widgets for mobile devices

1. In edit mode or your group overview, area, or custom home page, click Preview in mobile at the top of the page. A preview dialog box displays.

2. Scroll down to view the pinned widgets.3. Hover your cursor over the top right corner of the widget to see the up and down arrows. You can click

those arrows to move the widget up or down as needed.4. Click OK to save your pinned widget order.

9.6 Edit group settings

Group administrators can enable and configure a variety of settings that determine how group members can engage with their group. There are three tabs that the group administrator can work with:

● General: Includes basic attributes such as name, description, and group type.● Setup: Includes terms of use, group avatar, calendar view, left navigation menu configuration, trash

settings, and administrative area.● Participation: Includes choice of collaboration level, upload policy, content approval by selected group

members for feed posts, forum posts, and different content types, default email notification settings, task policy, @@notify usage, and content rating.

NoteYou can only change a group's details if you are the group administrator of the respective group.



9.6.1 General

Use the General tab to configure the basic settings for your group. For example, name and description are the first things about a group that community users will see.

General settings

To edit general settings

1. From the navigation, click Group Admin > Edit Group. The Edit Group page appears, defaulting to the General tab.

2. You can edit the following attributes:○ Name: Modify the group name by changing the text and then checking to see if it's unique by clicking

Check Group Name.○ Description: Enter a brief but meaningful description that will help everyone recognize the purpose of

your group.○ Group Type: Choose from one of the following:

○ Public: Anyone within your community can view and join your group.○ Private: Only invited participants can join your group.

○ Invite Policy: Choose from one of the following:○ All Group Members: Any group member can send an invitation to join your group.○ Only Group Admins: Only group administrators for your group can send invitations to join your

group.○ Visibility Policy:

○ Allow others to discover this group: To make the group searchable and found in search results by non-members, you can select this option. It also automatically selects Allow others to request to join this group. You can disable either or both options when required.

NotePrivate group discoverability is not currently supported for sub groups.

○ Allow others to request to join this group: Non-members can submit a request to become a member. Once accepted they can access the group content.

If sending the invitation outside of this application (for example, in case you want to send an invite using your email), you can click Select Group URL Text and copy and paste the URL into your custom invitation.

3. Click Save changes when you are done.


9.6.2 Setup

Use the Setup tab to configure the functional appearance of the group, settings for trash and purge, whether to display the Overview page or feed updates as the landing page, and an SAP Jam Collaboration group for content syndication.

Setup settings

To edit Setup settings

1. From the navigation, click Group Admin > Edit Group. The Edit Group page appears, defaulting to the General tab.

2. Click the Setup tab.3. Configure the following properties:

○ Terms of Use: Create custom Terms of Use that must be accepted by the member before they are granted access to the group. When the terms change, members must read and accept the new terms before they can continue on to the group.

○ Announcement: Create a welcome message or user agreement for all group members to see on their first group visit.

○ Current Avatar: Upload a group picture for the group's main page. The maximum size for a group image is 110 x 110 pixels. Group avatar images of narrow size are not stretched and pixelated to fit the dimensions of the avatar space. They appear in their original size with white padding surrounding the remaining area of the maximum avatar space.

○ Navigation: Choose to display the group navigation menu in a full header or a condensed basic header:○ Full: Includes group avatar, group name, navigational dropdown for all group pages, group actions

(pin groups, group member actions, email notification settings, group administrator settings, and group information (description, public or private setting, number of members)

○ Basic: A minimal display to allow for more of the group page content to display below the header. Includes group name, navigational dropdown for all group pages, Invite action, and More dropdown containing group member actions, email notification group administrator settings, and group information. There is also an information icon that displays group metadata such as public or private status and number of members.

○ Overview Page as landing page: When selected, the Overview page will display rather than the group's feed.

○ Default Calendar View: Choose from month, week, day or list view.○ Customize what is available in this group: Select the features you want enabled for the group.

○ Recommendations section: In a tiled view, lists recommended content based on featured content, highest ratings, most likes and views, for the current month, week, or current day. It can also display the group's featured members and most active members.

○ Content Section: Depending on participation settings, members can view, upload, create, copy, mirror, move, and delete content items.

○ Events Section: The group calendar displays the current month's events. Members can scroll the calendar or change their view to week, day, or list, set the time zone and first day of week for the calendar, and create new events.

○ Forums Section: Lists forums for members to ask questions, start discussions, or present ideas.



○ Knowledge Base Section: By default, the knowledge base feature is enabled for a group when the community setting for the knowledge base feature is enabled. As a group administrator, you can enable or disable the availability of the knowledge base feature for your group when editing the group settings. Lists existing knowledge base articles, allows group members to create new articles, and creation of custom templates. Community administrators can also enable or disable this feature community-wide. If knowledge base articles are enabled for a community, then knowledge base articles can be accessed via the global menu bar. If you disable the knowledge base feature after knowledge base articles have been created and published for the group, the articles will no longer display in the group and community knowledge base. The community knowledge base continues to display unless disabled by the administrator.

○ Add external group: External groups from SAP Jam Collaboration can be selected for content syndication.

○ Trash: Set an automatic purge for items that have been in Trash for a specified number of days.4. Click Save changes when you are done.

9.6.3 Participation

Use the Participation tab to specify the degree to which group members can collaborate, which sets of members can upload content, what content requires approval and which members can approve, how often members are to receive email notifications from the group, who can update or edit tasks, and enablement of @@notify and content ratings.

Participation settings

To edit participation settings

1. From the left side navigation, click Group Admin > Edit Group. The Edit Group page appears, defaulting to the General tab.

2. Click the Participation tab.3. You can edit the following participation settings:

○ Collaboration Level: Specify the degree of social collaboration for group admins and users.○ Read Only:

○ Group administrators can share, view, tag, and download content in a group and comment on items.

○ Non group administrator users can view and download group content, but they are not allowed to comment, tag, post or edit.

○ This group type is most suitable for broadcasting information only.○ Limited:

○ Group administrators can share, view, tag, like, and add comments on content and create tasks.

○ Non group administrator users can post questions on forums, view, like, and add comments on content.○ Move action: Users cannot move content within or outside of a group with limited

permissions.


○ Mirror action: Users can mirror a document from a limited group to another group that they can access. Mirroring a document within a limited group is not allowed.

○ Full :○ Group administrators can create, edit, post, comment, like, tag, and view group content, and

customize the upload policy. Creation and management of folders is restricted to the group administrator.

○ Non group administrator users can create, edit, post, comment, like, tag, and view group content. When uploading content or publishing new content, the upload file permissions automatically default to Limited so that edits are restricted to users and any group administrator for the group.

○ Upload Policy If you choose the full participation setting, you can restrict the upload policy according to your needs:○ All Members: All group members and group administrator can upload new content○ All Group Members: All group members can upload new content items.○ Only Group Admins: Only the group administrator can upload new content items. All group

members are allowed to comment or edit content.○ Content Approval: This provides content publishing safe-guards to ensure content is appropriate for

the business context within a group. You can choose whether the same approval policy applies to all content, forum and feed posts, or apply specific approval policies to each item.For each approval policy, you must indicate the member type (e.g., any selected group member, all selected group members, or any group administrator) that can approve and then select specific members (Select members) as approvers. You may need to select multiple approvers for different reasons: one approver serves as a back up in case the other approver is away when "any selected group member" can approve, or all selected subject matter experts are required to review various parts of the content before it can be published to a wider audience.If you need to remove a selected approver, click the x beside their name.If no approval policies are required, select "None." Otherwise, you can select one of the following types of approval policies:○ Apply the same approval policy to all blog posts, documents, photos, videos, feed posts,

forum posts, and wiki pages before they become visible.○ Apply a specific approval policy to each item. If you select this option, you can choose to set

policies for one, some, or all items as necessary.○ Blog Posts○ Documents, Images, and Videos○ Feed Posts○ Forum Posts○ Knowledge Base Articles○ Wiki Pages

NoteIf the content to be approved resides in a private folder, it is recommended that you choose the "Any selected group member can approve" policy with multiple members to help account for a situation where not all approvers have access to a given private folders.

○ Email Notifications: Choose the default notification frequency for the group (Immediate, Daily, Weekly, None). If you change the notification at a later time, group members will receive a bell notification regarding the change. Members will have an opportunity to accept or reject the change as per their preferences.



○ Enable @@notify: If selected, users can send notifications to all group followers. As a group administrator, you can disable this to help minimize unwanted notifications in large groups. When you disable the @@notify feature for all group members, it is still enabled for group administrator use only.

○ Enable Content Rating: If selected, allows users to rate content.

9.6.3.1 Content approval

When configuring approval policies for your group, if you selected "Any group administrator can approve" or any other policy and then selected your name as an approver, that makes you responsible for reviewing and accepting or rejecting content items, feed posts, and/or forum posts. If you configured a policy where you are not an approver, as group administrator, you have the ability to override the approval process and still approve or reject an item. This is for situations where one or all selected approvers are unavailable while the item to be reviewed is time sensitive.

Pending my approval items: review, approve or reject content

Content reviewers are sent bell notifications anytime their attention is required for a content approval. They can also click Pending Approval from the group navigation to view a list of outstanding items which require their approval.

To review and then approve or reject content for which you are one of a selected set of members who can approve content/comments

1. Check your bell notifications for a content review request and then click Review Content.

Bell notification with content approval message2. Or, click Pending Approval to view of listing of items pending your approval.


Pending approval list3. Click the item to open it in single item view (for content, feed items, and forum topics).4. Review the item and click Approve or Reject.5. If you reject the item, provide a reason for why the content has not been accepted, and tips if any on

corrective action (e.g., editing the rejected post to make the necessary corrections before publishing it again; this would start a new approval workflow) that can be taken by the author. The content author will then receive a bell notification to let them know that the item was not approved. They can click View to read your rejection comment on why it was not approved for publication.

Feed item with rejection message

When reviewing content where all selected members must approve it before it can be published, a bell notification displays when one member has rejected the item. For example, if three group members are selected to approve a wiki page, and one member out of the three rejects the item, then the other two content approver members are notified with a bell notification that it has been rejected.

Regardless if a group administrator is also a selected member for a content approval workflow, they will have options to override and accept or reject an item. This covers situations where a selected non group administrator member is unable to accept or reject a content item because they are unavailable.



Pending other's approval items: override to approve or reject content

If a content approver is unable to review an item, causing it to be stalled in the approval process, the group administrator can act as a substitute approver and approve or reject the item.

To override and approve or reject an item

1. On the group page, from the navigation, choose Pending Approval.2. From the list of items that are pending other's approvals, choose the item that you want to review.3. After you review the item, choose More > Override and Approve or More > Override and Reject. If you reject

the item, you have the option to enter text on why the item was rejected. The content owner will then receive a notification with a reason for why the item was rejected.

NoteYou also have the option to delete the item. Deleted content items will be moved to the group trash.

9.7 Invite people to join group

After a private or public group has been created, you can begin to invite others who can share their expertise and contribute towards group goals. You can invite individuals, use member lists, import a CSV file with a list of email addresses on each row, or choose a preconfigured member list when composing your invitation.

1. From the group page, click + Invite.2. In the Add People to the Group Invitation List text box, enter the names, email addresses, or group member

list (created by the community administrator) that you want to invite to the group. If the people you invite are already participating in the community, you can enter their name and the auto-complete function will help you find the right person.

3. Enter a personal message (optional; can include details about why you are sending the invitation, purpose of the group, etc.) and then click Send.

NoteOn the members list page, the following information is included to help decide whether more invites should be sent to a particular user:

● Last invited: The date the user was last invited to the group.● Invite reminders: The number of invitation reminders that were sent to the user; indicated in brackets.

When exporting the member list to a CSV file, the "Last invited" and "Invite reminders" data is included.

The invitee will receive an email notification about your invitation and then can choose to accept or reject your invitation.

Members can remove themselves from membership if they select Leave Group from the Group Settings menu, or they can select Stop following this group to no longer receive updates from the group in their Home feed.

NoteOnce access to the group is granted, group admins can remove access to the group.


9.8 Group reports

If you are a group administrator, you will be able to access SAP Jam reports which display metrics on user contribution and activities, containing a maximum three months span of data per report. They can be downloaded as CSV files from the Reports tab in the Admin console.

NoteIn the Admin console, when a group report is scheduled and generated, all other administrators for the same group will be able to view it. The same applies for community level reports; all other community administrators will be able to view that report.

Report metrics

Requested reports now display immediate metrics to help users determine whether they need to request another report or view the existing one from the list. For example, below each report title, the time frame for the report is indicated. To the left of the report, various icons show whether the report is scheduled to run (blue icon), completed (green icon), or encountered an issue after the request was submitted (red icon).

The following table lists the reports:

Report Description

Activity Summary by Week or Month

Aggregated counts of content creation activities. This report can be run for the entire community, or a specific group.

Content Ranking Report Lists all content items, their folder location, the type of content, number of times viewed, liked, and downloaded. It does not show the ranking for an entire community's content. The content rating average is also included.

Content Views Report (weekly) or Content Views Report (monthly)

Number of views per week or month for rich data content types (such as blogs, documents, links, photos, videos, and wiki pages).

Contribution Report by Object by Week or Month

Aggregated activity count for all items in SAP Jam such as comments made, groups created, photos and documents uploaded, and so on. This report includes activity in private groups.

Group Member Activity Report

List of members in each group, including the number of activities in the last 30 days.

Ideas Report List of ideas submitted to the group ideas forum for a specified date range.

Terms of Use Compliance Report

Lists the users who have accepted the terms of use before participating in the group.

User Page Views Report (Weekly) or User Page Views Report (monthly)

List of users and the number of items they have viewed in a given time frame. This can be any item that has a view count (for example, documents, photos, and wikis). Only users who have viewed at least one item within the requested time frame are listed.

User Contribution by Week or Month

Number of objects a user has contributed per week or month.



Report Description

User Contribution Activity Report

Aggregate of content contributed per user for a specified time range.

Purged Content Report Displays purged items for all content types by user.

A group administrator can view and run the following reports within a group by clicking Reports from the group menu navigation. User level reports are available only when the "Allow User Level Report" is enabled under Features in the Admin console, and not restricted to community administrators.

Group and user level reports

Group level User level

Activity Summary by Month Group Member Activity

Activity Summary by Week User Contribution Activity Report

Content Ranking Report User Contribution Report by Month

Content Views by Month User Contribution report by Week

Content Views by Week User Page Views by Month

Contribution Report by Object by Month User Page Views by Week

Contribution Report by Object by Week

Idea Report

Terms of Use Compliance

Purged Content Report

Generating report with multi-byte characters

You can view the content of CSV file by using Microsoft Excel's "Text Import wizard" and ensuring "65001: Unicode (UTF-8)" is selected from the "File origin" options. Please see https://support.office.com/enus/article/TextImportWizardc5b02af6fda14440899ff78bafe41857 for more information. For example:

1. Choose the "Delimited" option.2. Begin import from row 2 if you see "sep=" in the preview. Otherwise, start from row 1.3. Set File Origin to "65001: Unicode (UTF-8)".4. Select "My data has headers" and then click Next.5. Select "Comma" as the only delimiter and then click Finish.


http://help.sap.com/disclaimer?site=https%3A%2F%2Fsupport.office.com%2Fen-us%2Farticle%2FText-Import-Wizard-c5b02af6-fda1-4440-899f-f78bafe41857

http://help.sap.com/disclaimer?site=https%3A%2F%2Fsupport.office.com%2Fen-us%2Farticle%2FText-Import-Wizard-c5b02af6-fda1-4440-899f-f78bafe41857

9.8.1 Activity summary by week or month

This report shows a total count of content creation activities are listed by one column per week or month for the selected time period. You can use this report to help you determine which content item types are most popular amongst group members and which one are used less frequently. If designing group overview pages, you could use this information when featuring items in a content widget, or deciding which forum types make the most sense for your group's use. Please refer to the following table for a list of activities.

Activity summary by week or month details

Row item Description

Blogs The number of blogs created in the week or month, and a total for the entire period.

Comments The number of comments made in the week or month, not including those in Discussions or Ideas, and a total for the entire period.

Discussion Comments The number of comments made in discussions in each week or month, and a total for the entire period.

Discussions Created The number of discussions created in each week or month, and a total for the entire period.

Document Annotations The number of documents annotated in each week or month, and a total for the entire period.

Documents The number of documents uploaded in the week or month, and a total for the entire period.

Idea Comments The number of comments made in the week or month on ideas, and a total for the entire period.

Ideas Created The number of ideas created in the week or month, and a total for the entire period.

Knowledge Base Articles The number of knowledge base articles created in the week or month, and a total for the entire period.

Links The number of links added in the week or month, and a total for the entire period.

Photos The number of photos uploaded in the week or month, and a total for the entire period.

Polls The number of polls created in the week or month, and a total for the entire period.

Questions Answered The number of answers to forum questions added in the week or month, and a total for the entire period

Questions Created The number of questions created in the week or month, and a total for the entire period.

Tasks Created The number of tasks created in the week or month, and a total for the entire period

Videos The number of videos created in the week or month, and a total for the entire period.

Wiki Pages The number of wiki pages created in the week or month, and a total for the entire period.



9.8.2 Content ranking

This reports shows all content items that have been ranked. You can use this report to find out which content items are most popular based on ranking and which items are least favourable. Items that receive no rating might need to be featured more prominently or reconsidered for its relevance within the group. Please refer to the following table for a list of content ranking items.

Content ranking details


Title The title of the content item.

Location The content folder where the content item is stored.

URL Direct URL to the ranked content item.

Content Type The type of content (for ewxample: wiki page, blog post, link, video, document, knowledge base article).

Views The number of views for the content item.

Likes The number of likes for the content item.

Rating The average rating (between 0 and 5 stars).

Downloads The number of times the content was downloaded.

9.8.3 Content views by week or month

This report shows the number of views per week or month for all content types. You can use this report to determine most popular to least popular content types. Please refer to the following table for a list of activities.

Content views by week or month details


Blogs The number of views of blogs for the indicated week or month, and total number for the entire period.

Discussions The number of views of discussions for the indicated week or month, and total number for the entire period.

Documents The number of views of documents for the indicated week or month, and total number for the entire period.

Ideas The number of views of ideas for the indicated week or month, and total number for the entire period.



Knowledge Base Articles The number of views of knowledge base articles for the indicated week or month, and total number for the entire period.

Links The number of views of links for the indicated week or month, and total number for the entire period.

Overview Pages The number of views of overview pages for the indicated week or month, and total number for the entire period.

Photos The number of views of photos for the indicated week or month, and total number for the entire period.

Questions The number of views of questions for the indicated week or month, and total number for the entire period.

Videos The number of views of videos for the indicated week or month, and total number for the entire period.

Wiki Pages The views of wiki pages for the indicated week or month, and total number for the entire period.

9.8.4 Contribution by object week or month

This report shows the cumulative activity count by week or month in SAP Jam for the selected time period. You can determine which content type generated the most participation to the least participation in a group. Please refer to the following table for a list of content types.

Contribution by object by week or month details


Blogs The activity count in blogs for the indicated week or month, and a total for the entire period.

Comments The activity count in comments for the indicated week or month, and a total for the entire period.

Discussions The activity count in discussions for the indicated week or month, and a total for the entire period.

Documents The activity count in documents for the indicated week or month, and a total for the entire period.

Ideas The activity count in ideas for the indicated week or month, and a total for the entire period.

Questions The activity count in questions for the indicated week or month, and a total for the entire period.

Knowledge Base Articles

The activity count in knowledge base articles for the indicated week or month, and a total for the entire period.




Links The activity count in links for the indicated week or month, and a total for the entire period.

Overview Pages The activity count in overview pages for the indicated week or month, and a total for the entire period.

Photos The activity count in photos for the indicated week or month, and a total for the entire period.

Polls The activity count in polls for the indicated week or month, and a total for the entire period.

Poll Votes The activity count in poll votes for the indicated week or month, and a total for the entire period.

Tasks The activity count in tasks for the indicated week or month, and a total for the entire period.

Events The activity count in events for the indicated week or month, and a total for the entire period.

Tags The activity count in tags for the indicated week or month, and a total for the entire period.

Videos The activity count in videos for the indicated week or month, and a total for the entire period.

Wikis The activity count in wikis for the indicated week or month, and a total for the entire period.

9.8.5 Group member activity

This report lists total counts of user activity for a group. Please refer to the following table for a list of activities.

Activities can include interaction such as: content creation and updates; forum topic (questions, ideas, and discussions) creation, updates, and marked best answers; folder creation and updates; knowledge base article creation and updates; event creation and updates; custom event category creation and updates; task creation and updates; comments, replies, and sharing of feed updates; views, moving, and copying of content items; video playback; group export; group avatar updates; overview page creation and updates; link clicks.

NoteOnly the Users, Select Report, and Group options remain after this type of report is selected.

Group member activity details


Group ID The unique number identifier for the group within SAP Jam.

Group Name The name of the group.

NoteNon-Public groups will not show the group name unless Include Private Group Details is enabled in the Features tab of the SAP Jam Administration console.



Group Type The group type can be "Private", "Private Folder", "Cross Community", or "Public".

User ID The user's ID. If you are not using SuccessFactors Platform, this entry will be blank.

User Email The user's email address.

User First The user's first name.

User Last The user's last name.

User Status The user's status (e.g., Active, Pending Approval).

Number of Activities in the last 30 days

The total number of the user's activities in the last 30 days for the specified group.

Date of Last post The date and time of the user's last activity.

Total number of Activities

A total number of the user's activities since joining the group.

Group Admin Indicates whether a user is also a group administrator.

9.8.6 Group member list

This report lists all the group members for a group. Please refer to the following table for a list of group member details.

Group member list details


Email Address The email address of the member.

First Name The first name of the member.

Last Name The last name of the member.

Status Admin, Member, Invited, and Alumni indicates the current member status.

Joined The date and time that the member joined the group.

Last Invited The date of the last invitation sent to the member.

Added By The name of the member who added this particular member to the group.

Invited Reminders The number of invitation reminders sent to the member.

Following Yes or No to indicate whether the member has opted to follow group updates.

Email Frequency Immediately, Daily, Weekly, or No Emails can be indicated as the level of requested email frequency.



NoteIf the administrator disables the Allow User Level Reporting option in the Admin console, group administrators cannot view this report.

9.8.7 Ideas

This report displays all the ideas created by group members. Please refer to the following table for a list of idea attributes.

Ideas details


Idea Title The title of the idea.

Idea Content The details of the idea from the content entry text box.

URL Direct URL for the idea.

Vote Up The number of votes in favor of the idea.

Vote Down The number of votes against the idea.

Idea Status The status of the idea (e.g., Submitted, Approved)

Created Time When the idea was created.

Created By The user who created the idea.

Last Update Time When the idea was last updated.

9.8.8 Terms of use

This report lists which user have accepted the terms of use agreements. Please refer to the following table for a list of user details.

Terms of use details


First Name The first name of the user.

Last Name The last name of the user.

Email Address The email address of the user.



User ID The user's ID number. If not set up in SuccessFactors Platform, this entry will be blank.

Accepted Time The timestamp for when the user accepted the agreement.

Version The version number for the Terms of Use accepted by the user. Versions are incrementally numbered as they are added.

9.8.9 User page views by week or month

This report displays each user with total counts of content items viewed for each week or month in the time period, and a total count for the entire time period. Only users who have viewed at least one item within the requested time frame are listed.

User page views by week or month details


User ID The user's ID number.

Email Address The user's email address.

First Name The user's first name.

Last Name The user's last name.

Group Member Yes or No to indicate whether the user is a group member.

(time period) The total number of content views by the user in each week/month in the specified period.

Total The total number of content views by the user in the entire specified period.

9.8.10 Purged content report

This report displays purged items for all content types by user. It lists the name of the group, requested time frame, title of the item, content type, folder location, when it was purged and the name of the user who purged the item.

Purged content for up to three month time span


Title The name of the purged item.




Content Type Content types include forum topics (Questions, Ideas, Discussions), overview pages, wiki pages, blog posts, documents, photos, videos.

NoteDeleted folders are not included as a content type and do not appear in this report.

Folder The folder name.

Purged at The date of the purge.

Purged by The first and last name of the user who purged the item.

(Date Range) Listed at the top of the report; time span for purged items

9.9 Copy a group

As a group administrator, you can copy a group as a means of saving time and effort in designing the same overview pages and uploading the same content and folder structure to a new group. You'll automatically become the sole member and group administrator for the copied group.

Copy an existing group

To copy an existing group

1. Click Groups from the global menu bar, go to the group you want to copy and then choose the Settings icon to access the Copy action. Or, go to the group pages and choose Group Admin > Copy Group.

2. Enter a new group name to differentiate it from the original, or accept the default name which adds the suffix "(Copy)" to the a copy of the original group name.

3. A "Your group content is being copied" message displays while a copy of the group finalizes. The content owner for all copied content will be the group administrator who performed the Copy action. You can navigate away from this page in the meantime.

All copied content will display as "Version 1" in the single item view version history.

Note● Forums, feed activity, events, reports, trash items, mirrored content items, content item metadata

(e.g., content ratings, number of likes and views) and dashboard activity metrics are not copied to the new group as they are applicable in context only to the original group.

● Group members and any other group administrators from the original group are not automatically invited to the new group.

● When a group is cloned, knowledge base articles are also copied as part of the overall group content to the new group.


9.10 Delete a group

Group administrators can delete groups when they no longer serve a purpose, are redundant, etc.

NoteCommunity administrators can also delete groups from the groups management listing in the Admin console.

To delete a group

1. Go to the group you want to delete.2. On the group navigation, from the Group Admin menu, choose Delete Group.3. The Delete Confirmation window appears. Click Confirm. A deletion confirmation message appears.

The group is moved to your Trash items.

9.11 Restore a group

There may be an incident where you delete a group by accident. Or, you have deleted the group by request, but the requestor has changed their mind and requires the group again. To restore a deleted group that has not yet been purged, you can retrieve the group from your Trash.

NoteDo not click Purge Items unless you want to permanently remove your deleted items. Once the items are purged, they cannot be retrieved.

To restore a group

1. On the icon toolbar on the top right of any page, click the Settings icon and select Account. The Account Settings page appears.

2. To see a list of your deleted items, select Trash.3. To retrieve the group you deleted, click the box in front of the group's name.4. Click Restore Items. The group and its content will be retrieved from your Trash.

9.12 Import and export groups

When importing and exporting content and overview pages from groups in SAP Jam Communities, there are some content types and configurations that are not currently supported during the copy process. This topic lists the content types and configurations that are supported.

In the SAP Jam Communities Admin console under the Product Setup Group Management Import and Export Group tab, as a community administrator you can now import or export groups and group content between tenants. Files are in .zip file format.



NoteBefore you import content, be sure to

● Back up any content you may need for future use.● Check that the user account permissions match between source and destination tenants.

When you import a group and its content, the following information displays on the Import tab:

● Imported file name and group name● Date and time of the import● Status (for example: In progress, Import Completed)

If a group with the same name as the import group exists, the existing group will be used as the target for importing.

For overview pages and items that exist in both the zip and the target group, group content will be moved to trash before the zip content is imported. For example, if "budget.xls" is in the zip file and "budget.xls" also exists in the target group, then "budget.xls" from the target group will be moved to the trash before "budget.xls" from the zip file is imported.

When you import or export a group and its content between tenants, you can expect the following to be included when copied:

Group overview pages and content

Location or feature Content type, configuration, or tab

Content repository ● Folders● Blog posts● Documents (for example: .txt, .docx, .xlsx files)● Links● Images● Videos (.mp4 files only)● Polls (without voting results)● Wiki pages● Tags

Membership ● All members except those that do not exist in target tenant.● Member roles.

Forums ● Forum topics for questions, ideas, and discussions.

Events ● Event settings. Exception: Some settings such as time zone, all day checkbox changes, and attachments.

Knowledge base ● Knowledge base articles.● Knowledge base categories applied to articles in source tenant.

Pages ● Overview page tabs● Sub tabs● Page settings● Row settings


Location or feature Content type, configuration, or tab

Widgets ● Settings● Title translations

NoteHistorical versions, drafts, and items that are already in the group trash are not exported or imported.

Import groups

To import groups

1. In the SAP Jam Communities Admin console go to the Product Setup Group Management Import and Export Group tab.

2. Go to the Import tab.3. Click Import Group.4. Read the important notes and then click Import.5. Select the zip file from your local drive and then click Open.6. The zip file will be imported to the top level of your content repository. Click Import. A progress indicator

displays and let's you know when the upload is complete.

Export groups

To export groups

1. In the SAP Jam Communities Admin console go to the Product Setup Group Management Import and Export Group tab.

2. Go to the Export tab and select the group you want to export.3. Click Export Group.4. Click Export on the confirmation dialog. A zipped file will download to your local drive.



10 Product Setup and Features

10.1 Features

Community administrators can manage various compliance, userspecific, and featurespecific settings on the Features page. Once a setting is enabled or disabled and then saved, the community is automatically updated to reflect those changes.

To configure which features are available to community users

1. Go to the Admin console and select Product Setup Features from the left side navigation.2. Select any of the following:

Compliance options

Option Description

Enable Compliance Monitor Monitors the content posted to SAP Jam Communities and flag items that contain terms that are listed in the Compliance Dictionary. Enabling the alert does not scan content retroactively, only from the date the alert is enabled. Disabling the alert permits users to post content to SAP Jam Communities without flagging Compliance Dictionary violations. If content has already been scanned prior to

disabling, flagged items remain listed in the Compliance and Security

Compliance Pending Flagged Items table.

Enable Profanity Monitor Monitors the content posted to SAP Jam Communities and flag items that contain terms that are listed in the Profanity Dictionary. Enabling the alert does not scan content retroactively, only from the date the alert is enabled. Disabling the alert permits users to post profanities to SAP Jam Communities without flagging Profanity Dictionary violations. If content has already been scanned prior to disa

bling, flagged items remain listed in the Compliance and Security

Compliance Pending Flagged Items table.

Enable Unscannable Filter Flags all items where content cannot be scanned (for example: images, videos, zip files). The attributes of these files such as filename, title and description are scanned by Compliance and Profanity filters. This filter does not scan content retroactively; it scans from the date this filter is enabled.

NoteTo restrict IP access, please contact your SAP Jam Communities tenant administrator.

SAP Jam Communities Administration Guide 1902Product Setup and Features P U B L I C 111

User Management options

Options Description

Show Profile Images User profile photos will appear beside users' posts in forums and feeds, as well as several other locations. Deselect this option to turn off the display of user profile photos.

Allow Users to Upload a Custom Profile Photo

Disable this option to prevent users from uploading their own user profile photos. For example, your community may already import user profile photos from a source external to SAP Jam Communities. This option is automatically disabled if Show Profile Photos is also disabled.

Show Profile Job Titles Job titles display in users' profiles for each user who has a job title.

Use profile locations from third party identity provider

If enabled, user profiles will show location information from third party identity provider data instead of user-supplied addresses where present.

Enable users to create their own groups

If disabled, only SAP Jam administrators can create groups.

Set default for group email notifications

Choose from immediate, daily, weekly, or none. This setting can be overridden by users in their email notification preferences.

Show profile pages for alumni Alumni users are users who have left your community. This option allows you to control whether alumni user profile pages are available and viewable.

Clear profile info for alumni For those who have left your community, select this option to remove the personal information and image of users from SAP Jam. Alumni users' office location information is removed, but their manager and job title information is retained.

Feature Management options

Options Description

Enable File Sharing Users can upload files.

Enable Content Rating Users can rate content that has been uploaded.

Wikis Users can create wiki pages.

Persistent Navigation Bar Create custom site navigation that links to groups, group content, and external pages without writing any code in the custom header. These tabs display on all pages throughout a cvommunity, below the global menu bar.

Designate Author Enables community users to designate another community participant who can compose blog posts and other content for them as ghostwriters.


Product Setup and Features

Options Description

Knowledge Base Enables knowledge base authors to create knowledge base articles as part of community support for their groups. Articles can be accessed via the global menu bar. A group level setting for knowledge base articles can be enabled or disabled for specific groups. When enabled by the group administrator, Knowledge Base appears on the left side navigation. This feature is enabled by default at the community and group level.

The community-wide knowledge base option below this feature allows users to see all knowledge base articles from all groups that they are members of by accessing the community Knowledge Base from the global menu bar. If disabled, the Knowledge Base cannot be accessed from the global menu bar.

By default, the knowledge base feature is enabled for a group when the community setting for the knowledge base feature is enabled. Group administrators can enable or disable the availability of the knowledge base feature for their group when editing the group settings.

Videos/Audios Allows users to upload or create videos using screen capture or their webcam. Video and audio files are uploaded and encoded for use within SAP Jam.

NoteTo create videos using non-WebRTC technology, the Adobe Flash Player must be installed. To record a video, see Java Runtime Environment (JRE) requirements in System Requirements [page 7]. The WebRTC player and the Adobe Flash player are not required for video playback.

NoteTo enable watermarks on videos, or append video snippets before and after an uploaded video, please contact your SAP Jam site administrator.

Include Private Group Details Administrators can view private group names in reporting and Compliance features and run reports on a specific private group.

Show Hire Date in member profile Display hire date information in users' profile pages.

Send daily alert emails to all members

Content and updates sent via email.

Send active task reminder to all members

Active tasks reminders sent to all members.


Options Description

Allow User Level Reporting Users can view and run group reports. When you disable this option, content item owners can no longer view a list of unique viewers and downloaders for their document. The Group Members List group report will not be available.

NoteThe number of page views and downloads still displays, but is no longer a clickable hyperlink.

Restrict access to Community Admins only

This option depends on the Allow User Level Reporting option being selected. If you select this option, only community administrators will be able to run and view group reports, and view a list of unique viewers for all group content items.

Enable SCIM API support

Hide the "Change Password" link Hide the "Change Password" link for users provisioned via the SCIM API

Enable Anonymous Access For Public Groups

If a group administrator creates a public group, they can make the group content searchable and public on the internet. When this option is enabled, users can view SAP Jam Communities public group content without being logged into the community. If the user tries to interact with content, they are forwarded to a login page or prompted to register in the community.

Enable document download via CDN

When enabled, the Content Delivery Network outside the SAP data center will cache documents to boost downloads speeds and video streaming performance. Globally distributed customers with offices distantly located from their SAP Jam Collaboration tenant data center host experience significant performance improvements.

Enable Webcam/Screen Recorder using WebRTC technology (Google Chrome and Mozilla Firefox only)

With this option selected, when you choose to share a video via a feed update, you can click on an information icon that displays whether the compatibility checklists have been met for recording a screen capture or recording with their webcam. Webcam recording is supported only on Google Chrome and Mozilla Firefox internet browsers. Screen recording is supported only on Google Chrome (without audio) and Mozilla Firefox internet browsers.

Enhanced widget styling and page layout option

Allows all home page and group overview widgets to display with better usage of available screen space, improved carousel and gallery layouts, a bolded and larger font size, and the removal of some user avatars. Content, forum, and knowledge base widgets display with bolded item titles, two line descriptions, and attention to item type.

3. When you have the feature availability and feature behavior options set, click Save changes.

10.2 HashtagsTags are succinct, descriptive keywords that enable other users to find information. When users tag content, the system ensures that the content contains a single hashtag symbol so that searches and filters produce



complete results. As an administrator, you can create a CSV file with only one entry per line, for the words or phrases that users can enter for hashtag autocompletion. When the user begins writing the word or phrase in the hashtag field, the matching word or phrase is shown. The user can then add this term to the end of the text that they are writing.

Supported hashtag characters include alpha characters, numbers, and word-connectors (for example, dash, underscore). Special characters (for example, slash (/) quotes (“, ‘, `), decimal (.), parentheses (()) , brackets ([]), etc.) are not supported.

To configure hashtags

1. Go to the Admin console and select Product Setup Hashtags from the sidebar.2. If you want to use a hashtags file that you have on your local drive, click Browse, navigate to the file, select

it, and then click Submit.3. If you want to use a hashtags file provided by SuccessFactors Platform, click Import and select the file from

the SuccessFactors Platform hashfiles that are listed.

10.3 Knowledge base

As a community administrator, you can create and edit a multiple level category hierarchy for knowledge base articles, up to three levels deep, with up to 150 categories at each level. This provides groups with a way to organize and improve discoverability of their articles.

Manage categories

You can create new categories, move, update or correct category names by renaming them, and delete categories.

To create categories that can be used to categorize knowledge base articles across groups in your community

1. Go to the Admin Console.

2. On the left side navigation, choose Product Setup Knowledge Base .3. Click the Categories tab.4. Enter a list of categories, with each category separated by a comma.5. Click Add to add the categories.

You can move categories to another category or delete multiple categories.

NoteWhen moving a category to another category, please note the category level structure. For example, when attempting to move a category with a three level hierarchy to another category, the category you are trying to move everything to cannot replicate the main level category plus two subcategory level structure. This would create a fourth level hierarchy which is not supported. A message confirming that the move cannot be completed as requested after you click the Move Selected button.

To delete one or more categories


1. Select the checkbox beside the category or categories.2. Click Delete Selected. The deleted category or categories will no longer display for existing articles that

used the category, nor will it display as an option for new articles.

To rename a category

1. Select the checkbox beside the category.2. Click the drop-down to the far right and choose Rename. Enter the new name for the category. The

renamed category is automatically updated for all published articles. When creating a new article, the renamed category will display as a category option.

Create community level knowledge base templates

You can create knowledge base templates at the community level to be disabled or enabled by group administrators for their respective groups. After you create a template, you can enable, edit, disable, copy and delete each one as required.

To create a knowledge base template

1. Go to the Admin console Product Setup Knowledge Base page.2. On the Templates tab, click + Template.3. In the New Template dialog box, enter a template name and description, then click Create.4. Follow the steps for designing a knowledge base template as explained in the Knowledge base templates

[page 117] topic.

Enable or disable a knowledge base template

Once you've published your template to the list of available templates, you can decide whether to enable or disable it. Or, if an already enabled template needs to be retired or taken offline, you can choose to disable it.

To enable or disable a knowledge base template

1. On the Templates tab, find the template you want to enable or disable from the Templates list.2. Click the toggle below the Enable column.

Copy a knowledge base template

To make it easier to create similar knowledge base templates within your community, or create identical copies and then edit them as required, you can make a copy of an existing knowledge base template.

To copy an existing template

1. On the Templates tab, click the drop-down to the right of the enable and disable template toggle and choose Copy.

2. The copied template is listed below the original template. Make edits to the copy as needed.



Edit a knowledge base template

You can edit a knowledge base template by adding, removing, and rearranging fields, or adding, modifying, and removing options for checkboxes, radio buttons, and dropdowns. Changes to the template will be applied to existing articles only when the article is edited and saved. When a user edits an article that is based on a template that has been revised, they will see a message shown at the top of the article that says "The template for this article has been modified and may cause the article to display differently". When you edit a template that has at least one article created from it, you will see a message shown at the top of the template that says "Any changes made to this template will be applied to published articles once they are edited."

To edit a knowledge base template

1. On the Templates tab, find the template you want to edit from the Templates list.2. Click the drop-down to the right of the toggle and choose Edit.3. Make your changes and then click Publish.

Delete a community level knowledge base template

Although you can a delete custom template, if there are published articles based on the template, the template cannot be deleted.

NoteOnce deleted, the knowledge base template is permanently removed and cannot be restored.

To delete a knowledge base template

1. On the Templates tab, find the template you want to delete from the Templates list.2. Click the drop-down to the right of the toggle and choose Delete.3. On the confirmation dialog, click Delete.

10.3.1 Knowledge base templates

Service agents and managers can create and use knowledge base articles to find the right information required by a customer at the right time, reducing call handle time, improving operational efficiencies, increasing customer engagement, and reducing labor costs. Categories can be created for products and processes.

Create a custom knowledge base template

As a group administrator, you can create custom templates so that articles have a structure that meets the standards and requirements of your team. You can design your own template or copy an existing template and customize it as needed.

To create a custom knowledge base template


1. Click Knowledge Base from the left side navigation of your group.2. At the top of the page below the group name, click Templates.3. Below Templates click + Template. The New Template dialog box displays.4. Enter a meaningful name for the template and provide a brief description of its purpose before you click

Create.5. You can now design you template with various field styles. Add as many as required by clicking + Field and

then selecting any of the following:○ single line text box: add a title for the text box and any text you'd like displayed to the reader of the

article.○ multiple line text box: add a title for the text box and any text you'd like displayed to the reader of the

article.○ checkboxes: add a title for the grouping of checkbox selections, and then provide labels for each

checkbox. Click +Add option to add a checkbox.○ radio buttons: add a title for the grouping of radio button selections, and then provide labels for each

radio button. Click +Add option to add a radio button.○ dropdown lists: add a title for the grouping of dropdown selections, and then provide labels for each

dropdown option. Click +Add option to add a dropdown option.○ date fields: add a title for the date field.○ file attachments: add a title for the file attachments section.

NoteTitles can also be instructions or brief descriptions.

○ static content: add text, multimedia, and images that are static and cannot be removed or edited by knowledge base article authors.

6. If you need to delete a field, choose Actions Delete to the bottom right of the field you want to remove.

7. If you need to duplicate a field, choose Actions Duplicate to the bottom right of the field you want to duplicate. The duplicate will be added directly below that field.

8. For each field, you can choose to make it Required for everyone to complete, and/or make shown only to administrators, article authors, or those who can edit the articles.

NoteIf you change a field from optional to required or required to optional when there are existing articles based on that knowledge base template, the existing articles are not affected by the change unless they are edited using the new template and then saved.

9. If you want to reorder fields, click the dotted icon to the far left to drag and drop to the location where you want them to display.



Delete options, rearrange fields10. Click Publish to make the template display in the list of available templates on the Knowledge Base

templates page.

Enable or disable a knowledge base template

Once you've published your template to the list of available templates, you can decide whether to enable or disable it for group members to use when they create knowledge base articles. Or, if an already enabled template needs to be retired or taken offline, you can choose to disable it.

To enable or enable a knowledge base template

1. Click Knowledge Base from the left side navigation of your group.2. At the top of the page below the group name, click Templates.3. Find the template you want to enable or disable from the Templates list.4. Click the toggle below the Enable column.

Copy a knowledge base template

To make it easier to create similar knowledge base templates within your group, or create identical copies for other groups, and then edit them as required, you can make a copy of an existing knowledge base template.

To copy an existing template

1. Click Knowledge Base from the left side navigation of your group.2. At the top of the page below the group name, click Templates.3. Find the template you want to copy from the Templates list.4. Click the drop-down to the right of the toggle and choose Copy.5. On the Copy To dialog, choose a group from the drop-down list and then click OK.6. Go to the copied template and make edits if needed.


Edit a knowledge base template

You can edit a custom knowledge base template by adding, removing, and rearranging fields, or adding, modifying, and removing options for checkboxes, radio buttons, and dropdowns. Changes to the template will be applied to existing articles only when the article is edited and saved. When a group member edits an article that is based on a template that has been revised, they will see a message shown at the top of the article that says "The template for this article has been modified and may cause the article to display differently". When you edit a template that has at least one article created from it, you will see a message shown at the top of the template that says "Any changes made to this template will be applied to published articles once they are edited."

To edit a knowledge base template

1. Click Knowledge Base from the left side navigation of your group.2. At the top of the page below the group name, click Templates.3. Find the template you want to edit from the Templates list.4. Click the drop-down to the right of the toggle and choose Edit.5. Make your changes and then click Publish.6. Enable or disable the toggle on the Templates page beside the template to control whether group members

can select it to create knowledge base articles.

Delete a knowledge base template

Although you can delete a custom template, if there are published articles based on the template, the template cannot be deleted.

To delete a custom knowledge base template

1. Click Knowledge Base from the left side navigation of your group.2. At the top of the page below the group name, click Templates.3. Find the template you want to delete from the Templates list.4. Click the drop-down to the right of the toggle and choose Delete.5. On the confirmation dialog, click Delete. The template will be moved to the group trash folder.

10.4 Content templates

The Product Setup Content Templates page allows you to create templates for content, similar to the "Corporate Communication Blog Post Template" and the "Knowledge Base Wiki Template" that are provided with your instance of SAP Jam Communities.

You can also upload images to the Content Template page. These templates are available to all your users, allowing them to save time and to reuse partially constructed wiki and blog content or your community's pre-approved graphics.



Create a wiki or blog content template

Creating a wiki or blog content template can save your community users a lot of time if they create lots of standard format pages, such as meeting minutes, design specifications, corporate communications of various types, knowledge base articles, how-to pages, and the like. The content users create from these templates will have all of the material that you add to the template, such as standardized page headings, including identifying images, section titles, and standard boilerplate text. Yet users will be able to modify any of this content if they need to do so.

1. Go to the Admin console and select Product Setup Content Templates .The Content Templates page displays, showing a catalog of all content templates available to your users.

2. Click Create and select either Blog Post Template or Wiki Page Template from the dropdown menu.The content creation page for that content type displays, either the Create a Blog Post Template page or the Create a Wiki Page Template page.

3. Enter a Title, and then provide the necessary content for the template.4. Once you have the template content set, click Save.

On the Content Templates page, the template that you just created is listed in the catalog, listed alphabetically by title.

Publish or hide content templates

It is common to work on a template over several days to ensure that all of the required parts are included without adding too much material that won't be applicable to most uses of the template. To enable this development period without exposing a draft template, you can control the visibility of that template to your users.

To control your users' access to a content template, click on the "visibility" control in the left-most column of the catalog, on the row for the template that you want to set their access to:

● To make a template invisible, ensure that the button is set to the left, the background of the control is grey, and an "x" displays on the right side of the control.

● To make a template visible, ensure that the button is set to the right, the background of the control is blue, and a check mark displays on the left side of the control.

Add an image

To include an image in a content template, you must add it to the Content Templates page's Images tab. To do this:

1. In the Content Templates page, click the Images tab.The Content Templates page's Images tab displays, showing a catalog of all of the images available for use in your content templates.

2. Click Upload images to open your browser's file upload window, in which you can browse your hard drive for the image or images that you want to upload.Once the image uploads have finished, the uploaded images will appear in the Content Templates page's Images tab's catalog.


Once you have uploaded images to the Content Templates page's Images tab's catalog, you can add them to a content template by doing the following:

1. In the Content Templates page, create, copy, or edit a wiki or blog content template.2. In the Content Template editor, click the image icon and select Choose existing content from the drop-down

menu.The Choose existing content dialog box displays, showing a list of the images that have been added to the Content Templates page's Images tab.

3. Click the image name that you want to add to the content template and click OK.The image is added to the template where the input icon was placed when you opened the Choose existing content dialog box.

4. Once you have the template done to your satisfaction, click Save.You are returned to the Content Templates page.

To add an image that has been uploaded via the Content Templates page's Images tab,

Manage the available images

You can manage the images available to your users with the Content Templates Images controls.

1. In the Content Templates Images tab, hover you mouse over the row of the image that you want to perform an action on.The available actions will appear below the title of the image, and in the additional options in the More item.

2. The available options, and their use, is as follows:○ Preview: Select this option to view the image in a popup dialog box.○ Download: Select this option to download the image using your browser's file download feature.○ Rename: Select this option to rename the image in a Rename popup dialog box.○ Upload New Version: Select this option to upload a new version of the image using your browser's file

upload feature.○ Delete: Select this option to delete the image. A confirmation dialog box displays. Click Delete to

proceed with the delete operation. The image will be deleted, and it will be removed from the Content Templates Images tab's catalog and the template will now include the added image.

Manage the existing content templates

The Content Templates management operations include editing existing templates, copying an existing template to create a similar but differentiated template, and deleting old templates that you no longer need.

1. In the Content Template tab of the Content Templates page, hover you mouse over the row of the content template that you want to perform an action on.The available actions will appear below the title of the template. If the content template is a system template, the only available action will be copy. If the content template is a custom template (one that someone in your community has created), the available actions will be edit, copy, and delete.

2. Click the action that you want to perform. If you select:



○ edit, then an editor page, much like the create editor pages, displays with the content of the template that you chose to copy shown in the editor. Make the required changes to the text of the template, and click Save.You are returned to the Content Templates page.

○ copy, then an editor page, much like the create editor pages, displays with the content of the template that you chose to copy shown in the editor. Change the title to reflect the content or purpose of your new template, make the required changes to the text of the template, and click Save.You are returned to the Content Templates page with your copied, renamed, and modified template listed in the catalog.

○ delete, a confirmation dialog box displays. Click OK to proceed with the deletion.You are returned to the Content Templates page, where the selected template no longer appears in the catalog.

Use content templates when you create a wiki or blog

To create a wiki page or a blog post with a template

1. In the Content section of any group, click the Create button and select either Blog Post or Wiki Page.Either the <group_name> - Add Blog page or the <group_name> - Add Wiki page displays. Near the top of the form is a No Template button.

2. Click the No Template button and select the template that you want to use. The template you select with display in the rich text editor.

3. Complete the creation of your blog post or wiki page as you normally would.

10.5 Third party analytics

Page view traffic analytics is supported in SAP Jam Communities so that administrators can have visibility on metrics such as number of page visitors by the hour or day, usage patterns, content interaction, device and operating system usage, and internet browser usage.

In the Admin console under Product Setup Third Party Analytics you can configure tracking by third party Clickstream analytics solutions. Google Analytics is currently supported. It can provide information such as:

● how much time a user spends on your site.● how much time a user spends on each page (includes page title and URL).● the sequence in which pages were visited.● geographic location of the user.● browser, operating system, and device usage.

NotePersonally identifiable information is not collected. Although Google Analytics can collect IP addresses from the user, they are not made available to Google Analytic tools.


10.6 Search engine configuration

To enable users to find public communities content on the web, as a community administrator, you must first configure the community to be visible to search engines. In the Admin console under Product SetupSearch Engine Configuration , you can set site verification meta tags for Google, Bing, and Baidu search engines. You can also include a title and description for the community home page to display in the search engine's search results.

To configure your community to be visible to search engines

1. Log in as a community administrator.

2. In the Admin console under Product Setup Search Engine Configuration , enter the site verification HTML tag for the Google, Bing, and Baidu search engines.1. Google Site Verification HTML tag [page 124]2. Bing - Contact your SAP Jam Communities Support representative for assistance.3. Baidu - Contact your SAP Jam Communities Support representative for assistance.

3. In the Title field, enter a Title for the site home page.4. In the Description field, enter a description for the site home page.5. Click Save changes.

10.6.1 Google Site Verification HTML tag

Shows how to get a Google Site Verification HTML tag for use with SAP Jam Communities Search Engine configuration.

Get a Google Site Verification HTML tag

1. Login to your Google account.2. Follow the instructions at Welcome to Search Console3. Select Alternate Methods4. Follow the instructions for HTML tag. Make sure to paste the meta tag into the Google site verification

HTML tag of SAP Jam Communities5. The site appears in Google's search console after verification.6. Select your verified Communities site to open Google's Search Console Sitemaps tool.

7. Select Crawl Sitemap8. Click ADD/TEST SITEMAP9. Enter "sitemap.xml"



http://help.sap.com/disclaimer?site=https%3A%2F%2Fwww.google.com%2Fwebmasters%2Ftools%2Fhome

10.7 Audio and video management

Videos can be used to demonstrate ideas, concepts, instructions, and other important messages. In SAP Jam Communities, you can create videos using a built-in video recording tool, or upload a video from another resource. You can also upload supported audio files or videos that only have audio.

As your video is uploaded, you can select a specific thumbnail for it to help others identify it visually amongst other content items. If the video is part of a series that you'd like to present, you can add the video to a playlist. Closed caption accessibility support is available in case you need to include a video text track (*.vtt) file.

10.7.1 Record a video by webcam or screen (with WebRTC technology)

WebRTC technology for webcam and screen recording allows you to work with videos in Mozilla Firefox and Google Chrome. When the community administrator enables this option, it produces a compatibility checklist for audio and browser extension requirements.

NoteAudio support for screen recordings on Google Chrome is currently unavailable.

To create a video with screen capture

1. Click the Add a Video/Audio icon on the post bar.2. Choose Click here to record a video.3. Choose Click here to record a screen capture.4. If you see an ! icon, you will need to review compatibility requirements for your browser.

Compatibility checklist dialog5. Click Get Browser Extension if the hyperlink appears.6. Steps for Google Chrome:

○ On the Add Screen Recording for SAP Jam prompt, click Add extension to add the extension for screen recording.


○ On the Share your screen dialog box, you can select what you want to share from Your Entire Screen or any of the open applications on your desktop in the Application Window tab. Click Share to begin the immediate recording of your screen.

NoteCustom click and drag or selection of the recording frame size is not supported.

7. Steps for Mozilla Firefox:○ Click Allow on the dialog box prompt.○ Click Install to install the screen recorder add-on. A message will display to confirm successful

installation before closing on its own. Click the Add a Video/Audio icon again.○ A dialog box prompts you to choose which window and microphone to share. Click Share Selected

Items to begin the immediate recording of your screen.


8. When you are ready to end the recording, click Stop Recording.

NoteThe pause function is currently unavailable.

9. The Choose a folder to upload to dialog box displays. Navigate to the preferred folder where you want to save the recording and then click Select Folder. If you don't want to save the recording and post it to the group, click Cancel.

10. After you've entered the text to introduce the screen recording you want to share in your group, click Share.11. The shared recording immediately appears in a single item view. Here, you can change the video title to

something more meaningful. The feed update where you shared the recording will update instantly with the new name.

To create a video with the webcam

1. Click the Add a Video/Audio icon on the post bar.2. Choose Click here to record a video.3. Choose Click here to record from webcam.4. If you see an ! icon, you will need to review compatibility requirements for your browser.5. Select the camera and microphone that you want to use for the recording if prompted.6. You can adjust the screen recording dimension to use full screen.


7. When you are ready to begin the recording, click the Start button.



Action buttons on recording screen8. When you are ready to stop the recording, click the Stop button.

NoteThe pause function is currently unavailable.

Action buttons on recording screen9. The Choose a folder to upload to dialog box displays. Navigate to the preferred folder where you want to

save the recording and then click Select Folder. If you don't want to save the recording and post it to the group, click Cancel.

10. After you've entered the text to introduce the webcam recording you want to share in your group, click Share.

11. The shared recording immediately appears in a single item view. Here, you can change the video title to something more meaningful. The feed update where you shared the recording will update instantly with the new name.


NoteScreen and webcam recordings are ready for viewing in compatible browsers as soon as they are uploaded to the feed. For anyone using the non-compatible browsers, they must wait for a conversion process to complete before they can play the video. A preview of the recordings with audio is also available.

10.7.2 Upload supported audio and video files

Videos can be used by learning practitioners as a time-saving, learning tool to support users in their learning environment. Audio files (e.g., for podcasts) are another content alternative for facilitating information delivery or learning. Like videos, audio files can be added to a playlist and have a looped playback.

Accepted Audio File Formats

You can upload the following audio file formats to SAP Jam:

● *.wav● *.mp2● *.mp3● *.m4a● *.wma● *.aac● *.flac● *.ogg

Accepted Video File Formats for non WebRTC technology

You can upload the following video file formats to SAP Jam:

● ASF● AVI: All supported formats● Avid: QuickTime ABVB, QuickTime Meridien, AVI Meridien, OMF ABVB, OMF Meridien, OMF DV50, DS High

Definition● DirectShow: All supported formats● FLV● Grass Valley: GXF MPEG-2● Leitch: MPEG-2, DV25● Media 100: Square, 601● MPEG-1: Elementary Stream, System Stream, Layer II Audio● MPEG-2: SP@ML, MP@LL, MP@ML Elementary Stream SP@ML, MP@LL, MP@ML, MP@HL, HP@HL 4:2:0

Program Stream 4:2:2P@ML, HP@HL 4:2:2 Program Stream SP@ML, MP@LL, MP@ML, MP@HL, HP@HL 4:2:0 Transport Stream 4:2:2P@ML, HP@HL 4:2:2 Transport Stream Layer II Audio, AC3 Audio



● MPEG-4: ISMA, 3GPP, 3GPP2● MXF● Omneon: MPEG-2● Pinnacle: MediaStream● QuickTime: All supported formats● Quantel: Clipnet MPEG-2● SeaChange: MPEG-2, SAF, 4:2:0, 4:2:2, Layer II Audio● Sony: IMX 4:2:2, MXF D-10, VSR2000 High Definition MPEG-2 VOB WAV● Windows Media 8 and 9

NoteThe original file that you upload will be automatically convert to the MP4 format before it's stored in SAP Jam Communities. Therefore, when you download the file, it will download as an MP4 and not the original source that you uploaded. While the SAP Jam Communities video player uses HTML5 to playback the video, the downloaded file is not automatically rendered, and will require a local video player to play offline.

Accepted Video File Formats for WebRTC technology

VP8 video file format is supported for Google Chrome and Mozilla Firefox browsers on WebRTC.

Video and audio Codec support

HEVC(H265), VP9, and OPUS codecs are supported for audio and video file uploads.

Recommended Video Encoding

Recommended setup for audio and video

Video Quality ResolutionVideo Encoding Video Bitrate

Audio Encoding Audio Bitrate Screen Ratio

Low 480p MPEG-4, H.264 2.5 Mbps AAC-LC 384 Kbps 16:9

Medium 720p MPEG-4, H.264 5 Mbps AAC-LC 384 Kbps 16:9

High 1080p MPEG-4, H.264 8 Mbps AAC-LC 384 Kbps 16:9


10.7.3 Thumbnail images

When you create or upload a video, you can customize the thumbnail image that appears when the video displays in widgets and playlists.

Video thumbnails

To select a video thumbnail image

1. Browse to your video file.2. Choose Video Manager > Thumbnails.3. Five thumbnail images will be automatically chosen from frames within your video. You can also upload a

new image and then crop, zoom, or pan the image if necessary. Click one of the images and then click Save.

When the new thumbnail image is used, it is immediately reflected in the video's single item view, multimedia widget, and feed update.



11 Integrations

11.1 Add a SAML Trusted IDP

By registering an external application as a SAML trusted Identity Provider (IDP), you allow the application to access SAP Jam Communities user ID and authorization information. Users then see only the content they are authorized to view when SAP Jam Communities features are integrated into the external application.

To manage SAML Trusted IDPs

1. Go to the SAP Jam Communities Admin console and select Integrations SAML Trusted IDPs from the left side navigation.

2. To add an identity provider, click Register your SAML Trusted IDP near the upper right corner of the page.○ Optionally, beside the Metadata File field, click Browse. Search for the metadata file issued by your

SAML identity provider on your local hard drive and upload it with your browser file upload feature.May fields on the form are automatically filled.

○ In the IDP ID field, enter the URL of your identity provider, or a name that indicates who the SAML trusted ID provider is, or the application name for which the SAML trusted ID provider is providing single sign-on services.

○ In the Single Sign-On URL field, enter the URL used for single sign-on (SSO) with the identity provider (IDP).

○ In the Single Log-Out URL field, enter the URL used for single log-out (SLO) with the identity provider (IDP).

○ In the Default Name ID Format field, enter what name ID format is to be used in an authentication request.

○ In the Default Name ID Policy SP Name Qualifier field, enter the default Service Provider (SP) name qualifier that is to be used in an authentication request.

○ In the X509 Certificate (Base64) text box, enter the Transport Layer Security (TLS) public key certificate string for the client application's API access.

○ Optionally, select the Enabled checkbox to make this SAML trusted IDP immediately available. You can enable or disable the entry in the SAML Trusted IDPs page at any time.

○ Select the Primary checkbox to indicate that this SAML trusted identity provider should be the preferred provider. A secondary provider can be specified, which can be set to ensure access should the primary provider fail.

NoteThere can be only one primary IDP configured within your community.

○ Select the appropriate User attribute used for Name ID. This is the SCIM user attribute to which incoming SAML assertions on the NameID attribute refers whien the NameID format is unspecified.

○ Select the appropriate Issuer namespace:○ Select "Company Specific" if:

○ Your community uses a custom subdomain; or○ Your community's IdP is connected to other SAP Jam Communities instances.

SAP Jam Communities Administration Guide 1902Integrations P U B L I C 131

○ Select "Global" if:○ Your community is using the SAIL or SMI libraries for integration; or○ Your community does not use a custom subdomain.

○ When all of the above settings are complete, click Register to save the record and establish the trust relationship with the SAML Trusted IDP.You are returned to the SAML Trusted IDPs page, with the SAML Trusted Identity Provider record that you just added listed in the catalog.

3. To enable or disable a SAML Trusted IDP, change the slider control in the left-most column of the row for the SAML Trusted Identity Provider for which you want to change its enabled status.○ A disabled SAML Trusted IDP appears gray and displays an "X" to the right of the button. Click the

control to enable the SAML Trusted IDP.○ An enabled SAML Trusted IDP appears blue and displays a checkmark to the left of the button. Click

the control to disable the SAML Trusted IDP.4. To view the information for a SAML Trusted Identity Provider, click Action in the right-most column of the

row for the SAML Trusted Identity Provider that you want to view in the table listing your community's configured IDPs and select View from the menu.The SAML trusted IDP: <SAML_trusted_IDP_name> page displays, showing the details of this SAML trusted IDP configuration.You can either modify the information by clicking Edit or return to the SAML Trusted IDPs page by clicking Back.

5. To edit a configured SAML Trusted IDP, either click click Action in the right-most column of the row for the SAML Trusted Identity Provider that you want to view in the table listing your community's configured IDPs and select Edit from the menu, or click Edit in the SAML trusted IDP: <SAML_trusted_IDP_name> page.The Edit your SAML Trusted Identity Provider page displays, which is effectively identical to the Register a new SAML Trusted Identity Provider page.1. Make whatever changes are required.2. Click Save to save your changes.

You are returned to the SAML Trusted IDPs page, with the modified SAML Trusted Identity Provider record that you just edited listed in the catalog.

6. To delete a SAML Trusted Identity Provider entry, click Action in the right-most column of the row for the SAML Trusted Identity Provider that you want to delete in the table listing your community's configured IDPs and select Delete from the menu.A confirmation dialog box appears. Click Delete to confirm and remove the selected SAML Trusted IDP record.You are returned to the SAML Trusted IDPs page.

11.2 Configure a SAML Local Service Provider

You can configure a SAML local service provider to act as a Service Provider for SAML requests issued to a third-party Identity Provider.

NoteThis feature is available to communities using a third-party identity provider.

To configure a SAML local service provide


Integrations

1. Go to the Admin console and select Integrations SAML Local Service Provider from the navigation.

SAML Local Service Provider configuration

The first three fields of information are URIs that will be needed by the third-party identity provider for it to use SAP Jam Communities as a SAML local service provider (Issuer, Assertion Consumer Service, and Single Logout Service). Take note of these URIs for the configuration of your third-party identity provider.

2. Click Download SP Metadata and use your browser's download file capabilities to save the metadata file to your hard drive.Save this file for the configuration of your third-party identity provider.

3. Click Generate Key Pair to automatically fill the Request Signing Private Key and the Request X.509 Certificate (Base64) text boxes with the required information.

4. Once these steps are done, click Save to store the Request Signing Private Key and Request X.509 Certificate (Base64) so that SAP Jam Communities will work with your third-party identity provider, which you must now configure with the information you noted and downloaded.


11.3 Content syndication

When a content author publishes knowledge base articles within a group in SAP Jam Collaboration, the article can be syndicated so that it also publishes to external community-based groups.

NoteAttachments for knowledge base articles do not appear as a separate group content item when syndicated. As a result, they cannot be edited, moved, or deleted.

Step 1: Enable External Content Publishing in SAP Jam Collaboration

Under the Admin console Product Setup Features , as a company administrator you can enable the Content Syndication option to give all SAP Jam group administrators the capability to allow content syndication of their group's knowledge base articles (and any attachments) to groups in SAP Jam Communities. Any changes made to the content (as deletions, edits) is also syndicated to the external community groups.

Step 2: Enable content syndication for a group in SAP Jam Collaboration

As a group administrator, you can set a permission that enable your group members to make their content available for external publication.

To enable content syndication through external publishing

1. Go to the Group Admin menu and select Edit Group.2. On the General tab, you can select the Content Syndication option to allow publishing of group content to

external communities. Any changes to the content (for example, edits and deletions) will also be propagated to the syndicated content in external communities.

If you choose to disable syndication later on, the knowledge base articles will no longer be syndicated from SAP Jam Collaboration. If you decide to allow content syndication again, you can re-enable this option.

Step 3: Connect SAP Jam Collaboration group to community group in SAP Jam Communities

As a community administrator, in the Admin console you can check the connection for the content syndication configuration.

1. As a group administrator for the community group, go to the Group Admin menu and select Edit Group.2. On the General tab, you can click Add External Group and choose the SAP Jam Collaboration group from

which your community group will receive syndicated content. You can only select from a list of groups in SAP Jam Collaboration where you are the group administrator and have enabled content syndication.


Integrations

Once the group is selected, the list of syndicated knowledge base articles appears under the list of knowledge base articles for the Communities group.

Content Moderation

Content syndication of knowledge base articles in SAP Jam Collaboration and the display of syndicated articles in SAP Jam Communities may be subject to content approval rules:

● If content approval is configured for knowledge base articles only in the SAP Jam Collaboration group, the articles cannot be syndicated until they are approved.

● If content approval is configured for knowledge base articles only in the SAP Jam Communities group, syndicated articles won't display until they are approved.

● If content approval is configured for knowledge base articles in the SAP Jam Collaboration and Communities groups, approval of the knowledge base articles are required in both groups before they are syndicated and available for viewing.

Available actions for knowledge base articles in a community group

Once content is syndicated to communities, the group administrator, content syndication creator (admin who sets up content syndication between SAP Jam Collaboration group and their community group), and group members can perform different actions with that content. The following table states whether or not these users can perform the listed actions within the community.

Actions for a syndicated knowledge base article in a community group

Action Group administrator Content syndication creator Group member

Copy Yes Yes Yes

Delete Yes Yes No

Feature Yes No No

Mirror No No No

View Yes Yes Yes

Knowledge base articles and syndication

Once a group administrator connects a SAP Jam Collaboration group to a SAP Jam Communities group, knowledge base articles will be syndicated. For example:

● When a knowledge base author creates a new article or updates an existing article in the SAP Jam Collaboration group, the same article is automatically created or updated in the SAP Jam Communities group.


● When a group member deletes the knowledge base article in SAP Jam Collaboration, the article is also deleted in the SAP Jam Communities group.

● If there are knowledge base articles that already exist in the SAP Jam Collaboration group, once content syndication is enabled and the group is connected to a SAP Jam Communities group, those knowledge base articles will automatically sync over to the Communities group.

If a knowledge base author publishes an article with embedded images and attachments in SAP Jam Collaboration, the syndicated article will also display the embedded images and attachments in SAP Jam Communities.

You can disable or enable the automatic content syndication in the SAP Jam Admin console IntegrationsContent Syndication page. If the automatic syndication is disabled, you can go to the More menu and choose Sync to manually obtain the latest version. By default, the content will sync automatically. A status message on the progress of the sync action displays above the meta data for the article.

Knowledge base templates

When an article is republished with an updated custom template in SAP Jam Collaboration, the syndicated article in SAP Jam Communities is also updated based on the revised template.

Language bundles

Knowledge base authors or group administrators can set the primary language and provide pre-translated content for an existing knowledge base article in SAP Jam Collaboration. Primary language setting and any languages bundled with a syndicated knowledge base article will also be syndicated to SAP Jam Communities.

Content author and metadata

When knowledge base articles are syndicated to a community, the content syndication administrator (name of the person who created the integration) is attributed as the author of the article in the community. In SAP Jam Collaboration, under the Group Admin settings Edit Group Setup tab, the administrator can designate another group member to be the author of all knowledge base articles.

Select a designate knowledge base author from the group

The knowledge base author or group administrator can choose to publish a knowledge base article directly to a community, or remove the content item.


Integrations

View linked community groups and manage push notification subscription

In the SAP Jam Admin console Integrations Content Syndication page, as a community administrator, you can enable, disable, and view a list of all SAP Jam Communities groups linked to your community. From the Action dropdown menu, you can also test the link connections for each community group.

To edit the push notifications for each group

1. Choose Edit from the Action dropdown menu.2. You can enable or disable any of the content sync notifications for creations, edits, and deletions of

knowledge base articles.

Exceptions

At this time, syndicated knowledge base articles:

● cannot be mirrored within the community.● do not display the source group of the content syndication from SAP Jam Collaboration.● do not include syndication of hashtags, content ratings, categories, and feed items from the SAP Jam

Collaboration group.

11.4 SAP Commerce and External Product Sync

By registering an SAP Commerce (formerly called "SAP Hybris Commerce") instance as an External Product Sync, you allow that instance to synchronize data with your community.

Once SAP Commerce is integrated, data will be automatically synchronized with your community in the following ways:

● Scheduled - Synchronizes all product and image data daily.● Ad Hoc - Synchronizes the current product data with the product card the user is viewing.

Configure your community with SAP Commerce

1. In the menu console under Integrations External Product Sync2. Click + External Product Sync3. Fill in the following fields:

1. Name - Enter a meaningful name that allows administrators to recognize your SAP Commerce instance.

2. Description (optional) - Enter a description of your SAP Commerce instance.3. Base API URL - Enter the absolute URL of your SAP Commerce instance.4. Search API URL - Enter the relative URL for the search API of your SAP Commerce instsance.


5. Single Product API URL - Enter the relative URL for the Single Product API of your SAP Commerce instance.

6. Web UI Path - Enter the Web UI Path of your SAP Commerce instance.4. Click Check Connection to validate the URLs. A Check Connection dialog box appears with "Success" if all

URLs are valid.5. Click Ok to close the dialog box.6. If all URLs are valid click Create. A notication appears that states the integration was created successfully.7. Click Save to return to the External Product Sync page. Your new External Product Sync is listed.

8. If the status for your External Product Sync entry is black, select Action Check Connection to check the connection. The status will become green if the connection check is successful.

9. Your SAP Commerce intergration is successful. Select Action Edit to edit the configuration when required.

Synchronization Errors

Synchronization errors

Status Code Reason Solution

connection_check_in_progress Appears while the connection check is in progress.

Wait for the connection check to complete.

sync_in_progress Appears while synchronization is in progress.

Wait for synchronization to complete.

no_existing_attempt No connection check or synchronization was performed since the last change to the External Product Sync entry.

Run a connection check or wait until the first synchronization is done (max 48 hours).

success The last synchronization was successful.

test_success The last connection check was successful.

server_address_invalid The absolute URL of the SAP Commerce server is invalid.

Check if the URL is correct.

Check if https or http is supported.

search_api_invalid The relative URL of the search API is invalid.


no_valid_json_response_from_search No valid JSON formatted response from the server. The SAP Commerce server could be set up incorrectly or the URL is incorrect.

Make sure the SAP Commerce server is set up to provide a valid JSON response.

Make sure the URL points to a SAP Commerce instance.


Integrations

Status Code Reason Solution

single_product_api_invalid The relative URL of the single Product API is invalid.


no_valid_json_response_from_product No valid JSON formatted response from the server. The SAP Commerce server could be set up incorrectly or the URL is incorrect.

Make sure the SAP Commerce server is set up to provide a valid JSON response.

Make sure the URL points to a SAP Commerce instance.

web_ui_path_invalid The path of the web user interface is invalid.

Check if the path is correct.

read_timeout Read time out during request. If the URLs and paths are correct, there is a problem with SAP Commerce.

all_searches_failed All requests to the search endpoint during a synchronization failed.

A connection check is performed before every sync. So those errors are not a configuration issue.

Check if the SAP Commerce system is still available.

Check for internal errors within SAP Commerce.

Check if there are deleted products that are searchable.

Ask your administrator to check the SAP Jam Communities logs for further details on the error.

some_searches_failed Some requests to the search endpoint during a synchronization failed.

all_single_product_sync_failed All requests to the single product endpoint during a synchronization failed.

some_single_product_sync_failed Some requests to the single product endpoint during a synchronization failed.

unknown_failure Unknown error

11.5 Gamification with BadgevilleAfter Behaviors, Rewards, and Missions are configured by an administrator in the Badgeville Admin Console, as a communities administrator, you can set up the Badgeville integration.

NoteBunchball is not supported with SAP Jam Communities.

To enable Badgeville gamification integration with your SAP Jam service

1. Ensure that Gamification is enabled in the SAP Jam Admin console under Product Setup Features .

2. In the SAP Jam Communities Admin console, you can go to Integrations Gamification Badgeville tab and configure the following:


○ API key: You must have a developer account to view the API keys in Badgeville. Go to the Badgeville Admin console Developer tab Home tab to see the list of API keys.

○ Mapped sites: Select a site you want to map your API key to.○ Status Level: Select the mission you want to be mapped to reputation level displayed on profiles and

other places.○ Notification Stream: Select the stream that tracks the events that the user is to be notified about.

3. Click Save to save the gamification configuration.

When viewing a user's profile page, the earned level, number of points, badges, and missions display. Users can click on Learn about Points and Levels and See all Rewards and Missions for more details on what they can earn with increased participation. On the community user's hover card, the earned status level and number of points displays below their name.

Community user profile page

On a user's member profile page, they can view their achievement level, leaderboard rank (by total number of points), and progress towards rewards (previously referred to as "badges") and mission completion.

The Rewards section displays progress towards "stand-alone" rewards. These are rewards that are not defined as part of any mission.

The Missions section displays progress towards all available missions. A mission can have multiple rewards.

Only simple rewards are supported (a reward containing single behavior criterion).

Users can click on View all Rewards and Missions to view a list of all the rewards they can earn when they participate and complete actions and view the progress of reward achievement within each mission. The steps required to achieve each goal are also listed.

11.5.1 Leaderboard widget

You can display a preconfigured Badgeville leaderboard widget on the community home page or group overview page.

Choose a leaderboard that reflects points based on how you have configured the Badgeville system (for example: All time, Daily, Monthly, or Weekly) time frames. You can display up to a maximum of 25 people in the leaderboard based on points, behaviors, or earned rewards.

For users who are viewing an instance where they are logged in and also ranked in the leaderboard, they will see their position highlighted in the widget.

To include a leaderboard widget on a home page or group overview page

1. In page designer mode, click Add Widget.2. From the Filter & Lists section, select Leaderboard.3. Enter a widget title.4. Select a configured leaderboard from the list.5. Select the maximum number of leaders to display.


Integrations

Leaderboard display selection


12 Compliance and Security

12.1 Terms of service

You can create pages using the rich text editor in the Admin console to host your site's Terms of Service and Privacy Policy pages.

To enable and set the terms of service for your community

1. Click Enable Terms of Service and then select whether the terms are:○ Indirect acceptance of terms of service: When users visit or log in to the community, they are indirectly

agreeing to the terms of service.○ Direct acceptance of terms of service: When users log in to the community for the first time or the

terms of service have changed, they must directly agree to the terms of service before they can enter the community site. If they do not accept, they cannot access the site.

NoteIf the Terms of Service is enabled, but you decide to disable it later on, a prompt notifies you that disabling may affect links in your custom footer.

2. After you select the applicable terms of service option, you can enter the text of the terms within the rich text editor.

3. Click Preview to see how the Terms of Service will display. A new browser tab opens and shows a highlighted message at the top to indicate that you are looking at a preview.

4. When you click Publish, you can accept the default Show Cookies Message option, or disable it so that the message does not appear.

Publish the terms of service with Show Cookies Message prompt


Compliance and Security

5. A URL file path is provided in case you want to use it as a link within the custom footer that's configured on the web branding page, or within the cookies message. Click Copy URL to copy the /terms_of_service path.

Version history

Click the number of versions link above the rich text editor. A version history for each published terms of service displays with the name of the person who lasted updated it and when it was last updated.

12.1.1 Cookies

From the Cookies tab on the Terms of Service page, you can change the default cookies message enter some custom text in the rich text editor.

A preview of the message displays below the editor. If you are satisfied with the message, you can click Publish. If you prefer the default message, click Revert to Default.

Click Show Cookies Message whenever you want to display the cookies, terms of use, and privacy policy messages to the user until they dismiss it.

NoteCookies messages will also display to anonymous users.

12.2 Content administration

Content administration allows administrators to track users with inappropriate posts, review those posts, purge user trash, and view a history of user interaction with community content. Administrators can also enable abuse reporting so that community users can report inappropriate posts.

Enable Content Administration

Content Administration is disabled by default.

To enable Content Administration

1. Go to the Admin console and select Compliance and Security Content Administration from the left side navigation.The Content Administration page displays.

2. Click Enable Content Administration.Content administration is enabled, the button label changes to Disable Content Administration, and any items marked as inappropriate will appear in the Items Pending Review panel.

SAP Jam Communities Administration Guide 1902Compliance and Security P U B L I C 143

Configure Abuse Reporting

Abuse Reporting allows community users to report content as either being spam or as being abusive. Abuse reporting is turned off by default.

To enable and configure Abuse Reporting:

1. In the Compliance and Security Content Administration section, ensure that Content Administration has been enabled (the button at the top of the page should be labeled "Disable Content Administration"), and click Configure Abuse Reporting in the Abuse Reporting tab.The abuse reporting configuration options are displayed in the Abuse Reporting tab.

2. Select the Enable reporting of inappropriate content check box.Below the Enable reporting of inappropriate content check box are two sliding controls.

3. Set the Abusive content reporting threshold by positioning the slider control to the number of reports that you want to require before a particular piece of content is submitted to the community administrator for review.You can set a number from 1 to 10.

4. Set the Spam reporting threshold by positioning the slider control to the number of reports that you want to require before a particular piece of content is submitted to the community administrator for review.You can set a number from 1 to 10.

5. When you have the abuse reporting options set as you want them, click Save changes.Your abuse reporting options are saved and set, and any content that is reported by your users and meets these criteria displays in the Items Pending Review panel, below the configuration options.

Manage Reported Abuses

When users have tagged group activity as spam or abuse the number of times to equal the configured thresholds, the content or feed posts are removed from view and go into a queue for the community administrator to review and decide how to handle, and notifications are sent to the community administrator to let them know there is inappropriate content requiring their review.

To respond to an Abuse Report:

1. Open the Compliance and Security Content Administration section.The reported abuse(s) that users have submitted will appear in the Items Pending Review panel.Each reported piece of content displays as it originally appeared, with the name of the user who posted it, and the date that they posted it. There may also be some details shown of the content, such as the URLs for hyper-linked text or images. Also, the name of the person who reported the abuse is shown, their comment about why they found it inappropriate if they added a comment, and a statement of how long ago the item was marked as inappropriate.When reviewing an item marked as inappropriate, it is not necessary to review the related feed posts. That way, all related comments and posts can be deleted or restored without one-by-one review.

2. Review the item and click the button for the appropriate response:○ Click Restore to return the content to its original location and viewable state.○ Click Delete to remove the content from the community.

As you restore or delete items marked as inappropriate, any related feed items are restored or deleted, respectively.



Purge Settings

The Purge Settings feature allows administrators to permanently delete items in all users' trash that are older than a set age.

1. Open the Compliance and Security Content Administration page, ensure that Content Administration has been enabled (the button at the top of the page should be labeled "Disable Content Administration"), and click the Purge Settings tab.The Purge Settings options are displayed.

2. Select Automatically purge items that have been in the Trash for (configurable) days. to turn trash purging on for all of your community users.

3. Set the number of days to indicate how long items must be in your community users' trash before they are automatically purged.

4. Click Submit.Your community instance will perform a daily purge of all items that have been in your community users' trash cans for longer than the set number of days.

Audit Usage

The Audit Usage feature allows the community administrator to view a single user's complete history of what pages or content (office documents, PDFs, images, videos, blogs, or wikis) that a user has viewed (including other user's profile pages), what comments they have made, what content they have liked, what content that they have uploaded or modified, and what content they have deleted, including user, administrator, and system modified profile information. Audit events contain the user's name, the event type (viewed, added, edited, deleted), and the exact system time when the event occurred. The audit log is not edition specific; it exists in all paid editions.

1. Open the Compliance and Security Content Administration section, ensure that Content Administration has been enabled (the button at the top of the page should be labeled "Disable Content Administration"), and click the Usage Auditing tab.The Usage Auditing options are displayed.

2. Select either User or Content from the top drop-down menu, and type a search string in the adjacent text box.Whether you are performing a usage audit on a user or on a piece of content, you must select the person or content item that you want from the auto-complete drop-down menu for the operation to register the correct object to audit.

3. Select the period that you want the audit to cover from the View drop-down menu. The options are:○ All Usage○ Today○ Last 7 Days○ Last 14 Days○ This Month○ Last 60 Days○ Custom

4. If you selected Custom in the preceding step, you must select the Start Date and End Date from the calendar selectors.


5. Click Audit Usage.The audit is prepared and displayed in the panel below the Usage Auditing options.

6. To download the usage audit, click Download .csv and use your browser's download handling to save the file to your hard drive or to open the .csv file in an associated spreadsheet application.

NoteUsage audits, even as CSV files, can be very large, so ensure that you have plenty of free disk space to save these summaries.

12.3 Compliance monitoring

As an administrator, you can configure a pair of "dictionaries" for Compliance and Profanity against which users' posts can be scanned for matches with the words in the dictionaries. You must first add your community's list of offensive terms and words that might indicate an inappropriate communication (data loss) of sensitive information.

The matching instances are shown in the Pending Flagged Items page. There is a History page where you can view past matches. The Add Compliance Email option allows you to set one or more email addresses that will receive a copy of each feed event or post sent to anyone in your community. Also, there is a link to the Reports page, where you can Download a Compliance Report.

NoteThe compliance and profanity alerts need to be turned on in the Features tab before they will work. Content that has been posted before turning the alerts on will not be scanned or flagged.

Configure the Compliance dictionaries

1. Go to the Admin console and select Compliance and Security Compliance from the left side navigation.

2. Click the Dictionary tab.3. On the Dictionary page, you can do the following:

○ Add one or more terms: Click Add Term at the top of the Dictionary tab. The add terms form displays.1. Select the radio button, Compliance or Profanity, for the dictionary that you want to add a term or

terms to.2. Enter the term or terms (as a comma-separated list; no spaces) that you want to add in the text

box.3. Click Add, or click Cancel to return to the Dictionary tab's terms catalog view.

○ Browse through the terms: The dictionary catalog displays 20 terms per page. By default, these terms are displayed in alphabetical order, although you can change the sort order of the terms by clicking on the catalog table headings (Flag, Terms, and Action). Scroll to the bottom of the page and click Next Page to browser through the full list of terms.



○ Search for a specific term: Near the top of the Dictionary tab, type the term that you are looking for in the text box and click Search. If the term is currently in either dictionary, the dictionary catalog will display only that term. If it is not currently in either dictionary, the catalog will not display and the message Nothing to display will be shown instead.

○ Enable or disable terms: If the dictionary contains a term that you no longer want to be checked in scans, click Disable in the Action column for the row for that term. Click Enable to restore a term to use in scans of users' posts.

NoteThe compliance and profanity alerts do not prevent users from posting inappropriate terms, nor do they send email notifications if users do post inappropriate terms. They only flag instances of users' use of the terms listed and enabled in the compliance and profanity dictionaries.

Set Compliance email recipients

The Add Compliance Email option allows you to set one or more email addresses that will receive a copy of each feed event or private message sent to anyone in your community.

NoteSince routing all feed items can generate a massive amount of data, it is recommended that you specify a dedicated email address for use with this feature.

1. Go to the SAP Jam Admin console and select Compliance from the left side navigation.2. Click Add Compliance Email.3. Enter the email address or list of addresses (as a comma-separated list; no spaces) that will receive a copy

of each feed event sent to anyone in your community.4. Click Save to save the email address or list of addresses, or click Cancel to return to the Compliance page.

NoteTo remove all email addresses from the Compliance Email configuration, repeat steps 1 and 2, then click Clear and Save.

Respond to dictionary matches in the Pending Flagged Items page

The Compliance and Profanity alerts monitors the content posted to SAP Jam and flags items that contain the profanity or compliance terms listed in the compliance dictionaries.

SAP Jam Administrators can view the list of flagged items and perform the following actions:

● Alert: if flagged content is in a group, the group admins are notified; if flagged content is in user's profile, user's manager is notified.

● Ignore: applies to flagged item.

All of these items will remove the alerts from the Pending Flagged Items catalog, but they will remain accessible from the Compliance History catalog.


1. Go to the Admin console and select Compliance and Security Compliance from the left side navigation.The Compliance page displays.

2. In the default view, which is the Pending Flagged Items tab, you can do the following:○ Optionally, you can filter the items shown in the Pending Flagged Items table by selecting an option

from the Show drop-down menus:○ From the first drop-down menu, the options are All Flags, Compliance, Profanity, or Unscannable.○ From the second drop-down menu, the options are Any Date, Today, Within a Week, Within a

Month, or > 1 Month ago.○ For more information on the user, click the hyper-linked term in the Term column.

A Flagged Item Details dialog box displays.Click Close to exit the dialog box.

○ To dismiss a flagged item that is not a problem, select the checkbox on the row for that item and click Ignore.The item is removed from the Pending Flagged Items table.

○ To send an alert message via email to group administrators (for flagged group content) or the user's manager (for flagged content outside of a group), as well as the user, select the check box on the row for that item and click Alert. The email will cite the flagged content and include a hyperlink to go review the post.The item is then removed from the Pending Flagged Items table.

View History


2. Click the History tab.A table, much like the Pending Flagged Items table, displays; however, this table shows all previously flagged items that have been responded to, and the Action column indicates whether they have been set as Ignored or Alerted.

Download a Compliance Report


2. Click Download Compliance Report.The Reports page displays, with the report request form set to produce a Compliance Report.

3. Click Request report.4. Navigate away from the page and return to it after a few minutes, and then click Compliance Report in the

Title column of the listed reports in the Reports page.Use your browser's download options to save the report to your hard drive, or to open the report in an associated application (such as a spreadsheet).



12.4 Security options

Security options include email authentication requirements, domain management, and IP restriction settings.

Set security options

To set security options

1. Go to the Admin console and select Compliance and Security Security from the left side navigation.2. In the top section of the Security page, you can set the following options:

○ Select Require email authentication for new browsers to decrease the possibility of someone gaining access to a user's account without access to their email account. If this setting is enabled, users will be sent an email validation each time they log in from a browser or computer that they haven't used before.

○ Enter a value in the Automatically end a session after a period of inactivity (seconds) field to set the duration of inactivity before the community session logs out a user. For communities signing on through SuccessFactors Platform, this setting must be equal to or greater than the SuccessFactors Platform timeout setting; otherwise, users will be re-signed in automatically with a new session, thus effectively turning off automatic log offs.

3. In the E-Mail Settings options section, you can set the following options:○ Allow members to create content via e-mail—Allows users to create and respond to activities such as

new comments to items they previously posted in SAP Jam.○ Allow Community to send members content via e-mail—Enables automated email notifications.

Whether this option is enabled or disabled, the system still sends emails for group invites and warning emails to community administrators if their extranet user limit is approaching or has been reached, as with disk storage usage.

4. In the Domains section, you can manage domains by using the controls in this section.Here you can control the domains and sub-domains owned by your community. If your community instance was created on the primary domain, any sub-domains will automatically be included in the domain's list. If the instance was created in a sub-domain, you can choose which other sub-domains can access SAP Jam. Additional domains can be added to your community instance to allow users from those domains to join.

NoteYour changes are not immediately implemented because the SAP Jam Communities Customer Support team performs a domain check to verify your ownership of the domain before it is activated.


Trusted Domains settings

To add a new trusted domain to SAP Jam Communities1. Click Add a New Domain; a new row is added to the list of domains.2. Enter the new domain name.3. Press Enter to save.

To remove a domain, click Remove on that domain's row.5. In the IP Restrictions section, select one of the two radio buttons in this section. If you select:

○ Any IP address, then users can log in from any location○ Only these IP addresses, then users can log in from only the IP addresses within your community's

network.

NoteLimiting access to Only these IP addresses, will not exclude usage of any of the external features of SAP Jam, such as external groups or inviting external users to group.

If you do select Only these IP addresses, a table displays beneath the option in which you can do the following:○ Enter an out-going IP address (IPv4) or IP address range (CIDR) for your community in the text box in

the IP Restriction column, and click Save changes to apply your setting.○ Click Clear in the initial row to delete the contents of the text box in that row.○ Click Add a new IP Address to add an additional row.○ Click Remove in any additional rows to remove those rows.



IP Restrictions settings (Only these IP addresses)6. When you have set these options to your satisfaction, click Save changes.

12.5 Legal / disclosures and privacy policy

Any legal statements or disclosures can be entered in the rich text editor on this page. Once the user reads this text on the bottom of the community home page, they can close the message box and it won't appear again. However, if you make any updates to this text, the legal/disclosures prompt will reappear until the user reads and closes the message.

To enter legal copy and disclosure statements (such as a privacy policy)

1. In the Admin console, under Compliance and Security, click Legal/Disclosures.2. From the Privacy tab, you can enter some custom text (or copy and paste formatted text from another

source) into the rich text editor and preview the content. While some template text is provided for you, it is expected that you change this content to follow your community's compliance requirements.

3. Click Preview to see how the Privacy Policy will display. A new browser tab opens and shows a highlighted message at the top to indicate that you are looking at a preview.

4. When you click Publish, you can accept the default Show Cookies Message option, or disable it so that the message does not appear.

5. A URL file path is provided in case you want to use it as a link within the custom footer that's configured on the web branding page, or within the cookies message. Click Copy URL to copy the /privacy path.


13 Reports

13.1 Administrator Reports

SAP Jam Communities administrator reports display information on many aspects of SAP Jam Communities usage, including adoption metrics such as user information, user contribution, and consumption activity, and disk usage statistics. These reports can be downloaded as CSV files. Many reports are also available to Group Administrators for groupspecific data.

NoteReport time frames span a maximum of three months at a time. For example, if you wish to view results for a particular report from January 1, 2018 to May 31, 2018, you would have to generate two reports. The first report would have a date range of January 1, 2018 to March 31, 2018, and the second report would span April 1, 2018 to May 31, 2018.

To run a report

1. From the Admin console, select Analytics Reports from the left side navigation.2. Select the options for the report that you want to run:

○ Select Report: Select the type of report that you want to run from the top drop-down menu.The report types, and in some cases the report parameters, that are available are described below.

○ Specify Date Range: Click the Start Date and End Date fields or calendar icons to select the beginning and ending dates, respectively, for the period to be covered by your report from the pop-up calendar selector widgets. As per the note at the start of this topic, the maximum date range spans no more than three months.

○ Show Report Header: Select this option to include report headings indicating the report name and the settings used for the report (such as the time frame and the group or groups covered).

○ Select Group: Select either All Community or any of the groups that have been created for your community.

3. Once you have set the parameters for the report that you want to run, click Request report.The report is queued to be run. Your report will be run almost immediately, unless there are multiple reports scheduled (queued). Some reports with large amounts of data to process, such as the Group Activity Report, can take up to about an hour to run.Queued and completed reports will be listed in the table below the report options section of the page. These queued and completed reports are visible to all administrators.

4. To download your report, click the name of your report in the table below the report options section of the page, which will open your browser's download options dialog box.It may be necessary to reload the page in your browser to see the results of a recently run report.

NoteIf users copy or move content between groups, this will affect the counts of their activities in reports. For example, a moved document will no longer be counted in the original group, but it will be counted in the new group in which it is located, while a copied document will be counted in both groups.


Reports

13.1.1 Activity summary by month or week

These reports show information on each content creation activity, with one column per week or month in the time period selected.

Report options

The options that are available when these report types are selected are:

● Specify Date Range: The calendar-selected start and end dates for the reporting period.● Show Report Header: Includes report headings that show the report name and the selected report

options.● Type: CSV or XLSX● Select Group: Report on all groups or a selected group.

Report details

Shows a column for each week or month in the selected time period, plus a total for the selected time frame, with a row for each of the following content creation activities:

Activity Summary by Month or Week


Blogs The number of blogs created in the week/month, plus a total for the entire period.

Comments The number of comments made in the week/month, not counting those in Discussions or Ideas, plus a total for the entire period.

Discussion Comments The number of comments made in discussions in each week/month, plus a total for the entire period.

Discussions Created The number of discussions created in each week/month, plus a total for the entire period.

Document Annotations The number of documents annotated in each week/month, plus a total for the entire period.

Documents The number of documents uploaded in the week/month, plus a total for the entire period.

Events Created The number of calendar events created in the week/month, plus a total for the entire period.

Idea Comments The number of comments made in the week/month on ideas, plus a total for the entire period.

Ideas Created The number of ideas created in the week/month, plus a total for the entire period.


The number of knowledge base articles created in the week/month, plus a total for the entire period.

SAP Jam Communities Administration Guide 1902Reports P U B L I C 153


Links The number of links added in the week/month, plus a total for the entire period.

Overview Pages The number of overview pages created in the week/month, plus a total for the entire period.

Images The number of images uploaded in the week/month, plus a total for the entire period.

Polls The number of polls created in the week/month, plus a total for the entire period.

Answers The number of answers to questions added in the week/month, plus a total for the entire period.

Questions Created The number of questions created in the week/month, plus a total for the entire period.

Videos The number of videos created in the week/month, plus a total for the entire period.

Wiki Pages The number of wiki pages created in the week/month, plus a total for the entire period.

13.1.2 Community settings changes

This report shows each community configuration change that has occurred in the specified time period.

Report options

The options that are available when this report type is selected are:

● Specify Date Range: The calendar-selected start and end points for the reporting period.● Show Report Header: Includes report headings that show the report name and the selected report

options.● Type: CSV or XLSX

Report details

Shows a row for each community configuration change that has occurred in the specified time period with the following columns of information:

NoteThere are two sections: general settings changes and "Content Administration Usage" changes.


Reports

Community setting changes

Column item Description

First Name The first name of the user who made the configuration change.

Last Name The last name of the user who made the configuration change.

Email Address The email address of the user who made the configuration change.

User ID The login ID of the user who made the configuration change.

Date The date and time that the configuration change was made.

Setting [General settings only] The configuration setting that was changed.

Original Value [General settings only] The value of the setting prior to the change.

New Value [General settings only] The value of the setting after the change.

Action [Content Administration Usage only] Whether the setting was enabled or disabled (Enable or Disable).

13.1.3 Community user detail

This report shows information on each user with access to SAP Jam Communities.

Report options


● Show Report Header: Includes report headings that show the report name and the selected report options.

● Type: CSV or XLSX

Report details

Shows a row for each user with the following columns of information:

Community user detail


User ID The user's SAP Jam Communities ID.





Title The user's title.


Country The user's country of residence (shown as a 2-letter country code).

Joined? Whether or not the user has logged in to SAP Jam Communities.

First Login At The date and time that the user first logged in at.

Disabled At The date and time that the user was disabled at, if they were disabled.

Last Login At The date and time that the user last logged in at.

Administrator Type The user's member type (User, Support Administrator, or Community Administrator).

Status The user's member status (New, Pending, Active, or Alumni).

Note"New" users have accounts provisioned in SAP Jam but they have not logged in yet, and there have been no received group invitations or other interactions (e.g., profile views, @ mentions) with their account. "Pending" users have not logged in yet, but have been included in a member list on the Send Invites tab, received group invitations or have been @ mentioned.

Invited By A semi-colon separated list of the users that invited this user to join SAP Jam Communities.

13.1.4 Compliance

This report shows information on each outstanding violation (match of terms listed in the compliance and profanity dictionaries) of the compliance rules.

Report options




Reports

Report details

Shows a row for each violation of the profanity and compliance dictionaries:

Compliance

Column item Description

Flag The dictionary type in which the match occurred (compliance or profanity).

Term The full text of the dictionary entry that was matched.

Type The content type in which the violation occurred.

Date The date and time that the violation occurred.

Email Address The email address of the user who committed the violation.

Name The full name (first and last) of the user who committed the violation.

Action The action taken in response to the flag: "Ignored", "Alerted", or null.

13.1.5 Content views by week or month

These reports show information on each content type in the selected time frame, for the selected group or for all groups.

Report options



options.● Type: CSV or XLSX● Select Group: Report on all groups, or a selected specific group.

Report details

Shows a column for each week or month in the selected time frame, with rows of views counts for each of the following content types:


Content views by week or month


Blogs The views of blogs in the indicated week/month, plus the total views for the entire period.

Discussions The views of discussions in the indicated week/month, plus the total views for the entire period.

Documents The views of documents in the indicated week/month, plus the total views for the entire period.

Ideas The views of ideas in the indicated week/month, plus the total views for the entire period.

Knowledge Base Articles The views of knowledge base articles in the indicated week/month, plus the total views for the entire period.

Links The views of links in the indicated week/month, plus the total views for the entire period.

Overview Pages The views of overview pages in the indicated week/month, plus the total views for the entire period.

Images The views of images in the indicated week/month, plus the total views for the entire period.

Questions The views of questions in the indicated week/month, plus the total views for the entire period.

Videos The views of videos in the indicated week/month, plus the total views for the entire period.

Wiki Pages The views of wiki pages in the indicated week/month, plus the total views for the entire period.

13.1.6 Contribution by object by week or month

These reports shows aggregated counts for each type of activity in the selected group or groups in the selected period of time.

Report options





Reports

Report details

Shows columns for each week or month in the selected period, as well as the Total Contribution for the entire selected period.

Shows a row for each of the following activities:

Contribution by object


Blogs The number of created or edited blog posts.

Comments The number of comments.

Discussions The number of discussions.

Documents The number of uploaded documents .

Expertise Added The number of expertise entries.

Expertise Endorsed The number of expertise endorsements.

Ideas The number of added ideas.

Questions The number of asked questions.

Knowledge Base Articles The number of created knowledge base articles.

Links The number of added links.

Images The number of uploaded images.

Polls The number of created polls.

Poll Votes The number of casted poll votes.

Status Updates The number of status updates.

Events The number of created calendar events.

Tags The number of applied tags.

Videos The number of added videos.

Wikis The number of created wiki pages.

Overview Pages The number of created overview pages.

Groups Created The number of created groups.


13.1.7 Engagement

This report shows information on each active user in the community, with metrics for tracking user engagement.

Report options




Report details


Engagement




First Name User first name.

Last Name User last name.

Number of Followers The user's number of followers.

Number of People Following

The number of people followed by the user.

Number of Groups Following

The number of groups followed by the user, as a member.

Number of Groups where the user is the Admin

The number of groups administered by the user.

Number of Wiki Pages Following

The number of wiki pages followed by the user.


Reports

13.1.8 Expertise

This report shows information on each user who has defined an expertise, with details on their listed areas of expertise.

Report options




Report details

Shows a row for each user who has defined an expertise with the following columns of information:

Expertise






Expertise A comma-separated list of the user's areas of expertise.

NoteIf the user has entered these areas of expertise at different times, they will appear as separate entries in the report.

Visible Whether the user's areas of expertise are set as visible to other users, yes or no.

Endorsements The total count of the user's endorsements.


13.1.9 Group activity

This report shows information on each group in your instance of SAP Jam Communities, with counts of the activity within the listed groups.

Report options




Report details

Shows a row for each group in your instance of SAP Jam Communities with the following columns of information:

Group activity


Group ID The numeric ID for the group within SAP Jam Communities.


NoteNon-Public groups will not show the group name unless Include Private Group Details is enabled in the Features tab of the SAP Jam Administration console.

Group Type The group visibility can be "Private" or "Public".

Status The group status can be "Active", "Inactive", or "Deleted".

Group Creator email address The email address for the user who created the group.

Number of Members The current number of users that are members of the group.

Created Date The date and time that the group was created.

Number of Activities in the last 30 days A count of activity events in the group in the last 30 days.

Date of Last post The date and time of the last post event in the group.


Reports


Domains A comma-separated list of the domains in which the group is visible.

Membership The membership type for the group.

Participation Setting The participation setting for this group, which can be "Expert", "Full", "Info", or "Participation Setting".

# Page Views in the last 30 days A count of the number of views of pages in this group in the last 30 days.

# Downloads in the last 30 days A count of the number of content downloads in this group in the last 30 days.

# Unique Members Visited in the last 30 days

A count of the number of unique members who visited the group in the last 30 days.

13.1.10 Group administrators

This report lists all active or alumni status group administrators for each group in your community.

Report options



● Type: Choose to view report in .csv or .xlsx format.

Report details

Shows a row for each group with the following columns of information:

Group administrators


Group name The name of the group.

Group Type Private or Public.

Admin Name First and last name of group administrator.

Admin Email Email address of group administrator



Admin Status Active or Alumni.

Group URL The URL address for the group.

Last Modified Date The date and time for when the group was last modified.

13.1.11 Group member activity

This report shows information on each group member in the specified group and the member's activities in the group.

Report options



● Type: CSV or XLSX● Select Group: Report on all groups, or a selected specific group.

Report details

Shows a row for each group member with the following columns with the following columns of information:

Group member activity


Group ID The numeric ID for the group within SAP Jam Communities.


NoteNon-Public groups will not show the group name unless Include Private Group Details is enabled in the Features tab of the Administration console.

Group Type Private or Public.

Status Active, Inactive, or Deleted.


Reports


User ID The user's username.




User Status Active or Alumni.

Number of Activities in the last 30 days

A count of the user's activities in the last 30 days in the specified group.

Date of Last post The date and time of the user's last activity.

Total number of Activities

A count of the user's activities in the specified group since it's creation.

Group Admin Whether the user is the group's administrator, Yes or No.

13.1.12 Group template activity

This report shows information on each template listed, with one row for each template used in the specified time period.

Report options




Report details

Shows a row for each template used in the specified time period with the following columns of information:


Group template activity


Template ID The numeric ID for the template within SAP Jam Communities.

Template Type Group Template or Custom Group Template.

Template Name The name of the group template.

Language The language in which each group based on the template is in.

Creator The email address of the user who created the template. This is only shown for Custom Group Templates.

Create Date The date that the template was created. This is only shown for Custom Group Templates.

Last Modified The date and time at which the template was more recently changed. This is only shown for Custom Group Templates.

Business Record Dependency

If the template has a business record dependency, the name of the business record type that is shown in the form "<external_application_name> > <business_record_type>"; for example, CRM>Corporate Account.

Visible/Invisible Whether the template has been configured to be visible to users. This is only shown for Custom Group Templates.

Consumption (# of groups created from template)

The number of groups that have been created from this template.

13.1.13 Newsletter subscribers

View a list of subscribers for the entire community or a list of guest users only.

Report options

● Select Member Type: Community or external users

Report details



Reports

Newsletter subscribers


Email Email address of the newsletter subscriber..

13.1.14 Questions

Group and community administrators can view a list of all the answered and unanswered questions that exist in a group in the specified reporting period.

Report options




Report details

Shows a row for each question with the following columns of information:

Question details


Question Title The question title entered in the Title field by the group member.

Question The question entered in the rich text editor and asked by the group member.

URL The URL hyperlink to the question.

Question Status States whether the question is "Answered" or "Unanswered".

Created Time When the question was asked.

Created By The name of the group member who asked the question.

Last Update Time When the question was last updated.

Number of replies The total number of replies to the question.

Forum Topic The name of the forum topic that the question belongs to.



Best Answer The answer marked as best answer.

Best Answer Author The name of the group member who provided the best answer.

13.1.15 Search summary by week or month

View a weekly or monthly report that lists the mostly frequently entered search terms (from the API search, global menu bar, and search results keyword field) over a date range. For each date range, you see the number of times the search term was used.

Report options




Report details

Shows columns for each week or month in the selected period as well as the total count of searches per term for the selected period.

Shows a row for each of the following activities:

Search summary by week or month


Search term The term entered as search criteria.


Reports

13.1.16 Terms of service compliance

This report shows information on each user listed, which are the users who have accepted the Terms of Service set in the Admin Compliance and Security Custom Terms of Service page.

Report options


● Show Report Header: Whether to include report headings that show the report name and the selected report options.


Report details


Terms of service compliance


User ID The SAP Jam Communities user ID of the user who has accepted their Terms of Service.

First Name The first name of the user who has accepted their Terms of Service.

Last Name The last name of the user who has accepted their Terms of Service.

Email Address The email address of the user who has accepted their Terms of Service.

Status The status of the user who has accepted their Terms of Service (Active or Alumni).

Accepted Version The version number of the Terms of Service accepted by the user. Terms of Service are incrementally numbered as they are added.

Accepted Time The time at which the user accepted their Terms of Service.

Link The URL for the Terms of Service accepted by the user.


13.1.17 Top disk usage per group or per user

These reports show information on each user or group listed, depending on which report you selected, which allows you to view how much disk storage is being consumed by by each user or by each group.

Note● In addition to these reports, notifications are sent to community administrators when they are at 80%

and 100% of their storage allocation. If you receive an "80% usage" notification, you should either free up storage by deleting old content or contact your SAP Jam Communities Support representative to purchase more storage space. If you receive a "100% usage" notification, your users will no longer be able to upload content, so acting to resolve the problem becomes vital. These notifications occur daily, are not configurable, and cannot be turned off.

● Data is included for area and community home page content repositories.

Report options


● Show Report Header: Whether to include report headings that show the report name and the selected report options.


Report details

Shows a row for each user or group (depending on the report requested) with the following columns of information:

Top disk usage per group or per user


User ID (User report only) The User ID of the user that is being reported on.

First Name (User report only) The first name of the reported user.

Last Name (User report only) The last name of the reported user.

Email (User report only) The email address of the reported user.

(Group) Name (Group report only)

The name of the reported group.

Last Updated (Group report only)

The date and time that the group's content was last updated.


Reports


Storage Usage (MB) The amount of stored data in megabytes.

Storage Usage in Trash (MB) The amount of data stored in the trash bin of the user or group.

13.1.18 User contribution activity

This report shows information on each user listed, with aggregate counts of the content that they have contributed per type of content in the specified time range, as well as a total count of all content types.

Report options


● Specify Date Range: The calendar-selected start and end dates for the reporting period.

NoteFor this report, the start date and end dates that are selected must be in the same month.


● Type: CSV or XLSX● Select Group: Report on all groups, or a selected specific group.

Report details


User contribution activity


User ID The user's SAP Jam Communities user ID.




Status Active or an Alumni.



Groups Created A count of the groups created in the specified period.

Blogs A count of the blogs posted in the specified period.

Comments A count of the comments made in the specified period.

Discussions A count of the discussions created in the specified period.

Documents A count of the documents uploaded in the specified period.

Expertise Added A count of the areas of expertise added in the specified period.

Expertise Endorsed A count of the endorsements of other users' areas of expertise in the specified period.

Ideas A count of the ideas proposed in the specified period.

Questions A count of the questions asked in the specified period.


A count of the knowledge base articles asked in the specified period.

Links A count of the links added in the specified period.

Images A count of the images uploaded in the specified period.

Polls A count of the polls created in the specified period.

Poll Votes A count of the poll votes cast in the specified period.

Status Updates A count of the status updates made in the specified period.

Tags A count of the tags created in the specified period.

Videos A count of the videos created in the specified period.

Wikis A count of the wiki pages created in the specified period.

Overview Pages A count of the overview pages created in the specified period.

Total Contribution A total count of all content created in the specified period.


Reports

13.1.19 User contribution by week or month

These reports show information on each user listed, with counts of total number of content items contributed shown for each week/month in the time period, as well as a total count for the entire time period. Only users who have contributed at least one item within the requested time frame are listed.

Report options




Report details


User contribution






User Status Active or an Alumni.

(time period) The total number of content items added by the user in each week/month in the specified period.

Total Contribution The total number of content items added by the user in the entire specified period.


13.1.20 User page views by week or month

These reports show information on each user listed, the count of content pages that they have viewed for each time period, week or month, and the total views in the full reporting period. Only users who have viewed at least one item within the requested time frame are listed.

Report options




Report details


User page views






(time period) The total number of content views by the user in each week/month in the specified period.

Total The total number of content views by the user in the entire specified period.


Reports

14 Dashboard

14.1 About the Dashboard

The Analytics Dashboard presents summarized information on SAP Jam activity. Dashboard information is presented in three sections: a top panel, a set of five summary panels that show Login Activity, Groups, Most Viewed Groups, Most Engaging Items, and Most Engaged Members, and a set of six details panels that expand on the summary panels information.

NoteThe data shown in the Analytics Dashboard is updated, at most, every 7 days.

14.1.1 Top panel

The top panel

The information and actions available in the top panel are:

● A dropdown selection for the dashboard timeframe (last 4 weeks, last 3, 6, or 12 months). When you make a selection here, it applies to all other tiles.

NoteYou can change the timeframe selection for individual tiles; those selections will not change the timeframes of other tiles.

● A statement indicating the time interval of the default data sets.● A statement indicating the date that the data was generated. Dashboard data is updated weekly.● A statement indicating if more recent data is available, and a link to update the display with the newer data.● A Print button that displays a print-friendly page and opens a printer selection dialog box.● A Download button to download the following leaderboard metadata to a spreadsheet:

○ Most Engaged Users: Home Page (top 200 list): profile URL, email address, user ID, name, number of views, number of likes, number of comments, items, and total number of activities.

○ Most Engaging Items: Home Page (top 200 list): item URL, item name, content type, contributor, last modified, number of views, number of likes, number of comments, number of versions, and total number of activities.

○ Exported data also indicates whether leaderboard values are from the community home page, the export timestamp, and whether administrators are excluded or included.

SAP Jam Communities Administration Guide 1902Dashboard P U B L I C 175

Analytics Dashboard top panel and summary panels

14.1.2 Summary panels

The summary panels

The information and actions available in the summary panels are:

● Login Activity: (please refer to the Login activity example [page 180] for a sample calculation)○ User accounts: The current total count of activated user accounts on your community's instance of

SAP Jam. Activated user accounts have logged in at least once since the community was created. This number does not include alumni.

NoteThe current total of user accounts is not determined or affected by the dashboard time frame selection.

○ User accounts change: The change in user accounts from the previous period to the current period, as actual numbers and a percentage change.


Dashboard

○ Number of unique logins: The total count of users who have logged in to your community for the selected time frame. The count of unique logins can include logins by users who have deactivated since the selected time frame.

○ Unique logins percentage change: The change in the total count of unique users who have logged in from the previous period to the current period, as actual numbers and a change percentage.

● Groups:○ The total count of active groups in your community in the selected time frame.○ The change in the total count of active groups from The previous period to the current period, as both

actual numbers and as a percentage change.○ A pie chart showing the proportions of private, public, and external groups, with counts of each shown

as pop ups when you place your cursor over the pie segments.● Most Viewed Groups: This panel shows a table of the top 10 most visited groups in the selected time

frame, which includes the following information:○ An icon indicating the type of group (public, private, or external).○ The name of the group (if you have access to that group), which is hyperlinked to the home page of

that group).○ A count of the number of views that each group has received.

NoteYou can filter the group names of the groups that you can access in the type ahead search bar above the chart.

● Most Engaging Items (home page content only):○ An option to filter by content type. The content type that appears depends on what home page content

was uploaded, viewed, liked, and commented on within the selected time frame.○ An option to exclude administrators so that the calculation of the top 10 most engaging items on the

home page for the selected time frame removes all community administrators' contributions.○ Metadata such as content type, item name, contributor, last modified date, number of views, number

of likes, number of comments, uploads, and total number of views, likes, comments, and uploads for home page content.

○ Items are sorted in descending order by total number of activities.

Note○ Custom home page tabs themselves are excluded from community leaderboards.○ Items that are saved to public groups and displayed on the community home page are

excluded from community leaderboards. Those items display on the group leaderboards instead.

● Most Engaged Users (home page content only):○ To be an engaged user, you have to interact with content by viewing it in single item view or a dialog,

edit the content, post comments or reply to comments on the item, like content or feed posts, and vote in polls.

○ An option to exclude administrators so that the calculation of the top 10 most engaged users for the selected time frame removes their names from the list.

○ Metadata such as the user's full name, number of views, number of likes, number of comments, uploads, and total number views, likes, comments, and uploads on content such as:○ documents○ wiki pages and blog posts


○ images○ audio files○ video files○ decision-making tools (decision, poll, pro/con table, and ranking)○ planning tools (agenda, timeline)○ knowledge base articles

○ Users can be sorted in descending order by total number of activities.○ If the "Allow user level reporting" option is not selected, then the most engaging users leaderboard

does not display.● Summary panels include:

○ An information icon in the top right corner of each panel that displays a pop up explanation of the panel data.

○ (Groups panel only) Pop up numbers of each type of group when you place your cursor over each slice of the pie chart.

○ (Most Viewed Groups panel only) Links to the home page of each of the listed groups.○ A View Details link to the detail panel corresponding to each summary panel.

14.1.3 Detailed panels

The details panels

These panels show extended information on the same themes as the summary panels. These panels, in lists and graphs format, give administrators an easy way to detect any trends or changes to the measures and take appropriate action. The values are captured at the end of each week (Saturday).


Dashboard

An Analytics Dashboard details panels (groups)

Detail panels include:

● An information icon in the top right corner of each panel that displays a popup explanation of the panel data.

● Login Activity for active users and unique logins; Groups: Four buttons near the top of each panel that allows you to select time frames of Last 4 weeks, Last 3 months, Last 6 months, or Last 12 months. Popup count numbers for a date on which data was gathered when you place your cursor over any displayed vertical time line.

● Most Viewed Groups: Shows a gray colored horizontal bar to highlight the comparative counts of views for each of the top 50 most viewed groups. Full width is the highest count, with subsequent counts being proportional representations of the counts for each group. A groups dropdown menu allowing you to select a display of either All Groups, Public Groups, Private Groups, or External Groups.

● Most Engaging Items (Home Page): A list of most engaging home page items for a selected time frame of Last 4 weeks, Last 3 months, Last 6 months, or Last 12 months. Click the content dropdown to sort by All Content, Wikis, or Documents. Administrator users can be included or excluded.

● Most Engaged Users (Home Page): A list of most engaged users for a selected time frame of Last 4 weeks, Last 3 months statistics; it displays the current number of users with at least one device, Last 6 months, or Last 12 months. The number of view counts, likes, comments, and uploads are shown to indicate how they engaged with home page content. Administrator users can be included or excluded.


14.1.4 Login activity example

The following example explains how the dashboard calculates its numbers for current users and unique logins.

Scenario

A community has subscribed to 2000 licenses of SAP Jam Communities. This number is not shown on the dashboard. The community instance was created on January 1, 2017. Today's date is December 31st, 2018, which is two years since the tenant creation.

Example login activities

Example login activities, on a weekly basis

Time period Who logged in to SAP Jam Communities?

January 1, 2017 to December 31, 2017 Participants 1 to 100

January 1, 2018 to March 31, 2018 Participants 101 - 500

April 1, 2018 to June 30, 2018 Participants 101 - 500

July 1, 2018 to September 30, 2018 Participants 101 - 300 and 501 - 1000

October 1, 2018 to December 31, 2018 Participants 1001 - 2000

At the end of 2018, participants 1 to 50 left the community and became a community alumni.

What appears on the dashboard

Based on the values in the previous table, the following shows the counts for active users and unique logins.

Login activity values

Time frame selection *Active users Unique Logins

Last 4 weeks 1950 1000

● Participants 1001 to 2000

Last 3 months 1950 1000

● Participants 1001 to 2000


Dashboard

Time frame selection *Active users Unique Logins

Last 6 months 1950 1700 (1000 + 200 + 500)

● Participants 1001 to 2000, Participants 101 - 300, Participants 501 - 1000

Last 12 months 1950 1900 (1000 + 500 + 400)

● Participants 1001 to 2000, Participants 501 - 1000, Employees 101 - 500

*The current users count of 1950 is equal to the total number of active users over time (not dependent upon a time frame selection) minus the 50 alumni.


15 Languages

15.1 About languages

Content can appear in multiple languages across SAP Jam Communities. Preferred languages can be set by community members.

To set a preferred language, click the Settings icon and choose Account to locate your Language settings. Select your preferred language from the list, and click Save changes.

Under Account Settings, all users can override the default language and set their language preferences via the Language selector.

Language Supported in SAP Jam Communities

1 Arabic Yes

2 English (US) Yes

3 Bulgarian Yes

4 Catalan Yes

5 Chinese (Hong Kong) N/A

6 Chinese (Simplified) Yes

7 Chinese (Traditional) Yes

8 Croatian Yes

9 Czech Yes

10 Danish Yes

11 Dutch (Belgium) N/A

12 Dutch (Netherlands) Yes

13 English (Canada) N/A

14 English (India) N/A

15 English (Philippines) N/A

16 English (UK) Yes

17 Finnish Yes

18 French (Belgium) N/A

19 French (Canadian) Yes

20 French (France) Yes

21 German (Austria) N/A

22 German (Germany) Yes


Languages


23 German (Swiss) Yes

24 Greek (Cyprus) N/A

25 Greek (Greece) Yes

26 Hebrew Yes

27 Hindi Yes

28 Hungarian Yes

29 Indonesian Yes

30 Italian Yes

31 Japanese Yes

32 Korean Yes

33 Malaysian Yes

34 Norwegian (Bokmål) Yes

35 Polish Yes

36 Portuguese (Brazil) Yes

37 Portuguese (Portugal) Yes

38 Romanian Yes

39 Russian Yes

40 Serbian (Bosnia and Herzegovina) N/A

41 Serbian (Montenegro) N/A

42 Serbian (Serbia) Yes

43 Slovak Yes

44 Slovenian Yes

45 Spanish (Argentina) N/A

46 Spanish (Chile) N/A

47 Spanish (Columbia) N/A

48 Spanish (Mexico) Yes

49 Spanish (Spain) Yes

50 Spanish (Venezuela) N/A

51 Swedish Yes

52 Thai Yes

53 Turkish Yes

54 Ukrainian Yes

55 Vietnamese Yes

56 Welsh Yes

SAP Jam Communities Administration Guide 1902Languages P U B L I C 183


Number of Languages 42


Languages

16 UI5 Embeddable Widgets

16.1 UI5 Embeddable knowledge base widget

A highly customizable widget that can be embedded in UI5 compatible SAP applications to provide in-context access to relevant knowledge.

This widget supports:

● Knowledge Base articles as well as other content types such as wikis, documents, etc.● Customizations such as widget size, columns, sort options, labels, etc.

For example, when embedded in a UI5 service ticket application, the widget can provide the following benefits:

● Recommend relevant Knowledge Base articles depending on the context of the service ticket.● Provide advanced search with filters for category, tag, group, author, and multiple sort by options.● Enable users to directly view Knowledge Base articles from within the service ticket experience.● Supports attaching the URL of a Knowledge Base article to a service ticket (internal link from SAP Jam

Collaboration and external link from SAP Jam Communities) and other KB article attributes supported by the defaultColumns property of this widget.

Use the instructions in the following tables to configure your knowledge base widget.

Properties

Name Type Default Value Description

jamInstance object Parameters for configuring SAP Jam as a knowledge base repository. Both SAP Jam Collaboration and SAP Jam Communities are supported as the jamInstance for searching Knowledge Base Articles or other SAP Jam content. contentSyndicationInstance is the public SAP Jam community that has content syndication enabled for providing public links to the selected Knowledge Base.

You must peform the following steps to authenticate into your jamInstance and contentSyndicationInstance using a single use token:

1. Generate an OAuth2 Bearer token. [page 194]

2. Use the OAuth2 Bearer token to generate a single use token. [page 240]

3. Use each single use token as shown in the example below.

SAP Jam Communities Administration Guide 1902UI5 Embeddable Widgets P U B L I C 185


Example:

jamInstance: { uri: "https://{jamInstance_domain}", singleUseToken: "{jamInstance_singleUseToken}", contentSyndicationInstance: { uri: "https://{contentSyndicationInstance_domain}", singleUseToken: "{contentSyndicationInstance_singleUseToken}", publicGroup: "{publicGroup_UUID}" }}

Note"publicGroup" must be a public group which has been configured as a content syndication target for the Jam collaboration site.

contentTypes string[] [kb, blog, wiki, document]

Specify types of content in SAP Jam which can be searched in the widget. Available content types:

● kb● blog● wiki● document

defaultColumns string[] [title, group, author, updatedAt]

Specify what columns of SAP Jam content to be displayed as search result. Available columns:

● title● group● type● author● createdAt● updatedBy● updatedAt● likesCount● viewsCount● rating● tags● categories (only for Knowledge Base articles)

jamGroups string[] empty string If provided, search will be limited to these groups only. Default is empty so that the widget will search all available content on SAP Jam for the user.


UI5 Embeddable Widgets


defaultSearchMode

string none supported values:

● none (returns nothing if the searchFieldValue property is empty).

● all (returns all the results if the searchFieldValue property is empty).

widgetTitle string Suggestions from SAP Jam

Title of the widget.

widgetWidth sap.ui.core.CSSSize

100% Width of the widget.

widgetHeight sap.ui.core.CSSSize

100% Height of the widget.

previewWidth sap.ui.core.CSSSize

1000px Width of content preview panel.

previewHeight sap.ui.core.CSSSize

700px Height of content preview panel.

showAdvancedSearch

boolean false Set or get the visibility state of the Advanced Search section which contains custom keyword search and filters.

advancedSearchTitle

string Advanced Search Text of the Advanced Search section.

searchFieldPlaceholder

string Search Text inside custom keyword search box.

filterFields string[] [types, groups, authors, categories]

Specify the filters in Advanced Search section. Available filter fields:

● types● groups● authors● categories● tags

sortFields string[] [relevance, date] Specify sorting field and method. Available sort fields:

● relevance● date● rating

actionColumnTitle string Action Specify the title of column which display action buttons.

pageSize int 20 Maximum number of search result items on one page.

searchFieldValue string empty string


Aggregations

Name Cardinality Type Description

buttons 0..n sap.m.Button The buttons in the action column.

If this aggregation is not set, the action column will be hide. When press the button, "selectedItem" parameter which will be send back to the event. "selectedItem" will contain the info for content.

Example for selectedItem

{ "jamContentInfo": { "id": "GqBoZJElcNOXWpknW783Pg", "type": "Article", "title": "SAP Jam Content Sample", "content": "Content of SAP Jam Content Sample", "group": { "group_name": "Collaboration Content", "group_id": "x9z4xtZ26gpIqQYICVU5dX" }, "tags": [], "categories": [], "creator": { "creator_name": "Carla Grant", "creator_id": "uD0JJ6GaHNbJPoHdRVlgTo" }, "created_at": "2018-12-19T02:59:59Z", "updated_at": "2018-12-19T03:00:00Z", "is_deleted": false, "locale": null, "last_updated_by": { "updator_name": "Andrew Anderson", "updator_id": "uD0JJ6GaHNbJPoHdRVlgTo" }, "href": "http://{jamInstance_domain}/articles/GqBoZJElcNOXWpknW783Pg", "views_count": 5, "likes_count": 0, "rating": 0 }, "syndicatedContentInfo": { "id": "IY7g2Qj38o5qOfErhYyGBu", "href": "http://{contentSyndicationInstance_domain}/articles/IY7g2Qj38o5qOfErhYyGBu", "group": { "group_name": "Community Group", "group_id": "YNvrWwb3igrJ5rEBqEQcHE" } }}


UI5 Embeddable Widgets

How to setup the widget

1. The widget library URL is at: https://{jamInstance_domain}/widget/jamWidget2. Add the library to the project's resourceRoots:

window["sap-ui-config"] = { ... resourceRoots: { "app": "app", "jamWidget": "https://{jamInstance_domain}/widget/jamWidget" }, ... };

3. The widget id is "JamKBWidget". Render the widget as a standard UI5 project:

<mvc:View ... xmlns:jamWidget="jamWidget" > <jamWidget:JamKBWidget id="JamKBWidget" jamInstance="{/jamInstance}" widgetWidth="auto" widgetHeight="600px" pageSize="10" defaultColumns="title,group" > <Button text="Attach" press="handleAttach" > </jamWidget:JamKBWidget> </mvc:View>


17 SAP Jam Communities API

17.1 About the SAP Jam Communities API

The SAP Jam Communities OData API allows you to integrate SAP Jam Communities features into your business critical applications, and it allows you to integrate data from your business critical applications into SAP Jam.

This part of the SAP Jam Communities Administration Guide provides the following sections of API Documentation:

● Please see the SAP Jam Communities API Reference at https://developer.sapjam.com/communities/ODataDocs/ui.

● Introduction to OData [page 190]: Provides a conceptual introduction to OpenData (OData) APIs● Authentication and Authorization API [page 194]: Client applications using the SAP Jam REST or OData

APIs have two options for providing authorization and authentication for their users: an OAuth1.0a 3-Legged workflow, or SAML assertions from a trusted identity provider. The OAuth1.0a workflow is best for client applications without access to a SAML identity provider (IDP), although it requires some interaction with the end user. The SAML assertions from a trusted IDP configured in the SAP Jam Admin console by your company administrator. Additionally, there is the possibility of single-use tokens, although this approach is better suited to granting immediate, short-term access to single pages.

17.1.1 SAP Jam Communities API Reference

Please see the SAP Jam Communities API Reference at https://developer.sapjam.com/communities/ODataDocs/ui

17.1.2 Introduction to OData

This section provides an introduction to the Open Data (OData) protocol, which is a highly formalized implementation of the Representational State Transfer (REST) protocol.

This section contains the following pages of information:

● General information:○ Open Data (OData) protocol Specifications [page 191]: provides links to the OASIS OData

specification documentation that the SAP Jam OData API is based on.○ OData terminology [page 191]: is drawn from Atom (XML), JSON, and HTTP, although the usage is not

always the same.● Understanding the OData $metadata file [page 192]: The OData $metadata file is a CSDL file that is made

available to clients to help them discover an OData API's structure and organization.


SAP Jam Communities API

https://developer.sapjam.com/communities/ODataDocs/ui

https://developer.sapjam.com/communities/ODataDocs/ui

● Use of curl commands [page 193]: This tutorial uses curl commands to summarize the information that must be passed to make an effective API call. A curl command (sometimes pronounced "see-URL") provides a concise view of exactly what elements have to be passed in the API call. This is most helpful if you are using lib-curl for your encoded API calls, although other options are available.

17.1.2.1 Open Data (OData) protocol Specifications

The Open Data (OData) protocol was originated by Microsoft and SAP. It is now developed and maintained by OASIS. OData is based on the Atom Publishing protocol. It provides a very formalized, welldefined approach to creating a ReSTful web API. The OData specification requires that APIs be available in either XML (AtomPub) or JSON formats. The SAP Jam OData API conforms to the OData version 2 specification, although it is subject to change in the ways allowed by the OData version 4 specification, with regard to adding new properties, navigations, and entity types. Every effort is made not to break backwards compatibility, but security issues that require a breaking change will be made.

The key specifications used in OData API development and usage are listed here for your reference:

● RFC 2616, Hypertext Transfer Protocol, HTTP/1.1 ● RFC 4627, The application/json Media Type for JavaScript Object Notation (JSON) ● RFC 5023, Atom Publishing Protocol ● The OASIS OData Technical Committee web site ● OData.org

○ OData Version 2.0 ○ OData Overview ○ OData URI Conventions ○ OData Terminology ○ OData Operations ○ Atom Format ○ JSON Format

17.1.2.2 OData terminology

OData terminology is a bit confusing as it is drawn from its various constituent technologies, which don't always use the same terms.

To illustrate these issues, the common OData terms, as well as some approximate equivalents from Atom (XML), JSON, and HTTP usage are shown in the following table.

OData (with definition) Atom (XML) JSON HTTP

property: an attribute-value pair that describes a single quality of a resource

property property (no equivalent)

SAP Jam Communities Administration Guide 1902SAP Jam Communities API P U B L I C 191

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.ietf.org%2Frfc%2Frfc2616.txt

http://help.sap.com/disclaimer?site=http%3A%2F%2Ftools.ietf.org%2Fhtml%2Frfc4627


http://help.sap.com/disclaimer?site=https%3A%2F%2Fwww.oasis-open.org%2Fcommittees%2Ftc_home.php%3Fwg_abbrev%3Dodata

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2F

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-2-0%2F

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-2-0%2Foverview%2F

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-2-0%2Furi-conventions%2F

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-2-0%2Fterminology%2F

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-2-0%2Foperations%2F

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-2-0%2Fatom-format%2F

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-2-0%2Fjson-format%2F

OData (with definition) Atom (XML) JSON HTTP

entity, resource, or object: a network-accessible data object or service that can be identified by a URI; typically a resource is described by a predefined set of properties (from HTTP)

entry (also used in OData) object resource (entity differs)

EntityType: the abstract data model of a type of resource

(no equivalent) (no equivalent) (no equivalent)

collection: a set of resources, often returned to a GET request for a certain type of resource

feed array of objects (no equivalent)

Additional terms relevant to OData API usage are:

● Collection-valued API calls: are API GET calls to an entity that do not specify a single resource, such as [GET] /Groups. These calls will return a feed or collection of resources. For example, the Groups that the currently logged-in user has access to.

● Binary Large Objects (BLOB): are binary data that is stored as a single entity (a file), typically graphics, videos, office documents, and PDFs.The OData specification describes Creating Media Link Entries (MLEs) in section 2.5 of the Operations page.Note that API clients should be able to follow redirect responses, which are required to improve the performance of Content Distribution Networks (CDN).

For more information, see OData Terminology .

17.1.2.3 Understanding the OData $metadata file

The OData $metadata file is a CSDL file that is made available to clients to help them discover an OData API's structure and organization.

CSDL

The Conceptual Schema Definition Language (CSDL) is an XML-based language that describes the entities, relationships, and functions that make up the conceptual model of a data-driven application.

● CSDL v3 Specification



http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-2-0%2Foperations%23CreatingMediaLinkEntries

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-2-0%2Fterminology%2F

http://help.sap.com/disclaimer?site=https%3A%2F%2Fmsdn.microsoft.com%2Fen-ca%2Fdata%2Fjj652004.aspx

OData $metadata

While the $metadata file is primarily intended for client application use, it does provide human-readable information on the remote application's API. The sections of information that provides are as follows:

● EntityType: Describes each entity, its properties (including information on its data type, and whether it is nullable in POSTs, filterable or sortable in collection-valued GETs, and whether it is updatable [can be PATCHed]), and its navigations.

● Association: Provides details on each navigation available in the API, including its role, type, and multiplicity. (Role can be "Creator" while type is "Member", for example; multiplicity indicates the number of resources that can be involved at each "end" of the association or navigation.)

● EntitySet: Provides a concise listing of all the entities available in the API, with information on their name, entity type, and whether they are creatable, updatable, or deletable.

● AssociationSet: Provides further details on navigations, including whether each navigation is creatable, updatable, or deletable.

● FunctionImport (Service Operations): Provides information on each service operation available in the API, including their name, HTTP method, the entity that they act on, the name and data type of any required parameters and the type of data that they return, if any (such as data type, entity type, and whether the return is a collection).

Note that this information is what informs the entity diagrams at the beginning of each "examples type" lesson, and provides much of the information shown in the various property lists and tables used throughout this tutorial. Once you are familiar with the SAP Jam OData API, you will not have any need for the $metadata file information or the diagrams, tables, and lists in this tutorial, as this information is also shown in the SAP Jam OData API Reference.

17.1.2.4 Use of curl commands

This tutorial uses curl commands to summarize the information that must be passed to make an effective API call. A curl command (sometimes pronounced "see-URL") provides a concise view of exactly what elements have to be passed in the API call. This is most helpful if you are using lib-curl for your encoded API calls, although other options are available.

The curl command options are always shown is the same order so that you can quickly evaluate what the different requirements are for each call. These options and their order are:

● -i — (include [the HTTP header]) [curl only]: includes the HTTP responses, some server information, and some request and response data in the response. (Note that none of this information is shown in any of the examples in this tutorial.)

● -H "Authorization: Bearer " — (header) [Required]: the SAP Jam OData API requires either OAuth 1.0a or 2.0 authentication to respond to an API call.

● -H "Content-Type: application/{atom+xml|json}" — (header) [Required for POST and PATCH requests]: indicates the MIME type of the body of the request or of the file to be uploaded.

● -H "Accept: application/{atom+xml|json}" — (header) [Optional]: indicates the acceptable Content-Types for the response. OData APIs default to XML, so if you want JSON, you must either specify it in this header or set that as a query option in the URL.

● -H "Stub: {file_name}" — (header) [Required for API calls that upload of download files (POSTs or PATCHes and GETs)]: indicates the filename (less the extension) that will be used in SAP Jam for an uploaded file.

● -X {POST|PATCH|DELETE} — (request) [Required for POSTs, PATCHes, and DELETEs]: used to indicate some other HTTP method than GET, which is the default if this option is not specified.

● "{the_API_call_URL}" (URL) — [Required]: this must be the full URL of the API call.● -d — (data) [Required for POSTs and PATCHes]: this is the data used to create (POST) or update

(PATCH) a resource. The -d option is typically formed in one of the following ways:○ -d "{ \"Name\":\"Customer Requests Discussions Group\" }" — a short bit of JSON data

included in the curl command.○ -d "<Name>Customer Requests Discussion Group</Name>" — a short bit of XML data

included in the curl command.○ -d@C:/{path_to_payload_file}/{payload_file_name}.json — a longer bit of JSON content

sent in a payload file.○ -d@C:/{path_to_payload_file}/{payload_file_name}.xml — a longer bit of XML content

sent in a payload file.● -x <proxy.myorg.com:8080> — (proxy) Required only if your network is behind a web proxy. Should

show the host, subdomain, domain, and port of the proxy. The proxy option is not shown in any examples in this tutorial, but it may be required to work in your organization.

17.1.3 Authentication and Authorization API

Client applications using the SAP Jam REST or OData APIs have three options for providing authorization and authentication for their users: an OAuth 2.0 Alias User workflow, an OAuth1.0a 3-Legged workflow, or an OAuth 2.0/SAML workflow that uses a SAML bearer assertion from a trusted identity provider to obtain an OAuth2 access token.

The OAuth 1.0a workflow is best for client applications without access to a SAML identity provider (IDP), although it requires some interaction with the end user. Both of the OAuth 2.0 workflows do not require any interaction from the user but they do require additional setup in SAP Jam by your company administrator. Additionally, there is the possibility of single-use tokens, although this approach is better suited to granting immediate, short-term access to single pages.

The following resources are available for these workflows to help get you started:

● Alias User OAuth 2.0 Authorization Tutorial [page 194]● Get an SAP Jam OAuth2 Access Token from a SAML Assertion with a CLI [page 232]● OAuth 1.0a Authorization Tutorial [page 206]● Java Sample - jam_java_oauth1_client● Java Sample - jam_java_oauth1_hmac_sha1_client_sample-SHA1

17.1.3.1 Alias User OAuth 2.0 Authorization Tutorial

SAP Jam supports the use of OAuth 2.0 Authorization for Alias Users. Alias users provide an easy way to allow bots or groups of users to securely interact with SAP Jam through 3rd party applications.



http://help.sap.com/disclaimer?site=https%3A%2F%2Fgithub.com%2FSAP%2FSAPJamSampleCode%2Ftree%2Fmaster%2FOAuth_1_HMAC-SHA1%2Fjam_java_oauth1_client

http://help.sap.com/disclaimer?site=https%3A%2F%2Fgithub.com%2FSAP%2FSAPJamSampleCode%2Ftree%2Fmaster%2FOAuth_1_HMAC-SHA1%2Fjam_java_oauth1_hmac_sha1_client_sample

Create the Alias User OAuth 2.0 key

Perform steps 1 and 2 from Add an OAuth Client [page 195].


Perform steps 1 - 4 from Alias Accounts [page 197] and copy the alias user OAuth2 Access Token.

Call the API with a 3rd party OData client

Add the following HTTP headers to your 3rd party OData client:

● Authorization: Bearer {Paste_Alias_User_OAuth2_Access_Token_Here}● Accept: application/json● ContentType: application/json

Go to HTTP headers [page 199] for more information.

Make OData API calls using the following base URLs:

● Collaboration:○ (Cloud Platform) https://developer.sapjam.com/api/v1/OData/○ (Data Center) https://{jam#}.sapjam.com/api/v1/OData/○ (Custom Domain) https://{custom_domain}/api/v1/OData/

● Communities:○ (Custom Domain) https://{custom_domain}/api/v1/OData/

Go to URLs and URL parameters [page 200] for more information

17.1.3.1.1 Add an OAuth Client

You can authorize an external application to access the SAP Jam API by registering the application as an OAuth client.

To manage OAuth Clients

1. Go to the SAP Jam Admin console and select Integrations OAuth Clients from the left side navigation.


OAuth Clients catalog

This page presents a catalog of previously configured OAuth Clients, with UI controls that allow you to View, Edit, or Delete existing OAuth Clients, or to add a new OAuth client (Add OAuth Client).

2. To add an OAuth client, click Add OAuth Client at the upper right corner of the page.The Register a new OAuth Client page displays.○ In the Name field, enter a meaningful name that allows company administrators to recognize what the

client is.○ (Optional) From the Feed Filtering dropdown menu, select either none or SAP CRM.○ In the Integration URL field, enter the URL to the client application API metadata.○ (Optional) In the Callback URL field, enter the callback URL for the client application API calls.○ (Optional) In the Support URL field, enter the support URL for the client application API.○ (Optional) Select the Can Suppress Notifications checkbox to allow the suppression of notifications

from external data sources that use this OAuth client. It is up to the developer of this external application integration whether they disable notifications or not, but this setting determines whether notification suppression is permitted from this external application.

○ (Optional) Select the Can Suppress Webhooks to allow the suppression of webhooks for specific OData calls in the OAuth client. It is up to the developer of this external application integration whether they disable webhooks or not, but this setting determines whether webhook suppression is permitted from this external application.

○ (Optional) In the X509 Certificate (Base64) text box, enter the Transport Layer Security (TLS; supersedes SSL) public key certificate string for the client application API access.

○ (Optional) The Administrative Area dropdown menu allows you to select the area in which you want this OAuth Client configuration to be available. The default is "Company", which makes it available to all groups and areas. Selecting a specific area limits the scope of the OAuth Client configuration and limits the management of that configuration to either area administrators assigned responsibility for that area or to company administrators.

○ When all of the above settings are complete, click Save to save the record and establish the trust relationship with the OAuth client application.You are returned to the OAuth Clients page, with the OAuth client record that you just added listed in the catalog.

3. To view the information for an OAuth client, click View on the row for the OAuth Client that you want to view.The OAuth Client: <OAuth_client_name> page displays.The Create/Delete OAuth2 Access Token is only available via developer.sapjam.com. Copy the OAuth2 Access Token for use in manual API calls. For example, you can paste this token into the SAP Jam API



Reference documentation to try out the API endpoints. Once you have copied it, you can delete by clicking Delete OAuth2 Access Token.You can either modify the information by clicking Edit or return to the OAuth Clients page by clicking Back.

4. To edit an OAuth client record, either click Edit in the OAuth Clients page or in the OAuth Client: <OAuth_client_name> page.The Edit your OAuth Client page displays, which is effectively identical to the Register a new OAuth Client page.1. Make whatever changes are required.2. Click Save to save your changes.

You are returned to the OAuth Clients page, with the modified OAuth client record that you just edited listed in the catalog.

17.1.3.1.2 Alias Accounts

Company administrators can now create up to 100 alias user (role-based or mailbox) accounts where one or more SAP Jam users can be assigned to use the alias user account in a formal capacity on behalf of their organization. An alias user account enables employees to easily identify a point of contact for specific interaction. For example, for new hire employees of a large, global organization, it is easier to contact a user named "HR Helpdesk" with HR related questions than it is to find out the name of the exact person.

Alias users can also be used as a system user (for example, program, bot) to work with other applications. In many SAP applications, this type of user is referred to as a technical user.

For more information on alias account configuration, please refer to the Developer guide topic,Webhooks - Alias Users.


To create an alias account

1. Go to the SAP Jam Admin console and choose Users Alias Accounts .2. Click New Alias Account. Complete the following steps for the Basic Profile section:

○ Below the automatically generated Alias User ID, enter the Alias Account Name. This name will be visible and used for interaction.

○ Enter some text to describe the purpose of the alias in the Description text box.○ Click Save changes to save the basic profile information. You can return to this section later to enter

more information after you save information in the other sections of this account configuration.3. Complete the following steps for the Users section:

○ In the Add users to alias account text field, enter the name of each user that you want to add to the alias account. If you want to remove any of these users, then click Remove beside their name in the Users list.

○ Click Save changes to save the users information.4. Complete the following steps for the API Access section and when the alias user is defined as a system

user (e.g., bot):○ Click Add OAuth2 Access Token.


https://help.sap.com/viewer/u_collaboration_dev_help/a711035f7d824819a38764b530e0b5a9.html

https://help.sap.com/viewer/u_collaboration_dev_help/a711035f7d824819a38764b530e0b5a9.html

○ From the drop-down list, select the OAuth client and then click OK. The token information will update and display in this section, along with the name of the OAuth client.

5. Complete the following steps for the Email Settings section:○ From the dropdown list, you can choose to enable or stop all email notifications.○ Click Save changes to save the email settings.

6. Complete the following steps for the Org Chart section:○ Enter the name of the Manager for the user(s) of the alias account, or select the I have no manager

option.○ Enter the names of the Direct Reports for the user(s) of the alias account, or select the I have no direct

reports option.○ Enter the names of the Assistants for the user(s) of the alias account, or select the I have no assistant

option.○ Click Save changes to save the organizational chart information.

7. Complete the following steps for the Contact Information section:○ Click Add an email to enter a home, work, or other email address.○ Click Add a phone to enter a home, work, mobile, fax or other phone number.○ Click Add an IM to enter a preferred messaging account (for example, Google Talk).○ Enter any Mobile or LinkedIn information.○ Click Save changes to save the contact information.

8. Complete the following steps for the Basic Profile Information section:○ Choose the Member Status from the dropdown list.○ Enter the First Name, Last Name, and Nickname for the alias user, or accept the previously entered

Alias Account Name that's listed in the First Name text box.○ Enter the Job Title for the alias user.○ Choose a Start Date from the calendar.○ In the Job Description text box, accept the Description you entered previously for the alias user

description, or enter a new description.○ From the Administrator Type drop-down menu, select Company Administrator, Support Administrator,

or User.○ If required, you can set a new password on the account by clicking Send Password Reset Email.○ Click Save changes to save the basic profile information.

Once a user is assigned to an alias user account, they will be able to go the the gear icon above the global menu bar and select their alias user account, under the Switch User section of the menu. A banner appears above the Search field to indicate that the user is "Currently acting as an Alias User". Alias users can create groups and design group pages with their group administrator privileges.

Edit an alias account

To edit an alias account

1. On the Alias Accounts page, beside the alias account that you want to modify, choose Action Edit .2. Edit the basic profile, users, API access, email settings, and contact information.3. Click Save changes to save the profile changes.



Delete an alias account

To delete an alias account

1. On the Alias Accounts page, beside the alias account that you want to delete, choose Action Delete .2. Click Confirm on the delete confirmation message to remove the alias account.

17.1.3.1.3 HTTP headers

HTTP headers are used to specify several aspects of an API call's operation.

The HTTP headers used by the SAP Jam OData API include:

● Authorization: OAuth {OAuth1.0a_protocol_parameters} This provides user authorization using OAuth 1.0a, for example:

Authorization: OAuth oauth_consumer_key="J2iLG8a8xZPtqBIfHjIm", oauth_nonce="RPUt7ytQ9w", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1316135320", oauth_version="1.0", oaccess token="vbXkQoSkIqyYIxwI2I2u", oauth_signature="P5scFJf6CZlBBMELB9kb%2FvM0ktQ%3D"

● Authorization: Bearer {OAuth_bearer_token} This provides user authorization using OAuth 2.0, for example:

Authorization: Bearer As3UvIaYEvDXoeREtmSz3qeCpnNvrrHZhVMswcBV

● Accept: {application/json|application/atom+xml} This header allows you to specify what is an acceptable response to your API call: the XML or JSON format. This option is preferred to using a query option of ?$format=json. Note that the default format for OData API calls is XML, so that does not need to be specified unless you want to use JSON. To do so, specify that responses be in JSON format in the HTTP Accept header. For example:

Accept: application/json

The XML option, while not required, would be:

Accept: application/atom+xml

● ContentType: {MIME_type} Informs the API that you are sending content in a specific format in the request. This must be specified as the MIME type for the content that you are submitting. Valid options include:○ application/json○ application/atom+xml○ text/html○ text/html;type=wiki○ text/html;type=blog○ image/png○ image/jpg○ video/mp4


○ application/vnd.ms-powerpoint○ application/vnd.openxml-formats-officedocument.presentationalml.presentation

For example:

ContentType: image/png

The above examples are all valid, but the list of supported MIME types is far from complete.● SAP-JAM-CONTENT-ADMINISTRATION: {true} This header allows company administrators to enable

content administration on their company for this request. With content administration enabled, company administrators can perform CRUD operations to all groups and content within their company regardless of group membership.○ Example 1 - Show all Content Items in a group that the company administrator is not a member of.

Request Url: GET {{api_url}}/Groups('{{Id}}')/AllContentItemsHeader: Authorization: Bearer {OAuth_bearer_token}Header: SAP-JAM-CONTENT-ADMINISTRATION: true

○ Example 2 - Search for all Content Items in a group that the company administrator is not a member of.

Request Url: GET {{api_url}}/Search?Query='{{search_item}}'Header: Authorization: Bearer {OAuth_bearer_token}Header: SAP-JAM-CONTENT-ADMINISTRATION: true

○ Example 3 - Delete an item in a group that the company administrator is not a member of.

Request Url: DELETE {{api_url}}/ContentItems(Id='{{Id}}',ContentItemType='{{Type}}')Header: Authorization: Bearer {OAuth_bearer_token}Header: SAP-JAM-CONTENT-ADMINISTRATION: true

● Slug: {file_name_without_extension} "Slug" is an HTTP header used in the SAP Jam Collaboration OData API as the name of the file used in SAP Jam. In an upload (a POST), the Slug header would be set as "profilePhoto" if that is the name you want the resource to appear as in SAP Jam. In an update (a PATCH) or a download (a GET), the Slug header would be set as "profilePhoto" if you want to update (re-upload) or download a file of that name in SAP Jam Collaboration. For example:

Slug: profilePhoto

17.1.3.1.4 URLs and URL parameters

OData APIs are accessed via a URL that calls a specific endpoint and has the required URL parameters properly set. There are different forms of URL for each of several specific types of operation.

The most basic API call specifies an entity, but not a specific resource. This is done for POST operations where a new resource has not yet been assigned a unique ID by SAP Jam, and in collection-valued GET requests, from



which you want to retrieve a collection (or feed) of the available resources of that entity type. The basic parts of such a simple request (get me the available groups) are:

service root

Identifies the data center or server of an OData service and location of the API in that data center or server. A generalized form of the service root URI is shown for the SAP Jam OData API.

resource path

Identifies the resource to be interacted with. In the preceding diagram, the resources involved are one or more ContentItems in the SAP Jam Group that is specified by its unique ID.

Note that the combination of the HTTP method and a generalized form of the resource path is used as the signature of the endpoints in the SAP Jam OData API.

{jam#} usage in the URLs (data centers)

SAP Jam Collaboration services are located in data centers in various locations around the world. Your organization's SAP Jam service will be at one of these locations, which must appear in the URL of your API calls, and which is indicated in this documentation by {jam#}, which is always in the form "jam#", in which "#" represents the 1 or 2 digit number of the data center in which your organization's SAP Jam instance is hosted. View the URL of any of your organization's SAP Jam pages to find your SAP Jam data center number.

Unique IDs

To identify a specific resource, the SAP Jam OData API uses 22-character unique identifiers for the various accessible objects in SAP Jam Collaboration. This is shown in the following URL diagram:


For most entities, the unique ID alone is sufficient to identify a specific resource, but for some entities two attribute-value pairs are required. These one or two properties are commonly termed the "key" for the resource, and the key value, or values, must be set in the URL of an API call to indicate exactly which resource to perform the API call operation on. The entities that require two attribute-value pairs to identify a specific resource, and the attributes that they use are as follows:

● ContentItem(Id='{Id}',ContentItemType='{ContentItemType}'), where the '{ContentItemType}; can be "Page", "BlogEntry", "Document", "Tool", or "Poll".

● ContentListItem(Id='{Id}',ContentListItemType='{ContentListItemType}'), where the {ContentListItemType} can be "Page", "BlogEntry", "Document", "Tool", or "Poll".

● EventResponse(RepondentId='{RespondentId}',EventId='{EventId}')● Folder(Id='{Id}',FolderType='{FolderType}'), where the {FolderType} can be "Folder" or

"PrivateFolder".● GroupExternalObject(GroupId='{GroupId}',ExternalObjectId='{ExternalObjectId}')● GroupMembership(GroupId='{GroupId}',MemberId='{MemberId}')● GroupTemplate(Id='{Id}',GroupTemplateType='{GroupTemplateType}'), where the

{GroupTemplateType} can be "system" or "custom".● Kudo(Id='{Id}',KudoType='{KudoType}'), where the {KudoType} can be "system" or "custom".● ObjectReference(Id='{Id}',Type='{Type}'), where the {Type} can be "Member", "Group",

"WallComment", "Event", "Task", "MemberKudo", "Comment", "FeedEntry", "ForumItem", or "ContentItem".

● TaskAssignment(AssigneeId='{AssigneeId}',TaskId='{TaskId}')● ThumbnailImage(Id='{Id}',ThumbnailImageType='{ThumbnailImageType}'), where currently

the only valid value for {ThumbnailImageType} is "48x48".● ThumbnailKudoImage(Id='{Id}',ThumbnailImageType='{ThumbnailImageType}'), where

currently the only valid value for {ThumbnailImageType} is "48x48".

For the specification reference, see http://www.odata.org/documentation/odataversion30/commonschemadefinitionlanguagecsdl/#csdl6.2 .

navigations

Navigations are URL extensions from the base entity to closely related entities. They can be named according to their "role", for example, one navigation from the Group entity is to a "Creator", which is the role, but which returns the "Member" information on the individual who created the group. Every entity has a predefined set of navigations. For example, the Group entity has the following navigations:

● Role: AllContentItems (Entity: ContentItem)● Role: AllDiscussions (Entity: Discussion)● Role: AllFolders (Entity: Folder)● Role: AllIdeas (Entity: Idea)● Role: AllQuestions (Entity: Question)● Role: ContentItems (Entity: ContentItem)● Role: ContentListItems (Entity: ContentListItem)● Role: Creator (Entity: Member)● Role: FeaturedExternalObjects (Entity: ExternalObject)



http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-3-0%2Fcommon-schema-definition-language-csdl%2F%23csdl6.2

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-3-0%2Fcommon-schema-definition-language-csdl%2F%23csdl6.2

● Role: FeedEntries (Entity: FeedEntry)● Role: Folders (Entity: Folder)● Role: Forums (Entity: Forum)● Role: Memberships (Entity: GroupMembership)● Role: ParentGroup (Entity: Group)● Role: PrimaryExternalObject (Entity: ExternalObject)● Role: PrimaryGadgetObject (Entity: GroupGadgetObject)● Role: ProfilePhoto (Entity: Image)● Role: SubGroups (Entity: Group)● Role: Tasks (Entity: Task)● Role: Template (Entity: GroupTemplate)● Role: UpcomingEvents (Entity: Event)

query options

Query options are URL parameters that are added to the end of the URL.

There are three general types of query options:

● System query options: are indicated with a preceding dollar sign "$". In the diagram above, the $value segment is a system query option.

● Custom query options: are not used in the SAP Jam OData API, and so they are not discussed any further here.

● Service operation parameters: are the required parameters for service operations, which are discussed at greater length below.

The SAP Jam Collaboration OData API supports OData system query options with a number of limitations to ensure system responsiveness.

● There can be at most one Collection-valued navigation in an SAP Jam OData request.● There can be at most 3 $expand operations in one API call. Using $expand on a Collection valued

navigation of a Collection is not allowed.


See in "OData Query Parameters", Use $expand to include details on any property for which there are available navigations.

● Using $filter is currently only supported for select properties of the following entities:○ ContentItem: ContentItemType○ ContentListItem: Name○ ExternalObject: Exid, ObjectType○ Folder: Name○ FeedEntry: Read○ ForumItem: ForumItemType○ Group: Id, Name, IsActive, GroupType○ GroupExternalObject: LinkType○ GroupMembership: MemberType○ Idea: Status○ Notification: Category, EventType○ Question: HasBestAnswer○ Task: IsOverdue○ TaskAssignment: Status

See in "OData Query Parameters", Use $filter to limit the entries returned according to their content.● SAP Jam will never return arbitrarily large collections. Either server-driven paging (use $skiptoken) or

client-driven paging (use $skip) will apply. Certain endpoints only support server-driven paging ($skiptoken). In general, a maximum of 20 items will be returned, unless a value of $top is specified (and supported), in which case the maximum value is 100.See in "OData Query Parameters":○ Use $skip to offset the set of entries returned.○ Use $skiptoken to offset the set of entries returned.○ Use $top to set the number of entries returned.

● For FeedEntries and Notifications API calls, $skip, $top, and $count are not available. Also, $count is not available for GroupMembership API calls, and $orderby is not available for FeedEntries and Notifications, but it will be selectively available where the items are sortable in the SAP Jam user interface.See in "OData Query Parameters":○ Use $skip to offset the set of entries returned.○ Use $top to set the number of entries returned.○ Use $count to discover how many entries there are.○ Use $orderby to set the criteria that the returned entries are ordered by.

See the OData v.2 Specification's discussion of OData System Query Options .

Service Operations

In practice, a service operation is any endpoint that performs a required task that does not fit with the usual POST, GET, PATCH, or DELETE operations. In SAP Jam Collaboration's implementation, service operations are signified by using underscores between words in the endpoint name rather than showing the name in camel-case. There are, however, at least four exceptions: [GET] /Self, [GET] /Company, [GET] /Search, and [GET] /SearchSummary.



http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-2-0%2Furi-conventions%23SystemQueryOptions

Note that if you don't find sufficient information about a service operation in this SAP Jam Collaboration API Tutorial or the SAP Jam Collaboration API Reference, then you can check the $metadata file. Each service operation is described to some extent in that file.

For the technical specification for a service operation, see section 2.13 of the OData 2.0's Operations page.

Links between entries

The OData specification allows for the creation of links between entries.

For example, in the SAP Jam Collaboration OData API, currently logged-in Member can be set as "Following" another specified Member by setting a "$link" from the Member to be followed to "Following", which will take the Id of the currently logged-in Member as the "follower". For example:

https://{jam#} [page 201].sapjam.com/api/v1/OData/Members('2qFbDP80jDZ21W8QzZehaM')/$links/Following

There are a small number of such operations available in the SAP Jam OData API, but they are important operations. They include:

● [POST] /Members('{id}')/$links/Following● [DELETE] /Members('{id}')/$links/Following('{id1}')● [POST] /Questions('{id}')/$links/BestAnswer● [DELETE] /Questions('{id}')/$links/BestAnswer● [POST] /Groups('{id}')/$links/FeaturedExternalObjects● [DELETE] /Groups('{id}')/$links/FeaturedExternalObjects('{id1}')● [POST] /Events('{id}')/$links/Invitees● [POST] /Tasks('{id}')/$links/Attachments● [DELETE] /Tasks('{id}')/$links/Attachments('{id1}')● [POST] /Tasks('{id}')/$links/PendingFollowers

See sections 2.9 Manipulating Links , 2.10 Creating Links between Entries , 2.11 Removing Links between Entries , and 2.12 Replacing Links between Entries in the Operations page of the OData 2.0 specification.


http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-2-0%2Foperations%2F

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-2-0%2Foperations%23ManipulatingLinks

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-2-0%2Foperations%23CreatingLinksbetweenEntries

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-2-0%2Foperations%23RemovingLinksbetweenEntries

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-2-0%2Foperations%23RemovingLinksbetweenEntries

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.odata.org%2Fdocumentation%2Fodata-version-2-0%2Foperations%23ReplacingLinksbetweenEntries

17.1.3.2 OAuth 1.0a Authorization Tutorial

SAP Jam supports 3-legged OAuth 1.0a authorization, which provides a mechanism for SAP Jam-integrated applications to get explicit authorization from an end user for that application to present SAP Jam content. The steps required to use this workflow are documented in this section.

The workflow for this authorization method is as follows:

1. Your organization's SAP Jam administrator registers your organization's SAP Jam API client application with SAP Jam.

2. When the user views the SAP Jam API client application, it calls SAP Jam to obtain a request token (POST /oauth/request_token).

3. The SAP Jam API client application then redirects the end user to SAP Jam.4. The end user logs into SAP Jam and is presented with an authorization request to allow the SAP Jam API

client application to make calls to SAP Jam on their behalf. If they accept, they receive an oauth_verifier that they enter into SAP Jam.

5. The SAP Jam API client application then exchanges the request token and the oauth_verifier for an authorized access token (POST /oauth/access_token).



6. Subsequently, the SAP Jam API client application can make public REST API calls on behalf of the end user, allowing the user to see SAP Jam elements in the SAP Jam API client application.

The SAP Jam OAuth API also provides a utility call that allows you to validate an authorized access token.

It is also important to be able to revoke an authorized access token.

17.1.3.2.1 1. Register your Auth Client

A client application must be registered in SAP Jam before it can use SAP Jam as an OAuth provider.

To register a new OAuth client, do the following:

1. Log on to your company's SAP Jam Collaboration account as an administrator.2. At the top of the page, click the account name then click Admin.3. On the left side of the page, click OAuth Clients.4. At the bottom of the page, click Add OAuth Client.

There are various fields, but only the following are relevant to the OAuth workflow:○ Company Name: Example Corporation○ Integration URL: http://example.com○ Callback URL: https://apis.example.com

Note○ It is recommended that the Callback URL be https.○ If the client app does not support callbacks, as may be the case with a mobile application or a

desktop application, then the Callback URL should be left blank. This affects what happens when the end user authorizes the client app on the SAP Jam Collaboration website.

5. Click Save.

SAP Jam generates a client application key and client application secret unique to the registered company. It is important that the client application key is kept secure and private, because it is essentially like the client application's password.

The sample client app created in step 4 above has the following data, which is used throughout this document:

OAuth details for Example OAuth Client Application Consumer Key: J2iLG8a8xZPtqBIfHjImConsumer Secret: puTHhU5y8upl9y8fJr25rTAlLXwZEKUkQib89bwJRequest Token URL: https://samplejamserver.com/oauth/request_tokenAccess Token URL: https://samplejamserver/oauth/access_tokenAuthorize URL: https://samplejamserver/oauth/authorize We support the PLAINTEXT, HMAC-SHA1 and RSA-SHA1 signature methods in SSL mode

17.1.3.2.1.1 1.1 Signature Methods

This page discusses: supported signature methods, security considerations, details on the use of the available signature methods, and the advantages and disadvantages of each.


Supported signature methods

The PLAINTEXT, HMAC-SHA1, and RSA-SHA1 signature types are supported.

Performance considerations

In the vast majority of cases, performance should not be a factor when deciding which OAuth signature type to use. Performance details are as follows:

● RSA-SHA1 is slower than HMAC-SHA1 which is slower than PLAINTEXT.● Most of the delay of RSA-SHA1 is on the client side, which is due to the overhead of signing the request.● The overhead of both the client side and provider side of processing the OAuth request is under 9 ms per

request. For most REST API requests, which are on the order of 500+ ms, this represents a small fraction of the time for the request.

Security considerations

From a security point of view, SAP Jam Collaboration's recommendations are as follows:

● Use RSA-SHA1 for OAuth client applications that are able to keep user-level as well as application-level secrets, such as a secured web application (secure server to secure server calls).

● Use HMAC-SHA1 for OAuth client apps that are able to keep user-level secrets, but not application-level secrets, such as a mobile client or a desktop client. However, in some cases, RSA-SHA1 may still be better: see the next section for details.

● Do not use OAuth authentication when the client app cannot keep any sort of secret.● Use HMAC-SHA1 instead of PLAINTEXT if possible. Although PLAINTEXT is secure when appropriately

used under SSL, HMAC-SHA1 is more secure and has equivalent usage characteristics in other respects.

Details and discussion

OAuth client app credentials consist of a client application key and a client application secret, which in the OAuth protocol are known as the oauth_consumer_key and oauth_consumer_secret, respectively. The client application secret should be kept secret by the client app. There is one secret per OAuth application, regardless of the number of client app users. The client application key and secret are randomly generated UUIDs, generated using a cryptographically strong pseudo-random number generator. The key is represented by 20 Base64 characters (120 bits) and the secret by 40 Base64 characters (240 bits). A sample client application key and secret are shown below:

oauth_consumer_key: fb8yyZdZ58WipQLylZYX oauth_consumer_secret: 50DFsABZBNUJl24hdEztjk2lddLX7up4PIYDvxk4

OAuth token credentials consist of a token key and a token secret, which in the OAuth protocol are known as the oauth_token and oauth_token_secret, respectively. There are one or more tokens per OAuth



application, as there is one token per client app user. The token key and secret are randomly generated UUIDs, generated using a cryptographically strong pseudo-random number generator. The key is represented by 20 Base64 characters (120 bits) and the secret by 40 Base64 characters (240 bits). These tokens can be stored by the client app to avoid having to request end user authorization every time the user wants to access SAP Jam Collaboration resources.

The RSA-SHA1 signature method does not use either the client application key secret or the OAuth token secret described above. A client app is configured to use the RSA-SHA1 signature method by configuring the X-509 certificate when registering the client app at the chosen OAuth provider.

NoteUnder SAP Jam Collaboration's implementation, an OAuth provider configured to use RSA-SHA1 will only accept RSA-SHA1 signed requests.

For an RSA-SHA1 OAuth client, there is no need to store the client application secret or the OAuth token secret. The RSA private key used to sign requests by the client must be stored securely as an application-level secret. In particular, it should not be accessible to users of the client application.

When an RSA-SHA1 OAuth client makes regular 3-legged OAuth calls, it makes use of the RSA private key, the oauth_consumer_key, and the oauth_token to sign the request. However, if the OAuth client cannot be relied on to keep application-level secrets (such as the RSA private key), then the HMAC-SHA1 authentication method is recommended. This is because RSA-SHA1 uses the 120-bit oauth_token to secure the request, while HMAC-SHA1 uses the 240-bit oauth_token_secret.

Advantages and disadvantages

The main advantage of the RSA-SHA1 signature method is that it is not based on shared secrets. The client does not need to worry about their oauth_consumer_secret or oauth_token_secret being compromised at the provider site. For example, it is impossible for an employee in the operations team at the provider site to generate OAuth requests for the client.

Another advantage of RSA-SHA1 is that the client can easily change its configuration to update to a new RSA private key by uploading a new X-509 certificate to the provider. For the other signature methods, it is currently not possible to change the oauth_consumer_secret without re-registering the client application.

NoteThis is not a fundamental restriction of OAuth; the feature to generate a new secret has simply not been implemented. Currently, the client app would need to be deleted and re-registered at the OAuth client provider, and users would need to reauthorize their access tokens the next time they use the application.

An advantage of the RSA-SHA1 and HMAC-SHA1 signature methods is that all query parameters and any parameters in the Authorization header are included in computing the signature. This means that if any of these parameters are tampered with, OAuth validation will fail. Also, in addition to authorizing OAuth 1.0a access tokens, users can view the applications they have authorized and unauthorize them.

A disadvantage of the PLAINTEXT signature method is that the oauth_consumer_secret and oauth_token_secret values are visible and unencrypted within the oauth_signature parameter. This makes it easier for these values to be compromised in the case of poor logging practices - see http://tools.ietf.org/html/rfc5849#section-3.4.4 for more information. While in theory, proper adherence to SAP


http://help.sap.com/disclaimer?site=http%3A%2F%2Ftools.ietf.org%2Fhtml%2Frfc5849%23section-3.4.4

http://help.sap.com/disclaimer?site=http%3A%2F%2Ftools.ietf.org%2Fhtml%2Frfc5849%23section-3.4.4

security standards on logging means this will not be a problem, it is better to have redundant layers of security, particularly when the solution to this problem (using a different signature method) is simple.

NoteRegardless of the chosen signature method, client apps should store the authorized access token. This means users will not be repeatedly asked to authorize the client app.

17.1.3.2.2 2. Get a Request Token from Jam

After the client application has been registered as an OAuth provider and that a client application key (oauth_consumer_key) and client application secret (oauth_consumer_secret) have been generated, you can get a request token using [POST] /oauth/request_token.

The following procedure requires that the client application has been registered as an OAuth provider and a client application key (oauth_consumer_key) and client application secret (oauth_consumer_secret) have been generated.

1. The client app calls SAP Jam Collaboration to obtain a request token:POST /oauth/request_token/Using the sample client application key J2iLG8a8xZPtqBIfHjIm and client application secret puTHhU5y8upl9y8fJr25rTAlLXwZEKUkQib89bwJ, a trace of the HTTP request and response is as follows:

> POST /oauth/request_token HTTP/1.1 > User-Agent: curl/7.20.1 (i686-pc-cygwin) libcurl/7.20.1 OpenSSL/0.9.8r zlib/1.2.5 libidn/1.18 libssh2/1.2.5> Host: sapjam.com> Accept: */*> Authorization: OAuth oauth_consumer_key="J2iLG8a8xZPtqBIfHjIm", oauth_nonce="y-s52YCzMQ", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1316126857", oauth_version="1.0", oauth_callback="oob", oauth_signature="mdGRoILktVrGG6bvB%2FJd4hK0jSo%3D"> Content-Type:application/x-www-form-urlencoded>< HTTP/1.1 200 OK< Cache-Control: no-store, private< Expires: -1< Vary: *< X-Runtime : 27< ETag: "a65faf922b1c155b71814eff0b3c1152"< Set-Cookie: _12sprints_srv=m12; path=/; secure; HttpOnly< Set-Cookie: _cstar_session=914aedf444e795376a223735aa42c7ab; path=/; secure; HttpOnly< Content-Type: text/html;charset=utf-8< Content-Length: 122< Date: Thu, 15 Sep 2011 22:47:48 GMT< Connection: close< Server: SAP LJS 1.0.0< Set-Cookie: BIGipServerstage.sapjam.com-443-pool=200941484.20480.0000; path=/<===============[ Response Below ]===============oauth_token=39b1abH5FJZgxwZ2lnoq&oauth_token_secret=A6vIuSl5Bps2qbH7GFD1d1UQMFSgNP9J7GlgilEn& oauth_callback_confirmed=true



Details are as follows:○ The request must be an HTTP POST with content type application/x-www-form-urlencoded○ All of the following OAuth parameters are required:

Parameter Description

oauth_consumer_key The client app key, obtained when the client app was registered with the OAuth provider.

oauth_nonce A single-use randomly generated UUID string.

oauth_signature_method The chosen signature method (PLAINTEXT, HMAC-SHA1, or RSA-SHA1). We recommend using either the HMAC-SHA1 or RSA-SHA1 signature methods, but not PLAINTEXT.

oauth_timestamp The current UNIX timestamp.

oauth_version The version of OAuth being used. This must be 1.0, although this is actually 1.0a, an important security update to 1.0.

oauth_callback The Callback URL.○ If this parameter value is oob, then the Callback URL that was provided when

the client app was registered is used.○ If a Callback URL was provided when the client app was registered, but this pa

rameter value is not oob, then the URL in the parameter must be within the same top-level domain as the provided URL. For example, https://apis.example.com/callback is valid, but https://apis.somewhereelse.com is not. The response code, 401 Unauthorized, is displayed if an invalid URL is used.

oauth_signature A signature generated in accordance with the specified oauth_signature_method.

○ The above parameters can be supplied in the Authorization header (as in the above example) or as query parameters in the POST request body, as specified in section 5.2 of the OAuth spec.

○ If successful, the request returns HTTP 200 OK and a request token key and secret. In the above example, the key is 39b1abH5FJZgxwZ2lnoq and the secret is A6vIuSl5Bps2qbH7GFD1d1UQMFSgNP9J7GlgilEn.

NoteThe parameter names oauth_token and oauth_token_secret can be overloaded to mean either a request token key and secret or an access token key and secret, depending on the context.

○ The request token secret should be kept secret by the client app. It should also be stored by the client app to avoid having to request end user authorization every time the user wants to access SAP Jam Collaboration resources.

17.1.3.2.3 3. Redirect the User to SAP Jam

Once the client application has acquired a request token, redirect the end user to SAP Jam Collaboration.

To redirect the end user to SAP Jam Collaboration, do the following:

1. Using the sample request token key 39b1abH5FJZgxwZ2lnoq from Step 2, redirect the user to:


https://demojam.com/oauth/authorize?oauth_token=39b1abH5FJZgxwZ2lnoq The user is then prompted to authorize the client app to access their SAP Jam Collaboration account and make REST API calls on their behalf.

17.1.3.2.4 4. User authorizes the client application

Once the end user has been redirected to SAP Jam Collaboration, the user must authorize their access to the client application.

When the user is redirected to SAP Jam Collaboration, they must log in using their SAP Jam credentials, and then they are shown the following prompt:

Authorize access to your account Would you like to authorize Example OAuth Client Application (http://example.com) to access your account?

The Company Name and Integration URL that are displayed are the values entered when the client application was registered with the OAuth provider.

1. The user can choose to:○ Deny the request.

Example Corporation will not be notified.○ Authorize the request.

SAP Jam will redirect the user to:

https://apis.example.com/?oauth_token=39b1abH5FJZgxwZ2lnoq&oauth_verifier=HN7f2t1Z9ndgLqzqs8uu

Element Description

https://apis.example.com/ The Callback URL entered when the client app was registered with the OAuth provider.

oauth_token The request token key from Step 2.

oauth_verifier Used in the following steps. This value ensures that the user who authorized the client app on SAP Jam Collaboration is the same person as the user of the client app requesting access to the SAP Jam Collaboration user's protected resources.

NoteThis is the key difference between OAuth versions 1.0 and 1.0a.

If the client app's Callback URL was left blank and the oauth_callback parameter was set to oob when the client app called SAP Jam to get a request token, then SAP Jam Collaboration will not callback to the client application if the user authorizes access. Instead, SAP Jam Collaboration will display a message that the user authorized the access, along with a verification code for the user to enter when they return to the client app.



http://help.sap.com/disclaimer?site=https%3A%2F%2Fdemojam.com%2Foauth%2Fauthorize%3Foauth_token%3D39b1abH5FJZgxwZ2lnoq

17.1.3.2.5 5. Request Token to Access Token

When the user authorizes access to the client application in SAP Jam Collaboration, the client application must exchange the request token for an authorized access token.

To have the client app exchange the request token obtained in Step 2 for an authorized access token, the following steps must be performed:

1. Use the verifier obtained in Step 4, as well as the client application key and secret.

POST /oauth/access_token

Using the sample client application key J2iLG8a8xZPtqBIfHjIm, client application secret puTHhU5y8upl9y8fJr25rTAlLXwZEKUkQib89bwJ, request token key 39b1abH5FJZgxwZ2lnoq, request token secret isA6vIuSl5Bps2qbH7GFD1d1UQMFSgNP9J7GlgilEn, and verifier HN7f2t1Z9ndgLqzqs8uu, a trace of the HTTP request and response is:

> POST /oauth/access_token HTTP/1.1> User-Agent: curl/7.20.1 (i686-pc-cygwin) libcurl/7.20.1 OpenSSL/0.9.8r zlib/1.2.5 libidn/1.18 libssh2/1.2.5> Host: jamdemo.com> Accept: */*> Authorization: OAuth oauth_consumer_key="J2iLG8a8xZPtqBIfHjIm", oauth_nonce="C9Rf4I-piw", oauth_signature_method="HMAC-SHA1" , oauth_timestamp="1316134422" , oauth_version="1.0", oauth_token="39b1abH5FJZgxwZ2lnoq", oauth_verifier="HN7f2t1Z9ndgLqzqs8uu", oauth_signature="yUYSVXsjIIgr9hZ3YsSQBM453lY%3D"> Content-Type:application/x-www-form-urlencoded>< HTTP/1.1 200 OK< Cache-Control: no-store, private< Expires: -1< Vary: *< X-Runtime : 44< ETag: "9d5f14e5df3e173a08cc5b84140cd0ee"< Set-Cookie: _12sprints_srv=m13; path=/; secure; HttpOnly< Set-Cookie: _cstar_session=55db5ac7072b9e48185e834c9234d33b; path=/; secure; HttpOnly< Content-Type: text/html;charset=utf-8< Content-Length: 92< Date: Fri, 16 Sep 2011 00:53:52 GMT< Connection: close< Server: SAP LJS 1.0.0< Set-Cookie: BIGipServerstage.sapjam.com-443-pool=217718700.20480.0000; path=/<===============[ Response Below ]=============== oauth_token=vbXkQoSkIqyYIxwI2I2u&oauth_token_secret=pYOz16l9UjgZddj9twsoD8ptWKQ4LxrQi24xE2sA

Details are as follows:○ The request must be an HTTP POST with content type application/x-www-form-urlencoded.○ All of the following OAuth parameters are required:






oauth_signature_method The chosen signature method (PLAINTEXT, HMAC-SHA1, or RSA-SHA1).


oauth_version The version of OAuth being used.

oauth_token The request token key from Step 2.

oauth_verifier The verifier from Step 4.

oauth_signature The client app secret, obtained when the client app was registered with the OAuth provider.


○ If successful, the request returns HTTP 200 OK and an authorized access token key and secret. In the above example, the key is vbXkQoSkIqyYIxwI2I2u and the secret is pYOz16l9UjgZddj9twsoD8ptWKQ4LxrQi24xE2sA.

NoteThe parameter names oauth_token and oauth_token_secret can be overloaded to mean either a request token key and secret or an access token key and secret, depending on the context.

○ The access token secret should be kept secret by the client app. It should also be stored by the client app to avoid having to request end user authorization every time the user wants to access SAP Jam Collaboration resources.

17.1.3.2.6 6. Make Public Jam API Calls

This page in the description of how to use OAuth 1.0a authorization demonstrates the use of an API call in SAP Jam Collaboration.

For this example, we will use /v1/activities?page=1&page_size=5 to get the user's activities. However, any public API call in SAP Jam Collaboration can use OAuth authentication.

1. Use the sample client application key J2iLG8a8xZPtqBIfHjIm, client application secret ispuTHhU5y8upl9y8fJr25rTAlLXwZEKUkQib89bwJ, access token vbXkQoSkIqyYIxwI2I2u, and access token secret pYOz16l9UjgZddj9twsoD8ptWKQ4LxrQi24xE2sA, a trace of the HTTP request and response is as follows:

> GET /v1/activities?page=1&page_size=5 HTTP/1.1> User-Agent: curl/7.20.1 (i686-pc-cygwin) libcurl/7.20.1 OpenSSL/0.9.8r zlib/1.2.5 libidn/1.18 libssh2/1.2.5> Host: demojam.com> Accept: */*> Authorization: OAuth oauth_consumer_key="J2iLG8a8xZPtqBIfHjIm", oauth_nonce="RPUt7ytQ9w", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1316135320" , oauth_version="1.0", oauth_token="vbXkQoSkIqyYIxwI2I2u", oauth_signature="P5scFJf6CZlBBMELB9kb%2FvM0ktQ%3D"



> Content-Type:text/plain>< HTTP/1.1 200 OK< Cache-Control: no-store, private< Expires: -1< Vary: *< X-Runtime : 1203< ETag: "258cfbdc42df3b2076aa87a1912f58ac"< Set-Cookie: _12sprints_srv=m12; path=/; secure; HttpOnly< Set-Cookie: _cstar_session=31e8fdfac7836cfbf9aed88bcc9eaa17; path=/; secure; HttpOnly< Content-Type: application/xml;charset=utf-8< Content-Length: 16908< Date: Fri, 16 Sep 2011 01:08:50 GMT< Connection: close< Server: SAP LJS 1.0.0< Set-Cookie: BIGipServerstage.demojam.com-443-pool=217718700.20480.0000; path=/<===============[ Response Below ]===============<?xml version="1.0" encoding="UTF-8" ?><activities total_number_of_activities="439"> <activity ... (omitted)

Details are as follows:○ All of the following OAuth parameters are required:




oauth_signature_method The chosen signature method (PLAINTEXT, HMAC-SHA1, or RSA-SHA1).


oauth_version The version of OAuth being used.

oauth_token The authorized access token from Step 5.

oauth_signature The client app secret, obtained when the client app was registered with the OAuth provider.


17.1.3.2.7 Validate an Authorized Access Token

You can test that the API call checks if the access token is valid and working correctly by performing a [GET] /oauth/test_request.

This is a test API call that checks if the access token is valid and working correctly without making unauthorized calls on behalf of the user.

1. Use GET /oauth/test_request.Using the sample client application key J2iLG8a8xZPtqBIfHjIm, client application secret puTHhU5y8upl9y8fJr25rTAlLXwZEKUkQib89bwJ, access token key vbXkQoSkIqyYIxwI2I2u, and


access token secret pYOz16l9UjgZddj9twsoD8ptWKQ4LxrQi24xE2sA, a trace of the HTTP request and response is as follows:

> GET /v1/activities?page=1&page_size=5 HTTP/1.1> User-Agent: curl/7.20.1 (i686-pc-cygwin) libcurl/7.20.1 OpenSSL/0.9.8r zlib/1.2.5 libidn/1.18 libssh2/1.2.5> Host: demojam.com> Accept: */*> Authorization: OAuth oauth_consumer_key="J2iLG8a8xZPtqBIfHjIm", oauth_nonce="_9CPbe4VwA", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1316135032" , oauth_version="1.0", oauth_token="vbXkQoSkIqyYIxwI2I2u", oauth_signature="7Jf%2FLxrvWGRPzK0n7%2FQn5VrEYo4%3D"> Content-Type:text/plain>< HTTP/1.1 200 OK< Cache-Control: no-store, private< Expires: -1< Vary: *< X-Runtime : 721< ETag: "74b302e289e66afbbe423f35d6b6145b"< Set-Cookie: _12sprints_srv=m13; path=/; secure; HttpOnly< Set-Cookie: _cstar_session=15086b4712eef7278a51e13c91535825; path=/; secure; HttpOnly< Content-Type: text/html;charset=utf-8< Content-Length: 40< Date: Fri, 16 Sep 2011 01:04:01 GMT< Connection: close< Server: SAP LJS 1.0.0< Set-Cookie: BIGipServerstage.demojam.com-443-pool=217718700.20480.0000; path=/<===============[ Response Below ]=============== controller=oauth_api&action=test_request

17.1.3.2.8 Revoke an Authorized Access Token

Use this procedure to have the client application revoke an authorized access token.

The rest API endpoint to do this is [POST] /oauth/revoke_token, authorized as a regular 3-legged OAuth request.

It programmatically revokes the authorized access token that was used to authenticate the call, so that it can no longer be used for OAuth requests and will no longer appear in the list of authorized access tokens for the user.

Under normal circumstances, a client app will not need to use this endpoint. However, if the client app is able to create access tokens without user intervention, and the client app does not persist the authorized access token beyond the scope of its session, it is possible to flood the user's list of authorized access tokens that enable the user to initiate access token revocation. In such a case, it is best for the client app to revoke the access token.

Developer notes on the design:

● We took the precedent for our API authentication revocation design from elance.com.● This is similar to the revocation proposal for OAuth 2, although written in a form consistent with the

current API.● Google supports OAuth token revocation, but in a very implementation dependent way.



● Finally, it is always possible to work around the absence of a programmatic API by calling the UI-based endpoint for token revocation, even though this is inconvenient. There is no additional security exposure introduced here.

For more information, see:

● http://tools.ietf.org/html/draft-lodderstedt-oauth-revocation-03● https://developers.google.com/accounts/docs/OAuth_ref?csw=1#RevokeToken

17.1.3.3 OAuth 1.0a Authorization API ReferenceThe API endpoints for the OAuth 1.0a workflow are documented in this section.

The API calls used in the workflow for this authorization method are as follows:

1. Your organization's SAP Jam Collaboration administrator registers your organization's SAP Jam Collaboration API client application with SAP Jam.

2. When the user views the SAP Jam API client application, it calls SAP Jam to obtain a request token (POST /oauth/request_token).


http://help.sap.com/disclaimer?site=http%3A%2F%2Ftools.ietf.org%2Fhtml%2Fdraft-lodderstedt-oauth-revocation-03

http://help.sap.com/disclaimer?site=https%3A%2F%2Fdevelopers.google.com%2Faccounts%2Fdocs%2FOAuth_ref%3Fcsw%3D1%23RevokeToken

3. The SAP Jam API client application then redirects the end user to SAP Jam.4. The end user logs into SAP Jam and is presented with an authorization request to allow the SAP Jam API

client application to make calls to SAP Jam on their behalf. If they accept, they receive an oauth_verifier that they enter into SAP Jam Collaboration.

5. The SAP Jam API client application then exchanges the request token and the oauth_verifier for an authorized access token (POST /oauth/access_token).

6. Subsequently, the SAP Jam Collaboration API client application can make public REST API calls on behalf of the end user, allowing the user to see SAP Jam elements in the SAP Jam Collaboration API client application.

The SAP Jam OAuth API also provides a utility call, [GET] /oauth/test_request, that allows you to validate an authorized access token.

It is also important to be able to revoke an authorized access token, which is done using [POST] /oauth/revoke_token.

17.1.3.3.1 [POST] /oauth/request_token

Obtains a request token for the current user.

Request Elements

URL

https://<jam#>.sapjam.com/oauth/request_token

HTTP Request Method

POST

Authorization Header or Request Payload Parameters

Parameter Required Description

Type True The value must be "OAuth". This is actually OAuth 1.0a, an important security update of OAuth 1.0.

oauth_consumer_key

True 20 Base64 characters (120 bits). The authentication client "Consumer Key", obtained when the client app was registered with SAP Jam Collaboration.




oauth_nonce True A single-use randomly generated UUID string, used in all OAuth authentication requests and all subsequent authenticated API calls to prevent replay attacks. (Nonce = number, used once.)

oauth_signature

True 40 Base64 characters (240 bits). The encrypted hash of the canonical URL and parameters.

oauth_signature_method

True The cryptographic method used for generating the signature. The valid values are PLAINTEXT, HMAC-SHA1, or RSA-SHA1.

oauth_timestamp

True The current UNIX timestamp.

oauth_version

True 1.0. The version of OAuth being used. This is actually OAuth 1.0a.

oauth_callback

True The Callback URL is the URL to which the user is returned after authorization.

● If this parameter value is oob, then the Callback URL that was provided when the client app was registered is used.

● If a Callback URL was provided when the client app was registered, but this parameter value is not oob, then the URL in the parameter must be within the same top-level domain as the provided URL. For example, https://apis.example.com/callback is valid, but https://apis.somewhereelse.com is not. The response code 401 Unauthorized is displayed if an invalid URL is used.

NoteThe above parameters can be supplied in the Authorization header or as query parameters in the POST request body, as specified in section 5.2 of the OAuth spec .

Response Elements

If successful, the request returns HTTP 200 OK and a request token key and secret. The request token secret should be kept secret by the client app, and it should be stored until the user is prompted to authorize use of the token, which will require that the token be replaced with an OAuth authorization token.

Response Properties

Property Description

oauth_token The returned OAuth 1.0a access token. This is the public part of the OAuth request token.

oauth_token_secret The returned OAuth 1.0a auth token secret. This is the private part of the OAuth request token

oauth_callback_confirmed

This is always "true".



NoteThe request_token is used to get an access token, but first the user must accept this, so the user must be redirected to SAP Jam Collaboration and presented with a prompt to accept this. The URL to which you must redirect the user is https://demojam.com/oauth/authorize?oauth_token=<oauth_token>. For more information, see the "OAuth 1.0a Authorization" section in the Authorization API documentation.

Response Example

URL Method

https://<jam#>.sapjam.com/oauth/request_token POST

oauth_token=39g1abHfFJZgx7Z2lnos&oauth_token_secret=A6bIuSl5Bfs2qbH7G6D1d1UQ6FSgNP9J7GlgilEn& oauth_callback_confirmed=true

HTTP Status Codes

HTTP Success Code Description

200 OK The requested resource retrieval is successful, and a full payload of the requested resource is returned.

HTTP Error Codes Description

400 Bad Request The server could not understand the request due to malformed syntax.

403 Forbidden Access to the resource you are trying to connect to is forbidden. This may be due to either a user authentication failure or to the user having insufficient privileges to perform the action.

404 Not Found The server cannot find the specified resource. This is typically due to an unrecognized resource ID (such as userId, groupId, or contentId).

405 Method Not Allowed The method specified in the Request Line is not allowed for the resource identified by the Request URI.

409 Conflict There is an internal access conflict to the specified resource.

429 Too Many Requests The user has sent too many requests in a given period of time. This error message is typically encountered if API rate limits, set to protect against DoS attacks and to preserve server responsiveness, have been exceeded.

500 Internal Server Error The server encountered an unexpected condition, which prevented it from fulfilling the request.

501 Not Implemented The server does not support the functionality required to fulfill the request.



17.1.3.3.2 [POST] /oauth/access_token

Replaces a user's "request token" with an "access token" upon user authorization.

Request Elements

URL

https://<jam#>.sapjam.com/oauth/access_token

HTTP Request Method

POST




oauth_consumer_key



oauth_signature




oauth_timestamp


oauth_version


oauth_token True The access token created using [POST] /oauth/request_token [page 218] and returned to the user when they authorize use of the OAuth token. See 2. Get a Request Token from Jam [page 210] and 4. User authorizes the client application [page 212] for information on how this token is created and passed, respectively.



oauth_verifier

True The oauth_verifier string that is returned to the user when they authorize use of the OAuth token. See 4. User authorizes the client application [page 212] for information on how this token is passed to the user.


Response Elements

If successful, the request returns an authorized access token key and secret. The access token secret should be kept secret by the client app. It should also be stored by the client app to avoid having to request end user authorization every time the user wants to access SAP Jam Collaboration resources.

Response Properties


oauth_token The returned OAuth 1.0a access token. This is the public part of the OAuth request token.

oauth_token_secret The returned OAuth 1.0a auth token secret. This is the private part of the OAuth request token

Response Example

URL Method

https://<jam#>.sapjam.com/oauth/access_token POST

oauth_token=kbXkRoS7IqyYIx8I2Ipu&oauth_token_secret=pKOz16l9GjgZddj7twsaD8ptWKQ48xrQi24xE2sA




HTTP Status Codes


201 Created The requested resource creation is successful, and a full payload of the created resource is returned.










17.1.3.3.3 [GET] /oauth/test_request

Checks if the access token is valid and working correctly without making unauthorized calls on behalf of the user.

Request Elements

URL

https://<jam#>.sapjam.com/oauth/test_request

HTTP Request Method

GET





oauth_consumer_key





oauth_timestamp


oauth_version



oauth_signature



Response Elements

Response Properties


controller Indicates the entity performing the action.

action Indicates the operation that is being performed.




Response Example

URL Method

https://<jam#>.sapjam.com/oauth/test_request GET

controller=oauth_api&action=test_request

HTTP Status Codes












17.1.3.3.4 [POST] /oauth/revoke_token

Revokes a token.


Request Elements

URL

https://<jam#>.sapjam.com/oauth/revoke_token

HTTP Request Method

POST




oauth_consumer_key



oauth_signature




oauth_timestamp


oauth_version



oauth_verifier

True The oauth_verifier string that is returned to the user when they authorize use of the OAuth token. See 4. User authorizes the client application [page 212] for information on how this token is passed to the user.





Response Elements

HTTP Status Codes


200 OK The passed-in auth token has been revoked successfully.










17.1.3.4 SAML Authentication and Authorization

SAML API calls require a combination of OAuth and SAML to support the authentication and authorization work flow of SAP Jam Collaboration. This requires that both an OAuth client and a SAML Trusted IDP are registered by the SAP Jam company administrator.

Company administrators can create both OAuth clients and SAML IDPs are via the Admin menu of SAP Jam. It is important to note that these OAuth clients can only be used for API calls authenticated by users who are members of the company for which the OAuth client is registered. This is also true for SAML assertions. In the case of SAML this feature is called a "Company Scoped IDP".

In this scenario SAP Jam acts as a SAML service provider (SP) with respect to the company-registered SAML IDP. These company-scoped SAML trusted IDPs are only used in various REST API flows. In particular, they do not support front-channel SSO or SLO. SAML assertions issued by these IDPs can only affect users within the company that the SAML trusted IDP is registered at.


17.1.3.4.1 SAML-based authentication

To implement SAML-based authentication you must create an OAuth2 access token from a SAML bearer assertion.

Create an OAuth2 access token from a SAML bearer assertion

[POST] /api/v1/auth/token

This API call is based on the http://tools.ietf.org/html/draft-ietf-oauth-saml2-bearer-14 specification:

● The parameter client_id is required with a value of the OAuth client consumer key.● The parameter client_secret is required unless there is a client_id attribute in the SAML assertion.

See below for details. We recommend not using the client_secret OAuth parameter and putting the client_id attribute in the SAML assertion, if possible.

● The parameter grant_type is required with the value urn:ietf:params:oauth:grant-type:saml2-bearer.

● The parameter assertion is required with the value of the SAML assertion.

NoteThe SAML assertion is not in a SAML unsolicited response envelope; it is just the assertion.

● The OAuth client and SAML trusted IDP must be configured for the same company. For example, you cannot use an OAuth client configured for Company A with a SAML trusted IDP configured for Company B.

For details on how the assertion is used to specify the user, see Format Requirements for SAML Assertions and Unsolicited Responses [page 237].

The http://tools.ietf.org/html/draft-ietf-oauth-saml2-bearer-14 specification states:

"Assertion authorization grants may be used with or without client authentication or identification. Whether or not client authentication is needed in conjunction with an assertion authorization grant, as well as the supported types of client authentication, are policy decisions at the discretion of the authorization server.”

The SAP Jam Collaboration implementation requires client authentication. This ensures that the OAuth client for which the access token is granted is directly tied to the SAML assertion.

To do this:

● The client_id parameter is required. If a client_secret parameter is provided, it is checked. (This is required by the spec section 3.1: "If present, the authorization server MUST also validate the client credentials.")

● If a client_id attribute is provided in the assertion, then it must match the client_id OAuth parameter of the request. This ties the client_id to a signed value.

● If a client_id attribute is not provided in the assertion, then the client_secret parameter is required. This allows use with IDPs that have difficulties adding custom attributes (which can happen).



http://help.sap.com/disclaimer?site=http%3A%2F%2Ftools.ietf.org%2Fhtml%2Fdraft-ietf-oauth-saml2-bearer-14


17.1.3.4.2 Get an SAP Jam OAuth2 Access Token from an SAP Cloud Platform SAML Assertion

This tutorial provides a Java client sample to illustrate authentication of the SAP Jam API using an OAuth2 access token obtained from a SAML2 bearer assertion. The assertion is provided by SAP Cloud Platform.

Prerequisite

● SAP Jam Collaboration service on SAP Cloud Platform.

Result

● Prints the OAuth access token to the console.● With this access token, you'll be able to make authenticated requests to the SAP Jam API.

Setup

1. Download the source code from:

https://github.com/SAP/SAPJamSampleCode

2. Extract the zip file and navigate to the project folder:

../JamOAuth2AccessTokenfromSAMLClient/Java/GetOAuth2AccessToken/jam_java_oauth2_saml_client_sample

3. Import this folder into Eclipse.4. Download the OpenSAML dependencies from:

https://build.shibboleth.net/nexus/content/repositories/releases/org/opensaml/opensaml/2.6.6/opensaml-2.6.6-bin.zip

5. Extract the zip file and copy all of the extracted files to the project folder

../JamOAuth2AccessTokenfromSAMLClient/Java/GetOAuth2AccessToken/jam_java_oauth2_saml_client_sample

6. Setup an OAuth client in SAP Jam:

Add an OAuth Client [page 195]


http://help.sap.com/disclaimer?site=https%3A%2F%2Fgithub.com%2FSAP%2FSAPJamSampleCode

http://help.sap.com/disclaimer?site=https%3A%2F%2Fbuild.shibboleth.net%2Fnexus%2Fcontent%2Frepositories%2Freleases%2Forg%2Fopensaml%2Fopensaml%2F2.6.6%2Fopensaml-2.6.6-bin.zip


Configure the required keys

Perform the following steps in your Eclipse project folder:

1. Expand the src folder2. Expand the com.sap.jam.api.sample package3. Open OAuth2SAMLWorkflowSample.java

Configure the variables of OAuth2SAMLWorkflowSample.java to your Jam instance as shown below:

● baseUrl - The base url of your Jam site:

https://{jam_instance}.sapjam.com

● clientKey - Your SAP Jam OAuth client key. Use the following steps to get this value:1. Open your SAP Cloud Platform instance.2. Copy and paste the key from your OAuth client to this variable.

● idpId - Identifier for the SAML trusted IDP. Use the following steps to get this value:1. Open your SAP Cloud Platform instance.

1. Select Security Trust Trust Management The Trust Management screen appears.2. Select Custom from the Configuration Type drop down list.3. Copy and paste all content from the Local Provider Name text field to this variable.

● subjectNameId - The identifier for the user. Can be an email address or a unique identifier, depending on the company type. Use the following steps to get this value:○ Open your SAP Jam instance.

1. Select Admin Users Users & Member Lists2. Copy and paste the email address of the user from the Member List to this variable.

● subjectNameIdFormat - "email" or "unspecified"● idpPrivateKey - Generate a Base64 encoded IDP private key from your SAP Cloud Platform local Identity

Provider (local IDP). The local IDP is registered with your Jam instance as a Add a SAML Trusted IDP to provide a secure way of forwarding your identity from your SAP Cloud Platform account to your instance of SAP Jam. See the following steps to get this value:○ Configure SAP Cloud Platform to be a custom local IDP and export the public metadata to an XML file.

1. Open your SAP Cloud Platform instance.

2. Select Security Trust Trust Management The Trust Management screen appears.3. Select Custom from the Configuration Type drop down list.4. Check for a private/public key pair in the Signing Key and Signing Certificate text fields.

○ If a private/public key has not been generated:1. Click Generate Key Pair. A new private/public key pair appears.

5. Copy the Signing Key6. Select Enabled from the Principal Propogation drop down list.7. Click Save8. Click Get Metadata to download your XML file.9. Paste the Signing Key to this variable. SAP Cloud Platform is now configured as a custom local IDP.

○ Import the public metadata from the XML file into your Jam instance. This enables your SAP Jam instance to use your SAP Cloud Platform custom local IDP as a SAML Trusted IDP.1. Open your SAP Jam instance.



https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/dc618538d97610148155d97dcd123c24.html#loiodcdfe339f94947bc96508daa686cc56d

https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/dc618538d97610148155d97dcd123c24.html#loiodcdfe339f94947bc96508daa686cc56d

https://help.sap.com/viewer/u_collaboration_dev_help/fe6fe4fba1a2482790640cb51fea2773.html

2. Select Admin Integrations SAML Trusted IDPs The SAML Trusted IDPs screen appears.3. Click Register your SAML Trusted IDP. The Register a new SAML Trusted Identity Provider screen

appears.4. Click Browse.5. Select the XML file.6. Click Open.7. Click Register. The SAML Trusted IDPs screen appears. Your SAP Cloud Platform Local Provider

Name URL is added to the SAML Trusted IDP list.

Configure Optional Keys

● subjectNameIdQualifier: Use the value "www.successfactors.com" for SuccessFactors integrated companies when using the 'unspecified' name id format.

Run this project

1. Right-click OAuth2SAMLWorkflowSample.java

2. Select Run As Java Application

Result

The program will print the following output to the console.

POST https://developer.sapjam.com/api/v1/auth/token SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder". SLF4J: Defaulting to no-operation (NOP) logger implementation SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details. Signed assertion: <?xml version="1.0" encoding="UTF-8"?> saml2:Issuerbo.ilic.test.idp/saml2:Issuerds:SignedInfods:Transforms/ds:Transform/ds:Transformsds:DigestValueJK3wsqeaWOYrB+Nwmq9gmQJK4E0=/ds:DigestValue/ds:Reference/ds:SignedInfods:SignatureValuekjh2werVBSWe456409scxkljsldfSDFJ3Vlkn+lkjsdflkj/LKjslkjl909asdz/kizcFDSOInhjhsdf+lkjlbxkjvcx98dbxcbc/sdflkjIDUFSUQWE+xcvjlxerEWRaLKSJVSLKJSV3432/SDFLKJXL092809809fsbj+lkjcblkjxwu32nlvjnds09u09cuvi890u78+lhsblhlk231423/Slkvchxlvk234lkjslkfdspoibv+098XCXZCdbvcxbc+sdflkjhlkj3wrnvs/987xbzoisufmnwDVDSFDSFD+89oiuhwac09809LJLKJx09KJLKJpwqexcv3Zsdf==/ds:SignatureValue/ds:Signaturesaml2:[email protected]/saml2:NameID/saml2:SubjectConfirmation/saml2:Subjectsaml2:AudienceRestrictionsaml2:Audiencecubetree.com/saml2:Audience/saml2:AudienceRestriction/saml2:Conditionssaml2:AttributeStatementj23DSF65dkj402DS3nz1/saml2:AttributeValue/saml2:Attribute/saml2:AttributeStatement/saml2:Assertion Request body: client_id={CLIENT ID}&grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Asaml2-bearer&assertion={ASSERTION} HTTP response code: 200 Response body: {"access_token":{ACCESS TOKEN}} OAuth access token: {OAUTH ACCESS TOKEN}


Use the OAuth2 access token

Copy the OAuth2 access token and use it to make authenticated requests to the SAP Jam API with the following tools:

● SAP Jam Collaboration Interactive API Reference1. Paste your OAuth2 access token in the OAuth2 Access Token input field.2. Select GROUP > GET/GROUPS, scroll down to GET/GROUPS, click TRY.

● cURL: (GET /GROUPS)

curl https://developer.sapjam.com/api/v1/OData/Groups -H "Authorization: OAuth nL5CXWRYPKG0fTaGSNz7qIVeA7sQAYDtdFrTlcCn" -H "Accept: application/json"

● Postman or your own programs.

17.1.3.4.3 Get an SAP Jam OAuth2 Access Token from a SAML Assertion with a CLI

This tutorial provides a Java CLI client sample to illustrate authentication of the SAP Jam API using an OAuth2 access token obtained from a SAML2 bearer assertion.

Setup

1. Download the source code from:

https://github.com/SAP/SAPJamSampleCode

2. Extract the zip file and navigate to the project folder (../JamOAuth2AccessTokenfromSAMLClientCLI/Java/GetOAuth2AccessToken/jam_java_oauth2_saml_client_sample).

3. Import this folder into Eclipse.4. Download the OpenSAML dependencies from:

https://build.shibboleth.net/nexus/content/repositories/releases/org/opensaml/opensaml/2.6.6/opensaml-2.6.6-bin.zip

5. Extract the zip file and place the files in the project folder (../JamOAuth2AccessTokenfromSAMLClientCLI/Java/GetOAuth2AccessToken/jam_java_oauth2_saml_client_sample).

6. Setup an OAuth client in SAP Jam:



https://developer.sapjam.com/ODataDocs/ui

http://help.sap.com/disclaimer?site=https%3A%2F%2Fgithub.com%2FSAP%2FSAPJamSampleCode



Add an OAuth Client [page 195]

Configure the required keys

● baseUrl - The base url of the Jam site:○ SAP Jam instance (SAP Cloud Platform account):

https://developer.sapjam.com/

○ SAP Jam instance (Your own):

https://{YOUR_SAP_JAM_URL}

● clientKey - The SAP Jam OAuth client key:○ SAP Jam instance (Your own or SAP Cloud Platform account): Add an OAuth Client [page 195].

● idpId - Identifier for the SAML trusted IDP:○ SAP Cloud Platform account:

1. Select Admin Integrations SAML Local Identity Provider .2. Copy all content in the "Issuer" text field.

○ SAP Jam instance (Your own or SAP Cloud Platform account):

1. Select Trust Trust Management .2. Copy all content in the "Local Provider Name" text field.

● subjectNameId - The identifier for the user. Can be an email address or a unique identifier, depending on the company type:○ SAP Jam instance (Your own or SAP Cloud Platform account):

1. Select Admin Users Users & Member Lists .2. Copy all content in the "Issuer" text field.

● subjectNameIdFormat - "email" or "unspecified"● idpPrivateKey - Generate a Base64 encoded IDP private key:

○ SAP Cloud Platform account:

1. Select Trust Local Service Provider .2. Click Edit.

3. Select Configuration Type Custom .4. Copy all content in the Signing Key text field.

○ If a private/public key has not been generated:1. Click Generate Key Pair.2. Copy all content in the Signing Key text field.3. Click Save.

○ SAP Jam instance (Your own or SAP Cloud Platform account):

NoteDo not use this procedure if SAP Jam already has integrations that use SAP Jam as a SAML Local Identity Provider. This will break existing integrations.


http://help.sap.com/disclaimer?site=https%3A%2F%2Fdeveloper.sapjam.com%2F

1. Select Admin Integrations SAML Local Identity Provider .2. Click Generate Key Pair.3. Copy all content in the Signing Private Key (Base64)" text field.4. Click Save changes.

Configure Optional Keys

● clientSecret - The OAuth client secret:○ SAP Jam instance (SAP Cloud Platform account):

○ Not recommended.○ If supplied the clientKey is not included in the SAML assertion as an attribute.○ It is recommended to not supply the clientSecret, but it is included to show how SAML IDPs that

cannot add assertion attributes can work with the OAuth SAML2 bearer flow.● subjectNameIdQualifier: Use the value "www.successfactors.com" for SuccessFactors integrated

companies when using the 'unspecified' name id format.

Setup the Eclipse Run Configuration

Run this project by invoking the "main" method of the OAuth2SAMLWorkflowSample class and supplying command line arguments of the form "key1=value1", "key2=value2", "key3=value3" ... in the "Argument's" tab of Eclipse's "Run Configuration":

1. Right Click on the "main" method of the OAuth2SAMLWorkflowSample class2. Select "Run Configuration"3. Click the "Argument's" tab4. Configure the "Program Arguments" Text Field:

○ Use a SAP Cloud Platform account as your SAML Trusted IDP:○ baseUrl=https://developer.sapjam.com clientKey={SAP JAM OAUTH CLIENT KEY} idpId={LOCAL

PROVIDER NAME} subjectNameId={USERNAME EMAIL ADDRESS} subjectNameIdFormat=email idpPrivateKey={SIGNING KEY}

○ Use your own Base64 encoded IDP private key and use SAP Jam as your SAML Trusted IDP:○ baseUrl=https://{YOUR SAP JAM URL} clientKey={SAP JAM OAUTH CLIENT KEY} idpId={SAP

JAM SAML TRUSTED IDP} subjectNameId={USERNAME EMAIL ADDRESS} subjectNameIdFormat=email idpPrivateKey={BASE64 ENCODED IDP PRIVATE KEY}

5. Configure the VM Arguments Text Field (Optional Proxy configuration):○ -Dhttp.proxyHost={HTTP PROXY HOST}○ -Dhttp.proxyPort={HTTP PROXY PORT}○ -Dhttps.proxyHost={HTTPS PROXY HOST}○ -Dhttps.proxyPort={HTTPS PROXY PORT}



Run this Project

Run this project as a Java Application using the Run Configuration you just setup.

Result

The program will print the OAuth access token to the console. This OAuth access token can then be used to easily make calls to the OData API.

Example 1:

1. Program creates an OAuth access token of "987sSDL8cxbm323LKJ091Mkjdvy820sdcvKbCD2q" from https://developer.sapjam.com

2. Use the following curl command to get the profile of the user authenticated by this OAuth access token in JSON format:○ curl https://developer.sapjam.com/api/v1/OData/Self -H "Authorization: OAuth

987sSDL8cxbm323LKJ091Mkjdvy820sdcvKbCD2q" -H "Accept: application/json"

Sample

Here is a sample run configuration for the user [email protected] on a test company (berry.com) on developer.sapjam.com that will create an OAuth2 access token for the user [email protected] with the value of "SAurLKj98s7fdOHFljdshfs98dsjdfhDFSDFAksq". This test company has:

● An OAuth Client setup in SAP Jam● A user named [email protected] setup in SAP Jam

Arguments

● Program Arguments:○ baseUrl=https://developer.sapjam.com clientKey={CLIENT KEY} idpId={IDP ID}

[email protected] subjectNameIdFormat=email idpPrivateKey={IDP PRIVATE KEY}● VM Arguments (run in the SAP Corporate network in Vancouver)

○ -Dhttps.proxyHost={HTTPS PROXY HOST} -Dhttps.proxyPort={HTTPS PROXY PORT}


Screenshot from Eclipse run configuration:

Program output

Proxy settings:

http.proxyHost=null

http.proxyPort=null

https.proxyHost={HTTPS PROXY HOST}

https.proxyPort={HTTPS PROXY PORT}

Command line arguments: {baseUrl=https://developer.sapjam.com, clientKey={CLIENT KEY}, idpId={IDP ID}, [email protected], subjectNameIdFormat=email, idpPrivateKey={IDP PRIVATE KEY}

POST https://developer.sapjam.com/api/v1/auth/token

SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".

SLF4J: Defaulting to no-operation (NOP) logger implementation

SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

Signed assertion: <?xml version="1.0" encoding="UTF-8"?>

saml2:Issuerbo.ilic.test.idp/saml2:Issuerds:SignedInfods:Transforms/ds:Transform/ds:Transformsds:DigestValueJK3wsqeaWOYrB+Nwmq9gmQJK4E0=/ds:DigestValue/ds:Reference/ds:SignedInfods:SignatureValuekjh2werVBSWe456409scxkljsldfSDFJ3Vlkn+lkjsdflkj/LKjslkjl909asdz/kizcFDSOInhjhsdf+lkjlbxkjvcx98dbxcbc/sdflkjIDUFSUQWE+xcvjlxerEWRaLKSJVSLKJSV3432/SDFLKJXL092809809fsbj+lkjcblkjxwu32nlvjnds09u09cuvi890u78+lhsblhlk231423/Slkvchxlvk234lkjslkfdspoibv+098XCXZCdbvcxbc+sdflkjhlkj3wrnvs/987xbzoisufmnwDVDSFDSFD



+89oiuhwac09809LJLKJx09KJLKJpwqexcv3Zsdf==/ds:SignatureValue/ds:Signaturesaml2:[email protected]/saml2:NameID/saml2:SubjectConfirmation/saml2:Subjectsaml2:AudienceRestrictionsaml2:Audiencecubetree.com/saml2:Audience/saml2:AudienceRestriction/saml2:Conditionssaml2:AttributeStatementj23DSF65dkj402DS3nz1/saml2:AttributeValue/saml2:Attribute/saml2:AttributeStatement/saml2:Assertion

Request body: client_id={CLIENT ID}&grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Asaml2-bearer&assertion={ASSERTION}

HTTP response code: 200

Response body: {"access_token":{ACCESS TOKEN}}

OAuth access token: {OAUTH ACCESS TOKEN}

17.1.3.4.4 Format Requirements for SAML Assertions and Unsolicited Responses

This page describes the specific format requirements for SAML assertions and unsolicited responses.

The following are details on the requirements for a SAML unsolicited response or assertions used with the following authentication endpoints:

● POST /api/v1/auth/token (creates an authorized OAuth2 access token from a SAML2 assertion)

The specification of the user within SAP Jam Collaboration is determined entirely by data within the assertion (or unsolicited response). The Issuer element of the assertion must have the same value as the IDP ID for the SAML trusted IDP as configured by the company admin.

To identify the user in SAP Jam Collaboration by their email address, the SAML Subject NameID element can look like this:

<saml:NameID Format="urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress">[email protected]< /saml:NameID>

The SuccessFactors user ID can also be used as the identifier for the user in SAP Jam. This is typically the user ID that the company "naturally" identifies its users with. The format is similar to this:

<saml:NameID Format="urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified" NameQualifier="www.successfactors.com">1819187</saml:NameID>

In fact, this format is superior to asserting based on email addresses, because email addresses are not guaranteed to be unique or even present within an SAP Jam company. For example, if two users share the same email, then an assertion based on an email address for one of those users will not work because it is ambiguous. Similarly, if a user doesn't have an email address, then an assertion based on email won't be able to specify that user, but an assertion based on the SuccessFactors userid will always work and uniquely identify the user.

To be specific:

● The Format attribute must be urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified● The NameQualifier attribute must be www.successfactors.com


● The NameID value must be the userid in the SuccessFactors IDP for the user

Note that SAML responses generated by the SuccessFactors platform IDPs use www.successfactors.com as their Issuer value within the Response. Thus, following the SAML standard, this NameQualifier value is required to let SAP Jam know that the NameID value is not being interpreted with respect to the native format of the IDP issuing the assertion, but rather with the SuccessFactors IDP.

In terms of other requirements on the assertion, there are additional checks on the audience, subject confirmation method, and recipient as required by OAuth2 in the SAML2 specification.

The audience should be "cubetree.com". This is the main local SP name of SAP Jam and the recommended value. The SAML spec also allows the token endpoint URL of the authorization server to be used here (that is, the request URL without query parameters). The SuccessFactors IDP uses "www.successfactors.com" as the audience. We allow it for compatibility.

The subject confirmation method is required to be urn:oasis:names:tc:SAML:2.0:cm:bearer. The bearer subject confirmation is the only one that allows the Subject to be confirmed without further work on the part of the receiving SP.

The recipient is optional, for the sorts of assertions SAP Jam accepts, but if included it must match the base request URL. For example, https://jam4.sapjam.com/v1/groups for a [POST] /v1/groups from a SAML response call. SAP Jam checks that the scheme, host, port and path match, that is, it ignores query parameters.

Pretty much all assertions or SAML responses created by a standard IDP will include all these elements. They provide protection against the use of a valid assertion from an IDP being used at a SP that wasn't the intended target of the assertion, or in the context where the assertion was not meant to fully establish the identity of the user (for example, the bearer token).

17.1.3.5 SAML Authorization API Reference

The API endpoints for the SAML Authorization workflow are documented in this section.

17.1.3.5.1 [POST] /api/v1/auth/token

Create an OAuth2 access token from a SAML assertion.

Request Elements

URL

https://<jam#>.sapjam.com/api/v1/auth/token



HTTP Request Method

POST

HTTP Request Header

Field Required Description

Content-Type

Required The Content-Type header must be application/x-www-form-urlencoded.

POST Body Parameters

Field Required Description

client_id Required The OAuth client consumer key.

client_secret

Not Recommended

The client_secret is only required is there is not a client_id attribute in the SAML assertion. We recommend that you do not use the client_secret parameter, and that you do use the client_id attribute.

grant_type

Required The grant_type value must be urn:ietf:params:oauth:grant-type:saml2-bearerHowever, each of the colons must be set in URL encoding as '%3A', so, the actual string is:urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Asaml2-bearer

assertion Required The SAML authorization assertion of the identity of the user for whom you want an auth token. This must be Base64 encoded.

NoteFor more details, please see the SAML Bearer Assertion specification, http://tools.ietf.org/html/draft-ietf-oauth-saml2-bearer-14 .

Response Elements

JSON Response Example

URL Method

https://<jam#>.sapjam.com/api/v1/auth/token?$format=json POST




{ "access_token":"" }

HTTP Status Codes


200 OK The requested auth token is retrieved successfully.










NoteTo test the retrieved auth token, use it in a simple GET operation, such as the [GET] /Groups('{Id}') API call.

17.1.3.6 Authentication with single-use tokens

A single-use token can be used to authenticate a user web session that is valid for only one request to SAP Jam. You can create a new single-use token by making an API call to SAP Jam using a [POST] /v1/single_use_tokens HTTP request. Every API call has a user context/authorization. The token will be used to create a web session for the authenticated API user at the time of the creation of the token. A successful request returns a token that is used to authenticate a SAP Jam web session.

17.1.3.6.1 [POST] /v1/single_use_tokens

A single-use token is typically a very short-lived token that is used to display some content without requiring the end-user to log in to view it or without providing the user with a longer lived auth_token that can be used multiple times. This page shows you how to create a single-use token.

Request Elements

URL

https://{jam_domain}/v1/single_use_tokens

HTTP Request Method

POST

Response Elements

XML Response Example

URL Method

https://{jam_domain}/v1/single_use_tokens POST

<?xml version="1.0" encoding="UTF-8"?><single_use_token id=""> <created_at>2012-12-15T03:03:08Z</created_at> <expires_by>2012-12-15T04:03:08Z</expires_by> </single_use_token>

As the name implies, once you have retrieved the token, it is good for only one use. It also is typically given a very short lifespan. It is used by appending it to a URL that would normally require a log in.

HTTP Status Codes


201 Created The requested resource creation is successful, and a full payload of the created resource is returned.










17.1.3.6.2 Test the single_use_token

This page demonstrates the use of a single use token.

Request Elements

Use a single-use token to authenticate a user to allow them to access a specific secure endpoint for a single instance of access. It is used by appending the single-use token to a URL that requires authentication to access.

URL

The following URL is to a SAP Jam page that requires authentication to view. By appending a single-use token, a user can access that page one time, and they are not provided with a token that will allow them access to



other pages or endpoints. The generated single-use token can only be used once, and it typically is given a very short lifespan.

https://{jam_domain}/groups/dashboard?single_use_token=_<single_use_token>

HTTP Request Method

GET

HTTP Input Headers

Header Field Use Description

Authorization: Bearer <access_token>

Mandatory

The Authorization header field should be set as shown, with "<access_token>" replaced with the current user's access token.

Response Elements

The response contains a lot of HTML to render the page, which is omitted here.

HTTP Status Codes










Important Disclaimers and Legal Information

HyperlinksSome links are classified by an icon and/or a mouseover text. These links provide additional information.About the icons:

● Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your agreements with SAP) to this:

● The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.● SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any

damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.

● Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this information.

Beta and Other Experimental FeaturesExperimental features are not part of the officially delivered scope that SAP guarantees for future releases. This means that experimental features may be changed by SAP at any time for any reason without notice. Experimental features are not for productive use. You may not demonstrate, test, examine, evaluate or otherwise use the experimental features in a live operating environment or with data that has not been sufficiently backed up.The purpose of experimental features is to get feedback early on, allowing customers and partners to influence the future product accordingly. By providing your feedback (e.g. in the SAP Community), you accept that intellectual property rights of the contributions or derivative works shall remain the exclusive property of SAP.

Example CodeAny software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of example code unless damages have been caused by SAP's gross negligence or willful misconduct.

Gender-Related LanguageWe try not to use genderspecific word forms and formulations. As appropriate for context and readability, SAP may use masculine word forms to refer to all genders.

SAP Jam Communities Administration Guide 1902Important Disclaimers and Legal Information P U B L I C 245

www.sap.com/contactsap

© 2019 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 https://www.sap.com/about/legal/trademark.html for additional trademark information and notices.

THE BEST RUN

https://www.sap.com/about/legal/trademark.html

SAP Jam Communities Administration Guide 1902 · 1 About SAP Jam Communities Objectives SAP Jam...

Documents

Transcript of SAP Jam Communities Administration Guide 1902 · 1 About SAP Jam Communities Objectives SAP Jam...