SAP Jam Administrator Guide
November 11, 2016 | Author: Tamas Koban | Category: N/A
Short Description
JamSAP Jam is an enterprise social networking solution that allows you to bring your employees, partners, and customers ...
Description
SAP Jam Administrator Guide Document Version: November 2015 Release – 2015-11-05
SAP Jam Administrator Guide
Content
1
Get started. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.1
About SAP Jam. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.2
SAP Jam security and compliance FAQ. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.3
SAP Jam integrated with SuccessFactors Foundation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.4
SAP Jam administrators and the Admin console. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.5
View your SAP Jam service General information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.6
Initial administrator tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
1.7
Single sign-on and deep linking. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2
Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.1
Configure SAP Jam Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19 Microsoft® Lync® integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
2.2
Customize your Homepage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
2.3
Configure SAP Jam Branding and Support options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
2.4
Configure Content Administration options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
2.5
Configure Email Templates options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
2.6
Configure the Getting Started Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
2.7
Configure a Custom Terms of Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
2.8
Configure an Extranet Terms of Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
2.9
Configure Kudos options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
2.10
Configure Security options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
2.11
Configure Compliance monitoring. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
3
Administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
3.1
Send Invites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
3.2
Users administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 About SAP Jam user types permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 User privileges administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Create and manage member lists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64 About notification emails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
3.3
Configure the SAP Jam Mobile app. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
3.4
Custom Profile administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
3.5
Group templates administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
3.6
Create an auto group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
3.7
Hashtags administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
3.8
Overview of extranet administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
3.9
Extranet Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
2
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Content
3.10
Company administrator Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94 Activity Summary by Month or Week report details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Company Settings Changes report details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Company User Detail Report details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Compliance report details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Content Views Report by Week or Month details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Contribution Report by Object by Week or Month report details. . . . . . . . . . . . . . . . . . . . . . . . . . 100 Engagement Report details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Expertise Report details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Group Activity Report details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Group Member Activity Report details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Group Template Activity Report details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Kudos Detail report details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105 Mobile Activation Report details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Terms of Service Compliance Report details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 Top Disk Usage per Group or per User report details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 User Contribution Activity Report details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108 User Contribution by Week or Month report details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 User Page Views Report by Week or Month details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
4
Integrations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
4.1
Integrations overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
4.2
Integrate business records. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 Develop a new or custom business records integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 Integrate SAP CRM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 Integrate SAP ECC (SD). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132 Integrate SAP Cloud for Customer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Integrate SuccessFactors Learning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146 Configure a business record filter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Configure a business record sort order. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 Configure access to business records in SAP Jam. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
4.3
Access and Authorization overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 Add a Trusted Certificate Authority. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156 Add an OAuth Client. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 Add SAML Trusted IDPs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 Configure SAP Jam as a SAML Local Identity Provider. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
4.4
Integrate document repositories. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 Integrate SharePoint 2010 or 2013. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 Federate SAP Jam search results into SharePoint searches. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 Integrate Alfresco One 4.2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 Integrate SAP Extended ECM by OpenText. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 Integrate Office 365 SharePoint Sites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
SAP Jam Administrator Guide Content
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
3
Integrate SAP Mobile Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Integrate Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 Integrate Google Drive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .201 Troubleshoot CMIS Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Access document repositories in SAP Jam groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .203 Access Office 365 Online Sites in SAP Jam groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204 4.5
Add an OpenSocial Gadget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
4.6
Integrate SAP Jam with gamification vendors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
4.7
Add Extensions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
4.8
Use the Widget Builders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 Use the Feed Widget Builder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .215 Use the Recommendations Widget Builder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 Use the Share Widget Builder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .223
4.9
Use the SAP Jam API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
5
Get support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
5.1
Request Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
4
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Content
1
Get started
1.1
About SAP Jam
SAP Jam is an enterprise social networking solution that allows you to bring your employees, partners, and customers together with the documents and application data necessary to enable effective, collaborative problem solving and decision making. These activities are organized in a structured form that provides intuitive access to content and discussions, while encouraging the pursuit of business-critical objectives, and while following established processes through SAP Jam "work patterns". SAP Jam provides features such as the ability to create wikis and blogs, discussions on ideas, questions, and issues, and share images, videos, and documents—with document versioning—as well as providing tools to create and assign tasks, schedule meetings and calendar events, run polls, chat, and view and discuss data from external business-critical applications. These activities are organized within public or private groups that are internal to your organization or external to include customers and partners, and which can be based on templates designed to address specific issues, key business objectives, or services.
System Requirements SAP Jam is a cloud-based offering that requires a connection to the Internet and a supported web browser. Working with SAP Jam requires the following: ● You must use one of the following supported web browsers: ○ Internet Explorer - versions 8 to 11 (IE 8 support will be dropped in Februrary, 2016) ○ FireFox - any version ○ Safari - versions 5, 6, or 7 ○ Chrome - any version prior to v.42; v.42 and later are not supported ● You must have the following browser configurations set: ○ SAP Jam is a Web 2.0 application that uses caching heavily for static content. We recommend that you do not clear your organization's web proxy cache as this will significantly impact performance. The minimum recommended cache size is 250 MB. Newer web pages must be enabled. ○ HTTP 1.1 and JavaScript must be enabled. ○ Browser session cookies (non-persistent) must be enabled for authentication purposes. ○ The browser must allow pop-up windows from SAP Jam domains. ● The Adobe Flash plug-in is required. Currently, SAP Jam supports Adobe Flash Player 10.0 or higher. ● The Java Runtime Environment (JRE) 1.7 or higher is required for recording audio and video; JRE 1.7.0_6 or higher is required to use the learning management system (LMS) offline player. ● Network bandwidth speeds of 300-400 Kbit/s are required.
SAP Jam Administrator Guide Get started
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
5
Note There are additional requirements for the learning management system package (LMS), for the virtual learning classroom, and for the SuccessFactors HCM suite. Please check with your SAP Jam representative to ensure your users' equipment meets these requirements if you purchase either of these packages.
SAP Jam editions Depending on your edition of SAP Jam, different features are available. The document that describes all features available in SAP Jam, regardless of the edition in which the features are contained, can be found at: http://www.sap.com/corporate-en/about/our-company/policies/cloud/service-specifications.html
1.2
.
SAP Jam security and compliance FAQ
Can documents opened in SAP Jam be stored locally and then be accessed after a user's access has been revoked? The behavior for this varies by platform: ● For SAP Jam mobile on Android, iOS, and Blackberry, there is no local caching. However, it is possible to download and open documents that a given user has access to on the device, and this data could potentially be stored in a non-encrypted way. For example, a user could open a PowerPoint document and save it to an iOS device via Apple Keynote to modify the document. ● For the SAP Jam web application, whether accessed from a mobile device or from a laptop or desktop standard web browser interface, document image previews are cached locally as images. Also, a document can be downloaded from the web application and saved to disk if the user has permission to do so. It is possible to set a specific document, or set of documents, inside SAP Jam to be "Read Only", which disallows any download of the original source document, and only allows a user to view the image previews in the mobile and web applications. It is also possible to set device restrictions on both the mobile and desktop devices to disallow caching of any type and to forbid downloads. This is achieved by leveraging the OEM OS provider's capabilities to restrict access to the local disk, and is dependent on the local OS. For example, device policies could be loaded on an iOS-based device to prevent local download of any content, or installation of unapproved applications such as Apple Keynote. Can a person who has left the company still access SAP Jam or any SAP Jam resources from his or her personal device? No, once access to SAP Jam is removed, the mobile or web application stops responding to the user's requests immediately. Is it possible to identify which device has performed a specific action in SAP Jam by IP address or by International Mobile Station Equipment Identity (IMEI)?
6
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Get started
Yes, but this information is currently restricted to SAP Customer Support administrators. Customers must open a service request to gain access to the detailed logs. In case of a legal prosecution, can we retrieve the contents posted by the concerned user or group? If so, how and under what circumstances? SAP Jam supports an in-product user interface for privileged company administrators to download all contents from within a given group as a single .zip file. This includes all conversations, forum posts, comments, document contents, etc., in a machine-readable format suitable for a legal hold. Is there a connector or other access between SAP Jam and HP Autonomy Consolidated Archive (ACA)? We have not evaluated HP ACA to determine if it supports SAP Jam; however, there is an SAP Jam API that provides access to: ● Audit log information on all document uploads and downloads ● Usage reporting logs that provide information on how often a document has been used, if ever ● Usage reporting logs that provide information on when a document or set of documents was last updated ● The ability to download individual documents in their original format (PPT, Word, Excel) ● The ability to download all group content as .zip file ● The ability to delete any content inside SAP Jam These capabilities could be leveraged in conjunction with archiving policies to fulfill company data retention policies. Please see the SAP Jam Developer Guide on the SAP Help Portal, http://help.sap.com/sapjam for documentation of the APIs. Can the data deleted from the trash bin be reinstated by an experienced computer user? SAP Jam has a built-in trash bin that helps to eliminate the possibility of inadvertently deleted content. Both users and company administrators can retrieve items from the trash bin if a recovery is warranted. In the event that a file or piece of content is permanently removed from the trash bin, it cannot be recovered by anyone, including very experienced computer users.
1.3
SAP Jam integrated with SuccessFactors Foundation
When SAP Jam instances are integrated with SuccessFactors Foundation, user access to SAP Jam is granted by the company administrator through SuccessFactors Foundation administration settings using role-based permissions (RBP). The default configuration for this integration provides all users configured with access through SuccessFactors Foundation with access to SAP Jam. However, a company administrator can override this default configuration and choose which roles, users, or groups of users get access to SAP Jam. Single sign-on (SSO) is also available with this integration.
SAP Jam Administrator Guide Get started
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
7
Requesting SAP Jam integration with SuccessFactors Foundation Typically SAP Professional Services configures your SAP Jam instance integrated with SuccessFactors Foundation during provisioning, but if this is not done, you can request the integration by creating a support ticket in the Support Portal https://csauthfs.successfactors.com/adfs/ls/ with the following information: ● Request Summary: SAP Jam Integration Request [Customer Organization Name] ● Product: SAP Jam ● Category: Configuration Change Request In the Request Details, make sure to include the following information: ● Table 1: SuccessFactors Foundation Instance information Field
Details
ENVIRONMENT
Select your environment from the list of available environments below this table.
COMPANY ID
Company Id as it appears in Provisioning.
Note ID is case-sensitive. COMPANY NAME
Company Name as it appears in Provisioning.
SAP JAM PRODUCT
Basic (Included with SuccessFactors Foundation Only), Advanced (For SuccessFactors Foundation bundles only), Advanced Plus, Enterprise.
ADMIN ACCOUNT NAME
First / Last name of the Admin account that will be used to sync the Employee data from SuccessFactors Foundation to SAP Jam. The account must have a minimum of full Em ployee Export permissions.
Note If this user is deactivated in SuccessFactors Foundation, the sync will fail. We recom mend using a System Admin account, not a personal Admin account. ADMIN ACCOUNT USER NAME
Please provide the Username for above Admin Account. This username is needed for the API calls between SAP Jam and SuccessFactors Foundation.
Note If this user is deactivated in SuccessFactors Foundation, the sync will fail. We recom mend using a System Admin account, not a personal Admin account. User name is case sensitive. TEST OR PROD INSTANCE
Select if this is a test or production instance. For production instances, specify if this in stance is Live.
● The following is the list of data centers from which the SuccessFactors Platform and the SAP Jam environments are available:
8
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Get started
Table 2: SuccessFactors Foundation and SAP Jam data centers Old name
New name
Location
SuccessFactors Platform (Production & Preview)
SAP Jam (Prod. & Pre view)
DC2
Amster dam1 /HC M
Amster dam, NL, EU
https:// performancemanager.successfactors.eu https://hcm2preview.sapsf.eu
https:// jam2.sapjam.com
DC4
Chan dler1 /HC M
Chandler, AZ, US
https:// performancemanager4.successfactors.com https://hcm4preview.sapsf.com
https:// jam4.sapjam.com
DC8
Ash burn1 /HC M
Ashburn, VA, US
https:// performancemanager8.successfactors.com https://hcm8preview.sapsf.com
https:// jam8.sapjam.com
DC10
Sydney1 / HCM
https:// Sydney, NSW, AUS performancemanager10.successfactors.com
https:// jam10.sapjam.com
https://hcm10preview.sapsf.com DC12
Rot1 /HC M
DC15
St. LeonRot, DE, EU
https:// performancemanager5.successfactors.eu https://hcm12preview.sapsf.eu
https:// jam12.sapjam.com
Shang Shanghai, hai1 /HCM CN
https://performancemanager15.sapsf.cn
https:// jam15.sapsf.cn
DC17
Toronto1 / Toronto, HCM ON, CA
https://hcm17.sapsf.com https://hcm17preview.sapsf.com
https:// jam17.sapjam.com
DC18
Mos cow1 /HC M
https://hcm18.sapsf.com https://hcm18preview.sapsf.com
https:// jam18.sapjam.com
Moscow, RU
Note: Services shown in cells with yellow backgrounds provide production environments only.
Automatic user provisioning SAP Jam gets its user information from SuccessFactors Foundation via a data transfer. The following table explains how SAP Jam employee profile attributes get mapped from SuccessFactors Foundation. Table 3: SuccessFactors Foundation to SAP Jam user attribute mappings SAP Jam Collabora tion attribute
SF Foundation import attribute
Status
STATUS
Locale
DEFAULT_LOCALE
SAP Jam Administrator Guide Get started
Comment
Real-time sync: The data sync of this field is done in near-real time, allowing immediate language switching in the UI.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
9
SAP Jam Collabora tion attribute
SF Foundation import attribute
Comment
Timezone
TIMEZONE
Real-time sync: The data sync of this field is done in near-real time.
Country
COUNTRY
Used by the Auto Group feature.
UserId
USERID
Auto-generated by SuccessFactors Foundation; for internal system use.
UserName
USERNAME
Department
DEPARTMENT
Used by the Auto Group feature.
Division
DIVISION
Used by the Auto Group feature.
Jobcode
JOBCODE
Used by the Auto Group feature.
Location
LOCATION
Used by the Auto Group feature.
Photo
PHOTO
First Name
FIRSTNAME
Real-time sync: The data sync of this field is done in near-real time.
Last Name
LASTNAME
Real-time sync: The data sync of this field is done in near-real time.
Job Title
TITLE
Real-time sync: The data sync of this field is done in near-real time.
Start Date
HIREDATE
Used by the Auto Group feature.
Email
EMAIL
Business Phone
BIZ_PHONE
Manager
MANAGER
Used by the Auto Group feature.
Direct Report
Auto-computed from all users with Manager = current USERID.
Supported Languages Table 4: User type access to company features Language
SuccessFactors
SAP Jam Collabora tion
Language
SuccessFactors
SAP Jam Collabora tion
English (US)
Yes
Yes
Arabic
Yes
Yes
Bulgarian
Yes
Yes
Chinese (Simplified)
Yes
Yes
Chinese (Traditional)
Yes
Yes
Croatian
Yes
Yes
Czech
Yes
Yes
Danish
Yes
Yes
Dutch (Netherlands)
Yes
Yes
English (UK)
Yes
Yes
Finnish
Yes
Yes
French (Canadian)
Yes
Yes
10
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Get started
Language
SuccessFactors
SAP Jam Collabora tion
Language
SuccessFactors
SAP Jam Collabora tion
French (France)
Yes
Yes
German (Germany)
Yes
Yes
German (Swiss)
Yes
No
Greek (Greece)
Yes
Yes
Hebrew
Yes
Yes
Hindi
Yes
Yes
Hungarian
Yes
Yes
Indonesian
Yes
Yes
Italian
Yes
Yes
Japanese
Yes
Yes
Korean
Yes
Yes
Malaysian
Yes
Yes
Norwegian (Bokmål)
Yes
Yes
Polish
Yes
Yes
Portuguese (Brazil)
Yes
Yes
Portuguese (Portugal)
Yes
Yes
Romanian
Yes
Yes
Russian
Yes
Yes
Serbian (Serbia)
Yes
Yes
Slovak
Yes
Yes
Slovenian
Yes
Yes
Spanish (Mexico)
Yes
No
Spanish (Spain)
Yes
Yes
Swedish
Yes
Yes
Thai
Yes
Yes
Turkish
Yes
Yes
Ukrainian
Yes
Yes
Vietnamese
Yes
Yes
Welsh
Yes
Yes
Note Language selection is configured in SuccessFactors Foundation.
1.4
SAP Jam administrators and the Admin console
SAP Jam administration is performed in the Admin console by two types of administrators: support administrators and company administrators.
To access the Admin console 1. As an SAP Jam company administrator or support administrator, click the Cog icon at the top of any SAP Jam page. A context menu is displayed.
SAP Jam Administrator Guide Get started
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
11
Figure 1: The cog icon's context menu
2. Select Admin from the context menu. If you don't have support administrator or company administrator privileges, this option will not appear in the context menu.
Figure 2: The Admin console
12
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Get started
Group administrators Group administrators have privileged capabilities to control the functionality of the SAP Jam Collaboration groups that they have created, or that they have been granted the privileges to help administer. Those privileges to not extend to other groups, nor to the SAP Jam Collaboration Admin console. For documentation on administering groups, see the SAP Jam Collaboration Group Administration Guide.
Support administrators Support administrators have access to a sub-set of the functionality available to company administrators. The role was established to provide company administrators with some relief of their workload by giving support administrators access to many of the day-to-day duties of SAP Jam Collaboration administration. This also protects the stability of the SAP Jam Collaboration service by limiting access to features that can have great impact on the functionality of the SAP Jam Collaboration service to a smaller group of company administrators whose main duties are the configuration and maintenance of SAP Jam Collaboration. Table 5: The support administrator menu and links to its documentation Support Administrators have access to the following sections of the Admin console: ●
Content Administration: Configure Content Administration options [page 33].
●
Users: Users administration [page 57].
●
SAP Jam mobile app: Configure the SAP Jam Mobile app [page 72].
●
Custom Profile: Custom Profile administration [page 76].
●
Group Templates: Group templates administration [page 80].
●
Auto Groups: Group templates administration [page 80].
●
Extranet Management: Extranet Management [page 92].
Figure 3: The support administrator menu
Company administrators Company Administrators have access to the full range of capabilities within the Admin console. This gives them the greatest power to change the look, feel, and functions of the SAP Jam service, but it also requires greater knowledge of the SAP Jam service, carries a greater responsibility, and therefore typically also requires a greater focus of their job duties on configuring and maintaining the SAP Jam service in a manner that suits the needs of their organization.
SAP Jam Administrator Guide Get started
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
13
Company administrators have access to all sections of the Admin console: Table 6: The company administrator menu and links to its documentation ●
General: View your SAP Jam service General information [page 15].
●
Features: Configure SAP Jam Features [page 19].
●
Customize your Homepage: Customize your Homepage [page 27].
●
Branding and Support: Configure SAP Jam Branding and Support options [page 27].
●
Content Administration: Configure Content Administration options [page 33].
●
Email Templates: Configure Email Templates options [page 38].
●
Getting Started Wizard: Configure the Getting Started Wizard [page 41].
●
Custom Terms of Service: Configure a Custom Terms of Service [page 44].
●
Extranet Terms of Service: Configure an Extranet Terms of Service [page 45].
●
Kudos: Configure Kudos options [page 46].
●
Security: Configure Security options [page 49].
●
Compliance: Configure Compliance monitoring [page 51].
●
Users (privileges management): User privileges administration [page 62].
●
Users (member lists management): Create and manage member lists [page 64].
Note This section is also available in the SAP Jam Group Administration Guide, where it can be viewed in context with other related group administration concepts and proce dures. To view this content, see the SAP Jam Group Administration Guide. ●
SAP Jam Mobile app: Configure the SAP Jam Mobile app [page 72].
●
Custom Profile: Custom Profile administration [page 76].
●
Group Templates: Group templates administration [page 80].
Note This section is also available in the SAP Jam Group Administration Guide, where it can be viewed in context with other related group administration concepts and proce dures. To view this content, see the SAP Jam Group Administration Guide. ●
Auto Groups: Create an auto group [page 84].
Note Figure 4: Admin console sections
This section is also available in the SAP Jam Group Administration Guide, where it can be viewed in context with other related group administration concepts and proce dures. To view this content, see the SAP Jam Group Administration Guide. ●
Hashtags: Hashtags administration [page 90].
●
Extranet Management: Extranet Management [page 92].
●
Reports: Company administrator Reports [page 94].
● External Applications: This page covers two main types of application that can be integrated in SAP Jam: business records and document repositories, each of which is documented in separate sections: ○ Business Records: For information on integrating data from other business-critical applications—such as SAP CRM, SAP ECC (SD), SAP Cloud for Customer, and SuccessFactors Learning—into SAP Jam, see the Integrate business records [page 116]. If you plan on developing a new or custom business records integration, see the External Applications section in the SAP Jam Developer Guide.
14
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Get started
○ Document Repositories: For information on integrating document repositories—such as SharePoint 2010 or 2013, SAP Extended ECM by OpenText, Alfresco One 4.2, Office 365 SharePoint Online Sites, SAP Mobile Documents, and Box—into SAP Jam, see Integrate document repositories [page 165]. ● Widget Builders: Use the Widget Builders [page 215]. ● OpenSearch Clients: Federate SAP Jam search results into SharePoint searches [page 174]. ● OpenSocial Gadgets: Add an OpenSocial Gadget [page 205]. If you plan on developing your own OpenSocial gadget, see the OpenSocial Gadgets section in the SAP Jam Developer Guide. ● OAuth Clients: Add an OAuth Client [page 158]. ● SAML Trusted IDPs: Add SAML Trusted IDPs [page 161]. ● SAML Local Identity Provider: Configure SAP Jam as a SAML Local Identity Provider [page 163]. ● Gamification: Integrate SAP Jam with gamification vendors [page 210].
The organization of the SAP Jam Administrator Guide This guide provides a task-based approach to configuring and maintaining the SAP Jam service. This manual is organized into the following chapters: 1. The Get Started chapter, in which this section appears, provides an introduction to the SAP Jam system and its administration. 2. The Configuration chapter deals with operations that are largely one-time set-up tasks, although they can be modified whenever required. 3. The Administration chapter deals with the day-to-day tasks of running the SAP Jam service. 4. The Integrations chapter provides the instructions required for both integrating external applications into SAP Jam and integrating SAP Jam into external applications. 5. The Get Support chapter provides a link to the website where you can file SAP Jam Support requests.
1.5 The
View your SAP Jam service General information Admin
General
page shows some general information about your SAP Jam service.
To view your SAP Jam service General information 1. Access the Admin console [page 11] and select General from the left navigation sidebar. The
Admin
SAP Jam Administrator Guide Get started
General
page is displayed.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
15
Figure 5: Admin > General information
2. The following information is shown: ○ Host: The domain name of the SAP Jam server group that your instance of SAP Jam is running on. The domain name is always in 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 software load that your instance of the SAP Jam service is running. ○ Product Version: The package of features and capabilities that are available in your instance of the SAP Jam service. ○ Product Instance name: This is the name set in the Branding page of the Admin console. ○ Integrated Company Name: [For integrated companies only] The name of your company as set in SuccessFactors Foundation. ○ 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 company has purchased, and the amount of that storage used in both percentage and gigabyte (GB) values.
Note Notifications are sent to company administrators when storage used hits 80% and 100% of their allocation. If you receive an "80% usage" notification, you should either free up storage by deleting old content or contact your SAP Jam 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 will occur daily, are not configurable, and cannot be turned off except by taking action to resolve the situation. ○ External User Licenses Purchased: The number of external user accounts that your SAP Jam service will support according to your contract.
16
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Get started
○ External User Licenses Used: The number of external user accounts that your SAP Jam service is currently using.
1.6
Initial administrator tasks
Some of the key tasks that SAP Jam Administrators should perform in an initial setup are listed below, with links to the sections of this document that explain how to accomplish these tasks: ● Determine who can create groups: See the last option in the User Management section of Configure SAP Jam Features [page 19]. ● Use auto groups: To create groups whose membership is set using member lists, see Chapter 3, “Member lists and auto groups”, in the SAP Jam Group Administration Guide. ● Apply your organization's branding to SAP Jam: To set up Jam with your organization's branding see Configure SAP Jam Branding and Support options [page 27]. ● Set up a support group using the Help and Support template: One of the most effective tools in onboarding your users to SAP Jam is to create a Jam Support group based on the Help and Support Template. To do this, see Chapter 2, “Groups, group templates, and subgroups”, in the SAP Jam Group Administration Guide. ● Set up internal and external Terms of Service: See: ○ Configure a Custom Terms of Service [page 44]. ○ Configure an Extranet Terms of Service [page 45]. ● Set up custom help: To set up custom help, you can specify a URL to the help location of either a group or another online source. To do this, see the last section, Help Settings, in Configure SAP Jam Branding and Support options [page 27]. ● Set your SAP Jam support contact email address: in the View your SAP Jam service General information [page 15] page. ● Generate company-wide reports: For reports on user adoption of SAP Jam, and reports on users' behavior in SAP Jam, see Company administrator Reports [page 94]. Note that there are also reports available to Group Administrators: see section 5.6, “Run group reports”, in the SAP Jam Group Administration Guide. ● On-boarding Users: Encourage your users to fill out all the information requested in the Getting Started Wizard: filling out their profile, adding their expertise, and installing the SAP Jam mobile app on their mobile devices.
1.7
Single sign-on and deep linking
Deep linking occurs when a hypertext link points to a page on a web site other than its home page that involves some navigation into the structure of the web site. For SAP Jam, deep linking is dependent on the single sign-on (SSO) configuration, which is typically done by Professional Services upon implementation. This can be, for example, a standard SAML 2.0-based single log on. If SSO is configured correctly, most Jam URLs should take the user directly to the indicated SAP Jam page after a series of redirects from SAP Jam to the company IDP and back to SAP Jam. There are some notable special cases, which are outlined below.
SAP Jam Administrator Guide Get started
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
17
SAP Jam handling of deep linking In normal SAP Jam usage, a user logs in and SAP Jam sets a cookie in the user's browser that indicates which company the user belongs to. When a user clicks on a deep link such as https://jam#.sapjam.com/groups/ wall/0Hm4gyKS4qegqd2qkkl8Xf, SAP Jam looks for that cookie, but it might not be found if: ● The user is new to SAP Jam and hasn't logged in before ● The user's browser configuration is set to delete all cookies on shutdown ● The user has manually deleted the required cookie or all cookies from their browser So, when a user clicks a deep link for a page within SAP Jam, it looks for the cookie that identifies which company a user belongs to. One of two things happen: 1. If SAP Jam finds the cookie, it will know which company the user belongs to and it will forward the user to their company-specific SSO page. 2. If SAP Jam cannot find the cookie, it will do one of two things: 1. SAP Jam will determine which company the content belongs to by analyzing the URL. There are two possible actions: 1. If the URL is to a private internal group, SAP Jam forwards the user to that company's SSO page. 2. If the URL is to an external group, a challenge is encountered because internal users (company employees) and external users (guest members) are authenticated in different SSO log-in pages. To deal with this, SAP Jam presents a screen to the user, asking them if they are an employee of the company or if they are a guest: 1. If they answer that they are an employee, they are forwarded to the employees' SSO log on page. 2. If they answer that they are a guest, they are forwarded to the guests' SSO log on page. 2. If SAP Jam finds one of the very few URLs that it cannot determine what company the user belongs to, such as happens if the link is to a user's home page (which is always something like https:// jam4.sapjam.com/auth/status), then there needs to have been extra information added to the URL to allow deep linking to work properly even in such a situation. For example: ○ https://jam#.sapjam.com/example.com/auth/status ○ https://jam#.sapjam.com/auth/status? companyId=innojam#&idp=sales.successfactors#.eu Once the user successfully authenticates against the corporate SSO they are redirected to SAP Jam with the deep link. Note that SSO configuration is a SuccessFactors Foundation feature that is generally set up by Professional Services at the time of implementation.
18
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Get started
2
Configuration
2.1
Configure SAP Jam Features
The
Admin
Features
page allows you to enable or disable many SAP Jam features and options.
To configure your SAP Jam features 1. Access the Admin console [page 11] and select Features from the left navigation sidebar to set which SAP Jam features and options are available to your users. The
Admin
Features
page is displayed.
2. Set any of the following options: Compliance options:
Figure 6: Compliance options
○ Enable Compliance Monitor: Select this option to monitor the content posted to SAP Jam and flag items that contain terms that are listed in the Compliance Dictionary. See Configure Compliance monitoring [page 51] for details on managing this feature. 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 without flagging Compliance Dictionary violations. If content has already been scanned prior to disabling, flagged items remain listed in the
Compliance
Pending Flagged Items
table.
○ Enable Profanity Monitor: Select this option to monitor the content posted to SAP Jam and flag items that contain terms that are listed in the Profanity Dictionary. See Configure Compliance monitoring [page 51] for details on managing this feature. 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 without flagging Profanity Dictionary violations. If content has already been scanned prior to disabling, flagged items remain listed in the
SAP Jam Administrator Guide Configuration
Compliance
Pending Flagged Items
table.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
19
○ Enable Unscannable Filter: Select this option to scan the file names, titles, and descriptions of otherwise unscannable content (such as images, videos, and zip files) for occurrences of the terms in the Compliance and Profanity dictionaries. This alert does not scan content retroactively. User Management options:
Figure 7: User Management options
○ Enable users to edit their profile information: [This feature is only available for companies that are not integrated with SuccessFactors Foundation [page 7].] Deselect this option to prevent users from making changes to their user profiles. Turning this option off is desirable if your organization imports user profile information from a source external to SAP Jam. ○ Skip the getting started wizard: [This feature is only available for companies that are not integrated with SuccessFactors Foundation [page 7].] Toggles whether the getting started wizard is displayed to new users upon their initial log-on. The getting started wizard displays a minimum of two panes of recommendations to new users who are logging on for the first time: one pane displays up to ten people that the new user might choose to follow, the other pane displays a list of groups they might choose to join. A possible two more panes can be displayed, as is set in the Configure the Getting Started Wizard [page 41] section. ○ Show Profile Photos: 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: Deselect this option to prevent users from uploading their own user profile photos. Turning this option off is desirable if your organization imports user profile photos from a source external to SAP Jam. This option is automatically disabled if Show Profile Photos is deselected. ○ Show Profile Job Titles: If selected, job titles will be displayed in users' profiles for each user who has a job title. If deselected, job titles will not be displayed in users' profiles. ○ Enable all users to disable other users: [This feature is only available for companies that are not integrated with SuccessFactors Foundation [page 7].] Deselect this option to allow only company administrators to disable a user. ○ Enable new users to sign-up and join this network: [This feature is only available for companies that are not integrated with SuccessFactors Foundation [page 7].] If this option is selected, new users within your organization's network will be able to create an account on your SAP Jam service. Deselect this option to limit account creation to company administrators.
20
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
○ Enable all users to invite new users into this network: [This feature is only available for companies that are not integrated with SuccessFactors Foundation [page 7].] Select this option to allow all users to invite new users to join your organization's SAP Jam. Deselect this option to limit this ability to company administrators. ○ Require company admin approval for new users of this network: [This feature is only available for companies that are not integrated with SuccessFactors Foundation [page 7].] Select this option to limit the ability to invite new users to join your organization's SAP Jam instance to SAP Jam company administrators. ○ Enable users to create their own groups: Select this option to allow users to create their own groups. If deselected, only SAP Jam administrators can create groups. ○ Show profile pages for alumni: Select this option to allow users to continue to view the profile pages of people who have left your organization. ○ Clear profile info for alumni: Select this option to remove the personal information and image of users who have left your organization from SAP Jam. If this option is selected, alumni users' office location information is removed, but their manager and job title information is retained. Feature Management options:
Figure 8: Feature Management options (part 1)
○ Enable API: Enable the API to allow SAP Jam to be integrated with the SAP Jam Mobile app, SharePoint, and SuccessFactors Learning. ○ Enable File Sharing: Enable this feature to allow users to upload files to SAP Jam. ○ Enable Feed Share: Enable this feature to add a Share button, to feed entries about their own actions, which allows users to share those updates with a specified group or with the entire company, as shown in the following image.
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
21
Figure 9: Enable Feed Share result
○ Enable Content Rating: Enable this feature to allow users to rate content that has been uploaded to SAP Jam. ○ Enable External Group Creation: Select this option to allow the creation of private groups that are intended for, and accessible to, users who are not located within your organization's network. ○ Enable Chat: In SAP Jam, users can create chat rooms and invite colleagues to join. From the Chat Rooms tab, users can see a list of available chat rooms in your company and view a transcript for each room. Enable this feature to allow your users to create chat rooms.
Note Chat rooms are public and available to everyone in your company. ○ Enable Company Directory: Enable this feature to allow users to see your company directory and look for other users. ○ Enable Alumni Directory: Enable this feature to allow users to see your alumni directory and look for former colleagues. ○ Wikis: Wiki pages let your users create and share content in SAP Jam. Wiki pages are an online content asset residing within a group or available across the company from a user's profile page. In a wiki page, your users can create differently formatted text, tables, pictures, or video content. In addition, your users can attach any type of file and dynamic widgets to a wiki page. Users can assign existing tags to a wiki page or create their own ones. Enable this feature to allow your users to create wiki pages in SAP Jam. ○ Enable Company Wiki as default login landing page for all company users: You can configure SAP Jam so that all company users are automatically redirected to the company wiki as their default start page when they login.
22
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
Figure 10: Feature Management options (part 2)
○ Application Launcher: Enables users to open, edit, and save Microsoft Office documents in SAP Jam as if they were on their local file system when they click on the application launcher button for the file in the SAP Jam Content section. This allows them to edit the file without having to download and upload it. ○ Private Messages: Allows you to control the availability of private messaging between the users in your organization. ○ Recommendation Tiles: Enable this feature to display recommendation tiles in the Feed Updates section of a Group. ○ Videos: SAP Jam lets users create videos using either screen capture or webcam. To allow your users to create and view videos in SAP Jam, this feature must be enabled.
Note For SAP Jam to play a video, the Adobe Flash Player must be installed in your users browsers. Also, in order to record a video, Java Runtime Environment (JRE) 1.7.1 or higher is required. For more information, see System Requirements [page 5]. ○ Include Private Group Details: Select this feature to allow SAP Jam administrators to view private group names in reporting and Compliance features. Additionally, SAP Jam administrators will be able to run reports against a specific private group.
Figure 11: Feature Management options (part 3)
○ Enable integrations: Select this feature to allow users to sync in news feeds from other services such as Google Calendar, Twitter, and Tripit.
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
23
Note In order to set up integrations, users need to have an account with each external service. ○ Show Recruitment Data (non-integrated)/Hire Date (integrated) in member profile: Select this feature to display hire date information in users' profile pages. ○ Send daily alert emails to all members: SAP Jam sends users content and updates via email. Select this feature to allow SAP Jam to send daily alert emails to all members. ○ Send active task reminder to all members: Select this feature to allow SAP Jam to send active tasks reminders to all members. ○ Allow User Level Reporting: Select this feature to allow SAP Jam users to view and run group reports. ○ Restrict access to Company Admins only: This option depends on the Allow User Level Reporting option being selected. If you select this option, only company administrators will be able to run and view group reports. ○ Enable Gamification: Select this feature to allow integration with gamification vendors. ○ Enable Microsoft® Lync® integration: Select this option to enable use of Microsoft® Lync® when users click on Message at the bottom of any SAP Jam user pop-up (hover card). ○ Enable Employee Central Time Off integration Select this option to enable Employee Central Time Off bookings to be displayed in SAP Jam. ○ Enable away alerts by default for new time offs Select this option to allow Employee Central Time Off to display away alerts for users on time off when other users search for or enter a user's name who has set their Employee Central Time Off.
Note The preceding two options require that you have performed the Employee Central Time Off integration as documented in the following documents, which are located in the SuccessFactors HCM Suite Integration section of the SAP Help Portal: ○ Time Off and Employee Central Payroll Integration Guide ○ Metadata Framework (MDF) Implementation Guide , Chapter 10 MDF Security Using Role-Based Permissions, sections 10.1 and 10.2. Note that you may need to modify rules for the EmployeeTime object (see "Adding Rules", section 3.3.4). ○ Hide contact information for extranet users: Select this feature to hide information on other extranet users when a user is logged in as an extranet user. This is a privacy option that hides contact information on extranet users from other extranet users. ○ Enable search appliance integration: Select this feature to allow integration with your company's search appliance. Select the search appliance authorization mechanism from the OAuth client for search appliance integration drop-down menu. This menu is populated from the Admin > OAuth Clients [page 158] page. Deprecated Features: Select any of the following deprecated features to enable them: ○ Company section ○ External widgets (icon in wiki editor)
24
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
Figure 12: Deprecated Features
Note Deprecated features still work and are fully supported, however SAP reserves the right to remove these deprecated features in any future release. 3. When you have the feature availability and feature behavior options set to your satisfaction, click Save changes.
Note If you do not click Save changes, the options that you have selected will not be applied.
2.1.1 Microsoft® Lync® integration Microsoft® Lync® can now be enabled on SAP Jam so that users can chat within Lync and check to see if other users are online. Table 7: SAP Jam-Microsoft Lync integration enhancements Enhancement Viewable Lync online sta tus
Description ●
When the company administrator has enabled the Lync integration, the user will be able to see the online status of a user when they place their cursor over the other user’s profile card in a feed item.
●
When the user clicks on the Lync status on the profile card, the Lync application opens.
●
A company administrator can now enable Lync for SAP Jam.
Figure 13: Profile card with Lync status
Enable Lync integration
Before you work with the Lync integration in SAP Jam, please note the following Lync version and browser compatibility matrix. "Yes" denotes that the combination is supported based on major functionality testing."*" denotes that it is supported with exceptions: 1. The status update is not reflected in SAP Jam. 2. The status update is not reflected when you place cursor over the profile card.
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
25
Table 8: Browser support for Lync and Office versions Lync and Of fice versions
Internet Ex Internet plorer 8 Explorer 9
Internet Ex Internet Ex plorer 10 plorer 11
Lync 2010 (32 bit) Office 2010 (32 bit)
Yes
Yes
Yes
Yes
Lync 2010 (in stalled 64 bit but run as 32 bit) Office 2010 (64 bit)
*
Yes
*
*
Lync 2013 (32 bit) Office 2013 (32 bit)
Yes
Yes
Yes
Yes
Lync 2013 (64 bit) Office 2013 (64 bit) Browsers (64 bit)
Yes
Yes
Yes
Yes
Lync 2013 (64 bit) Office 2013 (64 bit) Browsers (32 bit)
*
Yes
Yes
Yes
Mozilla Firefox 17 ESR
Mozilla Firefox 24
Yes
Yes
Mozilla Firefox (current)
Google Chrome
Yes (Chrome v.42 and later is not sup ported) Yes (Chrome v.42 and later is not sup ported) Yes
Yes (Chrome v.42 and later is not sup ported)
Note For Lync 2010, please note the following system and browser pre-requisites for enabling integration with SAP Jam: ● Microsoft Office 2010 must be installed. ● Lync 2010 must be installed (separately from Microsoft Office). ● For Internet Explorer: ○ Add SAP Jam to Trusted Sites list. ○ Enable "NameCtrlClass" under Manage Add-ons.
Note For Lync 2013, please note the following browser pre-requisites for enabling integration with SAP Jam:
26
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
Table 9: Browser prerequisites for Lync 2013 integration with SAP Jam Internet Explorer
Mozilla Firefox
Google Chrome
●
Microsoft Office 2013 with instal led SharePoint plugin
●
Microsoft Office 2013 with instal led SharePoint plugin
●
Microsoft Office 2013 with installed SharePoint plugin
●
Add SAP Jam to Trusted Sites list
●
Enable the plugin prompt
●
Enable plugins
●
Enable "NameCtrlClass" under Manage Add-ons
Note The SAP Jam— Lync integration does not currently support cross-company federation.
2.2
Customize your Homepage
TBD
2.3
Configure SAP Jam Branding and Support options
There are many options available for customizing the look and feel of SAP Jam to match your company's branding. 1. Access the Admin console [page 11] and select Branding and Support from the left navigation sidebar to configure the stylistic and support options for your SAP Jam service. The
Admin
Branding and Support
page is displayed.
2. In the top section of the Branding and Support page, you can set the following options:
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
27
Figure 14: Main Branding and Support options
○ Name: The name of your company as it was set in SuccessFactors Platform Provisioning.
Note This field is not editable. The string shown cannot be modified. The string does not appear anywhere in the SAP Jam user interface. ○ SuccessFactors Product name: [This feature is only available for companies that are integrated with SuccessFactors Foundation [page 7].] The name given to the SuccessFactors Foundation product in various places in the user interface. ○ Enable SuccessFactors Theming: [This feature is only available for companies that are integrated with SuccessFactors Foundation [page 7].] You must have the SuccessFactors Foundation user interface, version 12 or higher, installed for this option to appear and be selectable. Enables UI themes set in SuccessFactors Foundation to be applied to SAP Jam pages.
28
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
Note Enabling SuccessFactors theming disables the following features in the SAP Jam top bar: the facet dropdown for searches, the bell (notifications) icon, the Tasks icon, and the Messages icon. ○ Product Instance Name: The name of SAP Jam that users will see in various places in the SAP Jam user interface. ○ Color Theme: This form allows you to set the text and background colors for six common elements of the SAP Jam user interface. Colors must be set in hexidecimal values in the form "#nnnnnn" (without the quotation marks). For example, "#000066" would be navy blue. The color can be previewed in the small box to the right of the text box.
Note Care must be taken to ensure that elements remain visible within the SAP Jam user interface. Please check the UI after making changes. ○ Current Logo: The current logo is displayed. Click Browse to select a new logo from your local drive that you want to upload and use. This logo will appear in various places in the SAP Jam user interface.
Note The image will be resized to 180 x 50 pixels. 3. In the Custom Footer section of the Branding and Support page, you can set a Custom Footer that will appear on most pages of the SAP Jam user interface.
Figure 15: Custom Footer options
You can replace the footer displayed throughout SAP Jam 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 SAP Jam instance. 4. In the Email Settings section of the Branding and Support page, you can elect to: ○ Include the current company logo in the email header ○ Include the SAP Jam logo in the email footer These settings will affect the email notifications sent by SAP Jam.
Figure 16: Email Settings options
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
29
5. In the Help Settings section of the Branding and Support page, you can set the following options:
Figure 17: Help Settings 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 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. 6. In the Extranet Log-On Introductory Text section of the Branding and Support page, you can set the language(s) that the introductory message will be displayed in. When users are invited to External Groups, they receive a link to the Extranet landing page. Upon logging in to that page, external users are presented with an introductory message.
30
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
Figure 18: Extranet Log-On Introductory Text options
To set the language that the introductory message for external users will be displayed in: 1. Select Enable custom introductory text. The Select a Language for the Introductory Text dialog box is displayed. 2. Click the drop-down menu to select the language in which you want the introductory message for external users to be shown and click OK. The dialog box will close and the selected language will appear below the checkbox. 3. Click in the edit box to the right of the label for the language that you just selected and enter the message that you want to be presented to external users in their login page. 4. Optionally, click Add Another Language below the initially selected language to add an additional language in which the external user introductory message will be displayed and repeat steps 2 and 3 above. Also, the initial language selected will be the default. If you want to change which language is the default, click the cog icon beside the language that you want, and select Set as Default from the context menu. To remove a language option, click the cog icon beside the added language that you want to remove and select Remove from the context menu. 7. In the Extranet Log-On Background Image section of the Branding and Support page, you can set the following options:
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
31
Figure 19: Extranet Log-On Background Image options
○ Use custom background image: This option will enable the use of a custom background image for external users. ○ Background image should be tiled: This option will tile the selected background image, allowing you to use a small, low-bandwidth image for the background image for external users. ○ Browse (or Choose File): Click this button to find an image on your local drive and upload it to be used as the background image for SAP Jam pages for external users. ○ Enable a custom help page: If the Enable help links in user's drop-down menu and page footer option is enabled in the Help Settings section described above, then enabling this option allows you to set a different custom help page for external users. ○ Help Page URL: Enter the publicly accessible URL in this text box for the custom help page that you want external users to be able to access. 8. In the Support Contact section of the Branding and Support page, you can set the SAP Jam support contact email address by doing the following:
Figure 20: Support Contact option
9. When you have all of the Branding and Support settings as you want them, click on Save changes to apply your settings.
Note Also, different user interface labeling schemes are available for organizations that are not enterprise corporations (for example educational institutions and municipalities). To configure the UI with a different labeling scheme, contact your customer support representative. The labeling changes that are affected are: ○ Default, company scheme: Company/Employee/Manager ○ Alternate, organization scheme: Organization/Member/Supervisor ○ Alternate, institution scheme: Institution/Person/Supervisor
32
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
2.4
Configure Content Administration options
The Admin Auditing.
Content Administration
section allows you to manage Abuse Reporting, Purge Settings, and
Enable Content Administration Content Administration is disabled by default. To enable Content Administration, do the following:Usage Auditing 1. UsageAccess the Admin console [page 11] and select Content Administration from the left navigation sidebar. The
Admin
Content Administration
section is displayed.
Figure 21: Content Administration section
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.
Configure Abuse Reporting Abuse Reporting allows SAP Jam 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 Admin 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.
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
33
Figure 22: Abuse Reporting tab
The abuse reporting configuration options are displayed in the Abuse Reporting tab.
Figure 23: Abuse Reporting options
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 company administrator for review. You can set a number from 1 to 10.
34
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
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 company 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 is displayed 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 company administrator to review and decide how to handle, and notifications are sent to the company administrator to let them know there is inappropriate content requiring their review. To respond to an Abuse Report: 1. Open the Admin Content Administration section. The reported abuse(s) that users have submitted will appear in the Items Pending Review panel.
Figure 24: Review reported abuses
Each reported piece of content is displayed as it originally appeared in SAP Jam, 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
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
35
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. 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 SAP Jam.
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 Admin 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 Purge Settings tab. The Purge Settings options are displayed.
Figure 25: Purge Settings
2. Select Automatically purge items that have been in the Trash for (configurable) days. to turn trash purging on for all of your company's users. 3. Set the number of days to indicate how long items must be in your company's users' trash before they are automatically purged. 4. Click Submit. Your SAP Jam instance will perform a daily purge of all items that have been in your company's users' trash cans for longer than the set number of days.
36
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
Audit Usage The Audit Usage feature allows the company 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. 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 Admin 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.
Figure 26: Performing a usage audit
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.
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
37
5. Click Audit Usage. The audit is prepared and displayed in the panel below the Usage Auditing options.
Figure 27: Viewing a usage audit
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.
2.5
Configure Email Templates options
The Admin Email Templates page allows you to alter the style of email notifications sent from your SAP Jam instance to SAP Jam users. If it is preferred, you can set separate email templates for internal and external recipients. You can make and save email template changes without affecting the look of your current emails, allowing you to preview those changes, and publish them only when your email template changes are satisfactory.
To modify the email template 1. Access the Admin console [page 11] and select Email Templates from the left navigation sidebar. The
38
Admin
Email Templates
page is displayed.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
Figure 28: The Email Templates page (disabled)
2. Select the Enable custom email template checkbox to activate this feature and to enable you to make email template changes. A panel is displayed with a pair of tabs and a preview image of the email layout, with two edit boxes.
Figure 29: The Email Templates page (enabled)
The initial section presented to you to edit is the background and page. 3. If necessary, click (Edit) beside Background & Page in the preview image of the email, and make any changes that you want 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
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
39
Note If you set any CSS options in either of these edit boxes, the default email format will be set to HTML. If you want your SAP Jam emails to be sent in plain text format, you can only have content in the "plain text" edit boxes for the "Page Header", "Page Footer" and email "Footer". 4. Click (Edit) beside Page Header in the preview image of the email, and make any changes that you want in the Page Header HTML or the Page Header Plain Text edit boxes.
Note If you set any CSS or HTML options in any edit box, the default email format will be HTML. If you want your SAP Jam emails to be sent in plain text format, you can only have content in the "plain text" edit boxes for the "Page Header", "Page Footer" and email "Footer". 5. Similarly, click (Edit) beside any of the follow sections in the preview image: ○ Page Footer ○ Footer
Note Again, if you set any CSS or HTML options in any edit box, the default email format will be HTML. If you want your SAP Jam emails to be sent in plain text format, you can only have content in the "plain text" edit boxes for the "Page Header", "Page Footer" and email "Footer". 6. When you have the email template changes set as you want, click Update to save them. This will not change the look of your SAP Jam 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 is displayed. 3. Enter the email addresses of those who you want to preview the revised email template into the text box. 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.
40
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
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 will appear 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 will disappear in the tab, like those in the Internal tab.
Note You must click Publish to enable this change back to using the same template for emails from SAP Jam 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, deselect the Enable custom email template checkbox. The preview image of the email layout and the editable text boxes will disappear from the page.
Note You must click Publish to commit to this change back to not using customized email templates.
2.6
Configure the Getting Started Wizard
The Admin Getting Started Wizard page allows you to configure whether the getting started wizard will be used, and what screens are shown to new users.
Note The pages of the Getting Started Wizard that you can turn on or off, and the one page that you can modify, are all in the 2-4 user pages of the wizard. There are also ten additional pages that introduce administrators to
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
41
some of the key features of SAP Jam administration, but you will only see these pages if you are configured as an SAP Jam administrator when you first log on. It is therefore important to have new hires who will be working as administrators configured as administrators when they first log in. For those who have missed it, here is a list of the wizard's administrator pages. Table 10: The Getting Started Wizard's administrator pages are: ●
Take a quick tour (of the admin features)
● ●
Apply your company branding
●
Settings, alerts, help and more
●
Establish basic governance
●
Create groups
●
Set up a support email
Set up help and support links
●
Customize the Getting Started wiz ard
●
Generate company-wide reports
●
Get help from JAM's guides
Configure the getting started wizard To configure the getting started wizard, do the following: 1. Access the Admin console [page 11] and select Getting Started Wizard from the left navigation sidebar. The
Admin
Getting Started Wizard
page is displayed.
Figure 30: The Getting Started Wizard configuration page
2. Select Display Getting Started Wizard to enable its use. Note that: ○ The first two tabs of the Getting Started Wizard—Connect with People and Join Groups—are mandatory and cannot be modified. ○ The third tab—Go Mobile—is optional, but it cannot be modified. ○ The fourth tab is optional and it can be set to display any message that you want to compose. 3. Optionally, enable Tab 3 or Tab 4 by clicking the switch.
42
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
Figure 31: Enable the Getting Started Wizard's 3rd and 4th tabs
A disabled switch has an "x" and a gray background; an enabled switch has a check mark and a blue background. 4. If you enable Tab 4, click Edit to the right of the title text box for that tab. The title text box and the message text box become editable. 5. If you enable Tab 4, enter the title that you want for the fourth tab, and enter the content that you want displayed in the body of the fourth tab.
Figure 32: Message editor for tab 4
In addition to basic text formatting options, you can add hyperlinks, images, or videos to your message.
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
43
Note Your content must fit in the dimensions of the wizard, so a visual guide is included in the editor in the form a translucent overlay that will indicate if you have exceeded the allowed dimensions. 6. Optionally, click Preview to see the wizard in a pop-up dialog box. To close the dialog box, click on the "X" in its upper-right corner. 7. Once you are satisfied with your configuration of the tabs, click Save. The new or revised Getting Started Wizard is saved, and it will be displayed to new users when they first log on.
2.7
Configure a Custom Terms of Service
Note This feature is only available for companies that are integrated with SuccessFactors Foundation [page 7]. The Admin Custom Terms of Service page allows you to create a customized Terms of Service agreement for the users of your organization's SAP Jam service that they will be required to accept the next time that they log in before they can continue to use your organization's SAP Jam service.
Create a customized Terms of Service agreement To create a customized Terms of Service agreement, do the following: 1. Access the Admin console [page 11] and select Custom Terms of Service from the left navigation sidebar. The Admin Custom Terms of Service page is displayed. Either a message stating that "No custom Terms of Service has been defined for " or the current custom Terms of Service agreement is displayed.
Figure 33: Custom Terms of Service section
2. Click Edit Terms of Service. A simple HTML editor is displayed, which will either be blank or contain the text of the current custom Terms of Service agreement notification.
44
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
Figure 34: Custom Terms of Service editor
3. Enter the Custom Terms of Service agreement notification and format it as required. 4. When you are satisfied with the document, click Save. The new or revised Custom Terms of Service notification is saved, and users will be required to accept it the next time that they log in to your organization's SAP Jam service before they can continue using it.
2.8
Configure an Extranet Terms of Service
Note This feature is only available for companies that are integrated with SuccessFactors Foundation [page 7]. The Admin Extranet Terms of Service page allows you to create a customized Terms of Service agreement specifically for the external users of your organization's SAP Jam service. Once created, your external users will be required to accept it the next time that they log in before they can continue to use your organization's SAP Jam service.
To create an Extranet Terms of Service agreement To create an Extranet Terms of Service agreement, do the following: 1. Access the Admin console [page 11] and select Extranet Terms of Service from the left navigation sidebar. The Admin Extranet Terms of Service page is displayed. Either a message stating that "No extranet Terms of Service has been defined for " of the current Extranet Terms of Service agreement is displayed.
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
45
Figure 35: The Extranet Terms of Service section
2. Click Create Extranet Terms of Service. A simple HTML editor is displayed, which will either be blank or contain the text of the current Extranet Terms of Service agreement notification.
Figure 36: The Extranet Terms of Service editor
3. Enter the text for the Extranet Terms of Service agreement notification and format as desired. 4. When you are satisfied with the document, click Save. The new or revised Extranet Terms of Service notification is saved, and your organization's external users will be required to accept it the next time that they log in to your organization's SAP Jam service before they can continue using it.
2.9
Configure Kudos options
The Admin Kudos page provides a mechanism for publicly recognizing users for their accomplishments, and as such they are a mechanism for encouraging good working practices and positive personal traits, as well as helping to establish a positive interpersonal environment within the enterprise social networking provided by SAP Jam. There is a default set of eight types of kudos, and there is a mechanism for creating new custom kudos. Kudos can be disabled and enabled again as required. Also, custom kudos can be edited or deleted.
46
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
To manage your organization's use of kudos, do the following: 1. Access the Admin console [page 11] and select Kudos from the left navigation sidebar. The
Admin
Kudos
page is displayed.
Figure 37: Kudos catalog
2. To create a new custom kudos, click Add a new Custom Kudos. The Create Custom Kudos page is displayed.
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
47
Figure 38: Create Custom Kudos
1. In the Label field, enter the name or title that you want to give the new kudos. 2. Select the Admins only check box to restrict the awarding of kudos to SAP Jam support or company administrators only. Deselect the check box to permit all users to award kudos. 3. In the Description text box, provide a description of the purpose of or reason for awarding the kudo, such as describing the quality for which it is awarded, or the type of accomplishment that it signifies. 4. Click Browse to locate an icon for the kudos on your local drive. 5. Once you have the above three items set to your satisfaction, click Create to save the new custom kudo. You are returned to the Admin Kudos Custom Kudos section of the page.
page, where your new custom kudos will be listed in the
3. To manage kudos:
Figure 39: Manage Kudos
1. To disable an enabled kudos, click Disable on the row for the kudos that you want to disable. 2. To enable a disabled kudos, click Enable on the row for the kudos that you want to enable. 3. To edit a custom kudos, click More on the row for the kudos that you want to edit, and select Edit from the context menu. 4. To delete a custom kudos, click More on the row for the kudos that you want to delete, and select Delete from the context menu.
48
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
2.10 Configure Security options Set the SAP Jam security options in the
Admin
Security
page.
1. Access the Admin console [page 11] and select Security from the left navigation sidebar. The
Admin
Security
section is displayed.
2. In the top section of the Security page, you can set the following options:
Figure 40: General security settings
○ Select Enable RSS to control whether SAP Jam accepts requests to the RSS URLs. SAP Jam Rich Site Summary (RSS) URLs are secured through obfuscation, are private to each member, and should not be shared. When disabled, SAP Jam will return an HTTP 403 status message, but no content. ○ Select Require email authentication for new browsers to decrease the possibility of someone gaining access to a user's SAP Jam 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 SAP Jam sessions log a user out. For companies signing on through SuccessFactors Foundation, this setting must be equal to or greater than the SuccessFactors Foundation timeout setting; otherwise, users will be re-signed in automatically with a new session, thus effectively turning off automatic log offs. ○ Select Enable SuccessFactors shared session service to ensure that the if the SuccessFactors setting for maximum session length is used, even if it is shorter than the maximum session length set in SAP Jam. The converse however is not true. If the SAP Jam timeout is shorter than the SuccessFactors one, and this setting is enabled, the SAP Jam setting will be enforced for users while in SAP Jam, but if they are still within the session boundaries set in SuccessFactors, the user would still be able to reach the SuccessFactors site, and from there they could be automatically logged back into SAP Jam via Single Sign-On (SSO). 3. In the Password Strength section, you can set the following options:
Figure 41: Password Strength settings
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
49
Note The Password Strength section is only available for companies that are not integrated with SuccessFactors Foundation [page 7]. 4. In the E-Mail Settings options section, you can set the following options:
Figure 42: E-Mail Settings options
○ Allow members to create content via e-mail—Allows users to create and respond to SAP Jam activities such as new comments to items they previously posted in SAP Jam. ○ Allow SAP Jam to send members content via e-mail—Enables automated email notifications. 5. In the Domains section, you can manage domains by using the controls in this section. The domains section allows you to control the domains and sub-domains owned by your company that can access SAP Jam. If your company's SAP Jam instance was created on the primary domain, any sub-domains will automatically be included in the domain's list. If your company's SAP Jam instance was created in a subdomain, you can choose which other sub-domains can access SAP Jam. Also, if your company has additional domains, you can add them to your SAP Jam instance to allow users from those domains to join.
Note Your changes are not immediately implemented because the SAP Jam Customer Support team performs a domain check to verify your ownership of the domain before the domain is activated.
Figure 43: Trusted Domains settings
To add a new trusted domain to SAP Jam perform the following steps: 1. Click Add a New Domain; a new row is added to the list of domains. 2. Type in the new domain name. 3. Press Enter to save the new domain name. To remove a domain, click Remove on that domain's row. 6. 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
50
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
○ Only these IP addresses, then users can log in from only the IP addresses within your organization's network.
Figure 44: IP Restrictions settings (Any IP address)
Note Limiting 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 is displayed beneath the option in which you can do the following: ○ Enter an out-going IP address (IPv4) or IP address range (CIDR) for your organization 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.
Figure 45: IP Restrictions settings (Only these IP addresses)
7. When you have set these options to your satisfaction, click Save changes.
2.11
Configure Compliance monitoring
The Admin Compliance page allows you to configure a pair of "dictionaries" (lists of words) for Compliance and Profanity against which users' posts and private messages can be scanned for matches with the words in the dictionaries. The intent is that you will add lists of rude, offensive terms (Profanity) and terms that might indicate an inappropriate communication (data loss) of sensitive company information (Compliance) in the Dictionary
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
51
page. The matching instances are shown in the Pending Flagged Items page, where you can choose to Ignore or send an Alert email to specified recipients. There is a History page where you can view past matches. The Add Compliance Email option allows you to set an email address, or email addresses, for the people that are to be notified when a term in the Compliance and Profanity dictionaries are matched. Also, there is a link to the Reports page, where you can Download a Compliance Report.
Note The 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. Access the Admin console [page 11] and select Compliance from the left navigation sidebar. The
Admin
Compliance
page is displayed.
2. Click on the Dictionary tab. The
Admin
Compliance
Dictionary
tab is displayed.
Figure 46: Compliance: Dictionary
3. In the Dictionary page, you can do the following: ○ Browse through the terms used: 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 Noting 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. ○ Add one or more terms: Click Add Term at the top of the Dictionary tab. The add terms form is displayed.
52
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
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.
Figure 47: Compliance: Dictionary, Add Term
Note The 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 an email address, or email addresses, that will receive a copy of each feed event or private message sent to anyone in your company.
Note Since 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. Access the Admin console [page 11] and select Compliance from the left navigation sidebar. The
Admin
Compliance
page is displayed.
2. Click Add Compliance Email. The Compliance Email form is displayed.
Figure 48: The compliance email addresses form
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
53
3. Type in 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 company. 4. Click Save to save the email address or list of addresses, or click Cancel to return to the Compliance page.
Note To 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 or sent in private messages 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 the user and group admin for group content. ● Alert the user and their manager for profile content. ● Ignore the 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. Access the Admin console [page 11] and select Compliance from the left navigation sidebar. The
Admin
Compliance
page is displayed.
Figure 49: Compliance: Pending Flagged Items
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.
54
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
○ For more information on the user, click the hyper-linked term in the Term column. A Flagged Item Details dialog box is displayed.
Figure 50: The Flagged Item Details dialog box
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, select the check box on the row for that item and click Alert. An alert message is sent, and the item is removed from the Pending Flagged Items table.
View History 1. Access the Admin console [page 11] and select Compliance from the left navigation sidebar. The
Admin
Compliance
page is displayed.
2. Click the History tab. A table, much like the Pending Flagged Items table, is displayed; 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 1. Access the Admin console [page 11] and select Compliance from the left navigation sidebar. The
Admin
Compliance
page is displayed.
2. Click Download Compliance Report. The Reports page is displayed, with the report request form set to produce a Compliance Report. 3. Click Request report. The Compliance Report is scheduled. 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.
SAP Jam Administrator Guide Configuration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
55
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).
56
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Configuration
3
Administration
3.1
Send Invites Note
This feature is only available for companies that are not integrated with SuccessFactors Foundation [page 7]. The Admin instance.
Invites
page provides a mechanism to invite all of your users an invitation to join your SAP Jam
Figure 51: Invite all employees
● To send all of your users invites to join SAP Jam, click Invite everyone. Emails will be sent to each of your users with the URL to access your organization's instance of SAP Jam. ● If you add new users, return to the page and click Invite new users. Emails will be sent to each of your users with the URL to access your organization's instance of SAP Jam. ● If all of your users have received invitations, the employees have already been invited."
Admin
Invites
page will display the message "All your
Figure 52: All of your employees have already been invited
3.2
Users administration
Note Adding users is either done through the SuccessFactors Platform or with the assistance of SAP Jam professional services. Contact your SAP Jam representative if you require assistance to add or update the list of your users or the information about them.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
57
The content in this section of the documentation includes: ● About SAP Jam user types permissions [page 58]: This section describes the privileges of the various SAP Jam user types. ● User privileges administration [page 62]: This section describes how to grant SAP Jam users administrator status or how to disable user access. ● Create and manage member lists [page 64]: This section describes how to create and manage "member lists", which are used to define the membership of auto groups, or to define a list of users who will be invited to use the SAP Jam Mobile app. ● About email notifications [page 67]: This section describes how SAP Jam email notifications work, it describes the locations where email notifications can be configured, and it lists the email notifications that SAP Jam can send.
3.2.1 About SAP Jam user types permissions This section describes the privileges of the various SAP Jam user types. SAP Jam provides six levels of user privileges: 1. External users, also known as "guest" users, are the most restricted. They are guests of your organization, given access to only the specific private external groups to which they have been invited, their Home page, and their User Profile. They are allowed only limited information on, or interactions with, other users. They can only access the content within the groups to which they have been invited. Also, they require a different, lower-cost license type than internal users. They are only available on SAP Jam enterprise editions. 2. Restricted access users, are partially restricted users. They have feature and security permissions that limit their access to only the SAP Jam groups to which they have been invited, and to the content and people that are in those groups. This is a special case user configuration that is only enabled by making a special request to your support representative. On request, this user type is provisioned by SAP Jam Support. These users are managed in the SuccessFactors platform, and they are identified to SAP Jam by having one of the SuccessFactors platform custom profile fields of user information flagged.
Note When the SuccessFactors Platform custom field that indicates a "restricted access user" is set, SAP Jam will recognize and treat the user as such. However, this setting has no effect on the behavior of other SuccessFactors applications or services, so your organization's administrators must configure equivalent restrictions in SuccessFactors Platform to restrict the access of your "restricted access users". 3. Full access users typically include all of the employees in your company. They typically have access to all enabled features except those that are limited to the members of a specific group or that require external accounts to view, as is the case with integrated business records from external applications. 4. Group administrators are regular users that have created a group or who have been invited to be a group administrator. Group administrators have special privileges required to perform their function, but "group administrator" is not a specific user type, so their access is not shown in the following table. The capabilities of group administrators are fully documented in the SAP Jam Group Administration Guide. 5. Support administrators have access to a sub-set of the functionality available to a Company Administrator. The role was established to provide Company Administrators with relief of their workload by giving Support Administrators access to many of the day-to-day duties of SAP Jam administration. This also protects the stability of the SAP Jam service by limiting access to features that can have great impact on the functionality
58
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
of the SAP Jam service to a smaller group of Company Administrators whose main duties are the configuration and maintenance of SAP Jam. 6. Company Administrators have access to the full range of capabilities within the Admin console. This gives them the greatest power to change the look, feel, and functions of the SAP Jam service, but it also requires greater knowledge of the SAP Jam service, a greater responsibility, and therefore typically a greater focus of their job duties on configuring and maintaining the SAP Jam service in a manner that suits the needs of your organization.
SAP Jam User Types and Features Matrix
Table 11: User type access to company features Company features
External users
Restricted Full ac Support access cess users admins users
Company admins
Company tab and all of its options
No
No
Yes
Yes
Yes
Customizable company homepage
No
No
Yes
Yes
Yes
Able to edit the company wiki
No
No
No
Yes
Yes
Redirect user to the company wiki after login
No
No
No
No
Yes
Groups and subgroups features
External users
Restricted Full ac Support access cess users admins users
Company admins
Left-nav tab, "My Groups", and "Recent Group Activity"
Yes
Yes
Yes
Yes
Yes
Recommendation tiles, post to group wall
Yes
Yes
Yes
Yes
Yes
Group content moderation
Yes
Yes
Yes
Yes
Yes
Group administrator
No
Yes
Yes
Yes
Yes
SuccessFactors homepage tiles
No
Yes
Yes
Yes
Yes
Invite to a group
No
Only if a group ad min
Yes
Yes
Yes
Overview page designer
No
If group admins
Yes
If group admins
If group admins
Can create groups, can search for groups
No
No
Yes
Yes
Yes
Automatically follow business records when you create a group or feature a business record
No
No
Yes
Yes
Yes
Use custom group templates to create groups
No
No
Yes
Yes
Yes
Create custom group templates
No
No
No
Yes
Yes
Table 12: User type access to groups and subgroups features
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
59
Table 13: User type access to content and forums features Content and forums features
External users
Restricted Full ac Support access cess users admins users
Company admins
Can create folders
Yes
Yes
Yes
Yes
Yes
Use hashtags in content commenting, including photos or videos
Yes
Yes
Yes
Yes
Yes
Forums: ideas, questions and answers
Yes
Yes
Yes
Yes
Yes
Forums: discussions
Yes, in Yes, in Yes group con group con text text
Yes
Yes
Wikis, blogs, blog @mentions, documents, photos, videos, polls, and links
Yes, in Yes, in Yes group con group con text text
Yes
Yes
Tagging people in photos
No
No
Yes
Yes
Users features
External users
Restricted Full ac Support access cess users admins users
Company admins
Bookmarks, content history, user API access
Yes
Yes
Yes
Yes
Yes
Upload profile photo, edit profile (basic & contact), status post editing
Yes
Yes
Yes
Yes
Yes
Post group status via email
Yes
Yes
Yes
Yes
Yes
Ability to add expertise tags
No
Yes
Yes
Yes
Yes
Ability to show/hide expertise tags recommended by SAP Jam and other users, or tags you yourself have added to your profile
No
Yes
Yes
Yes
Yes
Ability to view others' expertise tags
No
Limited 1
Yes
Yes
Yes
Ability to see and endorse other users' expertise tags
No
Yes, in Yes group con text
Yes
Yes
See who endorsed you in notifications
No
Yes 2
Yes
Yes
Yes
See who endorsed others on their profiles
No
Yes
2
Yes
Yes
Yes
First-time login wizard
No
No
Yes
Table 14: User type access to users features
Note: API access can be limited by other factors.
Yes
Yes
Yes
3
Yes
Yes
Yes
View other users' profiles
Yes
Limited
Edit profile (office), post status, team usage, member inte grations
Limited 4
Limited 4
Yes
Yes
Yes
Modify profile sections
No
No
No
Yes
Yes
60
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
1. Limited to view the expertise of other members of a group or groups that the limited access user is a member of. 2. If a full access user endorses a "restricted access user", but doesn't share a group with that user, their endorsement will appear anonymous to the "restricted access user". The "restricted access user's" notification will indicate that they received an endorsement on an expertise tag, but it won't indicate who gave the endorsement. 3. Restricted access users can only see the profiles of other users who are members of the groups that they are also members of. 4. "Yes" for the title, "No" for the first name and last name of external users managed by the SAP ID service.
Table 15: User type access to emails, feeds, and notifications features Emails, feeds, and notifications features
External users
Restricted Full ac Support access cess users admins users
Company admins
Email notification subscriptions
Yes
Yes
Yes
Yes
Yes
Email to update
Yes
Yes
Yes
Yes
Yes
Mark as abuse/spam
Yes
Yes
Yes
Yes
Yes
RSS
Yes
Yes
Yes
Yes
Yes
Feed and feed filters
Yes *
Yes *
Yes *
Yes *
Yes *
New notifications alerts
Yes
Yes
Yes
Yes
Yes
Share feed item
Yes, in Yes, in Yes group con group con text text
Yes
Yes
Private messages
No
No
Yes
Yes
Yes
Chat
No
No
Yes
Yes
Yes
* Users can generally "like" any visible feed entry, except for those users that do not belong to group that the feed entry originates from, or for users who are from a different company.
Table 16: User type access to tools and utilities features Tools and utilities features
External users
Restricted Full ac Support access cess users admins users
Company admins
Agenda, timeline, pro/con, ranking, decisions, mentoring
Yes
Yes
Yes
Yes
Yes
Calendar events, tasks
Yes, in Yes, in Yes group con group con text text
Yes
Yes
Search
Yes, in Yes, in Yes group con group con text text
Yes
Yes
Kudos
No
Yes
Yes
SAP Jam Administrator Guide Administration
Yes
Yes
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
61
Tools and utilities features
External users
Restricted Full ac Support access cess users admins users
Company admins
Admin menus: Content Administration, Users, SAP Jam mobile app, Custom Profile, Group Templates, Auto Groups, and Extranet Management
No
No
No
Yes
Yes
No Admin menus: General, Features, Home page customiza tion, Branding and Support, Email Templates, Custom Terms of Service, Extranet Terms of Service, Kudos, Secur ity, Compliance, Hashtags, Reports, External Applications, Widget Builders, OpenSearch Clients, OpenSocial Gadgets, OAuth Clients, SAML Trusted IDPs, SAML Local Identity Providers, and Gamification
No
No
No
Yes
Hash tag import
No
No
No
No
Yes
Admin console access
No
No
No
No
Yes
Can run company-wide detail reports
No
No
No
No
Yes
Integration features
External users
Restricted Full ac Support access cess users admins users
Company admins
View integrated business records from external systems
No
Limited 1
Based on external account
Based on external account
Based on external account
View integrated CMIS document repository, Business Re cords
No
No
Yes
Yes
Yes
Gamification
No
No
Yes
Yes
Yes
Table 17: User type access to integration features
1. Restricted access users can see data from external applications for which they have valid accounts for which they have been assigned view permissions.
3.2.2 User privileges administration This section describes how to grant SAP Jam users administrator status or how to disable user access. The Users tab in the
Admin
Users
page provides allows you:
● To grant administrator privileges to SAP Jam users ● To disable a user account
62
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
To grant administrator privileges to SAP Jam users
Note This feature is only available for companies that are not integrated with SuccessFactors Foundation [page 7]. 1. Access the Admin console [page 11] and select Users from the left navigation sidebar. The
Admin
Users
page is displayed.
2. In the Users tab, in the row for the user that you want to give administrator status to, click edit. The user's profile page appears.
Figure 53: Edit Profile: set Administrator Type
3. Click on the Administrator Type drop-down menu, select either the Company Administrator or Support Administrator option, and click Save changes. The user is given the privileges that you indicated, although this may take a little time to propagate throughout SAP Jam.
To disable a user account
Note This feature is only available for companies that are not integrated with SuccessFactors Foundation [page 7]. If your instance of SAP Jam is integrated, you must perform this task in SuccessFactors Foundation. If your SAP Jam service is integrated with SuccessFactors Foundation, then you must disable a user's account in SuccessFactors Foundation, which will automatically disable that user's access to SAP Jam. 1. Access the Admin console [page 11] and select Users from the left navigation sidebar. The
Admin
Users
page is displayed.
2. In the Users tab, in the row for the user that you want to give administrator status to, click edit. The user's profile page appears.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
63
Figure 54: Edit Profile: set Member Status
3. Change the user's Member Status from Active to Alumni and click Save changes. The selected user's profile is moved into the company's Alumni directory and the user account is deactivated. Contributions from the user are not removed from SAP Jam when their user account is deactivated.
3.2.3 Create and manage member lists This section describes how to create and manage "member lists", which are used to define the membership of auto groups or to define a list of users who will be invited to use the SAP Jam Mobile app, for example. Member Lists are lists of users that can be used to invite a large number of people to a group, or to manage the membership of an auto group. The Admin Users page provides the ability to create, edit, publish, or delete member lists, as is described in the following procedures below.
To create a member list 1. Go to the SAP Jam Admin console and select Users from the left navigation sidebar. The
Admin
Users
page displays.
2. Select the Member Lists tab and click Create New Member List. The Edit Member List page displays.
64
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
Figure 55: Create a new Member List
3. Click the auto-generated title (Untitled Member List) and enter a meaningful name for the member list. 4. In the Add People to the Member List text box, build your member list by using one of the following methods: ○ Type a user's name into the Add People to the Member List text box, and—when the person you are looking for appears in the drop-down auto-completion list—click on their information to add them to the Pending Members table. ○ Paste in a comma-separated list of email addresses into the Add People to the Member List text box, and press Enter to add all of the listed users to the Pending Members table. ○ Type the name of another member list into the Add People to the Member List text box, and press Enter, and press Enter to add all of the listed users to the Pending Members table. ○ Click Import CSV to import a comma-separated list of email addresses for members, and use your browser's upload feature to find and select the file on your hard drive. When the file is uploaded and processed, the listed users will be added to the Pending Members table. If you add an unknown email address, it will be placed in the Errors tab. You can save a Member List that has errors, but you cannot publish it until you have edited and corrected the unrecognized email addresses. 5. To edit or remove users from your Member List, hover over a row of member information in any of the three listed members tabs (Pending Members, Published Members, or Errors) and/or click the Actions button to see the actions available for that member. The actions are either Remove (available in all three tabs) or Edit (only available in the Errors tab. 6. Optionally, click Publish if you are satisfied with the list of members in the list, there are no errors, and you want to make the member list available for use. All users are moved into the Published Members tab. 7. Optionally, click Save to retain a list that you are not ready to make available for use. You are returned to the Member List tab of the
SAP Jam Administrator Guide Administration
Admin
Users
page.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
65
Figure 56: Member Lists catalog
The Member Lists shown in the catalog will be shown as being in one of the following Status and Availability combinations, which will allow you to take the actions listed in the indicated options of the Actions drop-down menu: ○ Complete and Published: You can Edit or Delete the list. ○ Complete and Unpublished: You can Edit, Publish Changes, Discard Changes, or Delete the list. ○ Error and either Published or Unpublished: You can Edit, Discard Changes, or Delete the list. 8. In the Edit Member List page you can do the following: ○ To edit a member list ○ To publish a member list ○ To delete a member list ○ To discard an unsaved list, click Discard Changes.
Invite users to a group via a member list Once Member Lists have been published they are available to be used to invite large numbers of users to a group all at one time. Simply type the name of the Member List into the "Add People…" text box on the group invite page.
Figure 57: Using Member Lists in invitations
Note Under the members list for a group, group administrators can filter by alumni users only, click Select All to select multiple alumni users and then click Remove Alumni to bulk remove those users from the member list.
66
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
To use Member Lists in Auto Groups Auto Groups are groups whose membership is automatically managed based on criteria that are based on user profile fields. As changes to the user profiles occur, (e.g., a user moves to a different role in another division of the company), their membership to an Auto Group may be automatically created or revoked, depending on the criteria set up for that Auto Group's membership. As the list of people in the Member List changes, so will the membership of all the Auto Groups that use that Member List as a criterion for membership. This allows multiple Auto Groups to be synchronized with one or more Member Lists.
3.2.4 About notification emails The SAP Jam notification emails that a user receives are determined by the settings in four configuration pages: three that are available to company administrators, and one that is available to users.
[For administrators] To set whether email notifications are used in your company 1. Access the Admin console [page 11] and select Security from the left navigation sidebar. The
Admin
Security
page is displayed.
Figure 58: Security E-Mail Settings options
2. In the E-Mail Settings section, select the Allow Jam to send members content via e-mail to enable email notifications; deselect this option to disable email notifications.
[For administrators] To set whether your company's users can receive daily email alerts and active task reminders 1. Access the Admin console [page 11] and select Features from the left navigation sidebar. The
Admin
Features
page is displayed.
Figure 59: Enable daily alert emails and active task reminders in SAP Jam
2. In the Feature Management section, select the Send daily alert emails to all members option to allow users to receive the notification emails listed in the Daily Emails section of their page.
SAP Jam Administrator Guide Administration
Account Settings
Email Settings
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
67
Disabling this option will prevent users from receiving daily alert emails regardless of any options that they may have checked in the Daily Emails section of their
Account Settings
Email Settings
page.
3. In the Feature Management section, select the Send active task reminder to all members option to allow users to receive email reminders of their uncompleted tasks. Disabling this option will prevent users from receiving active task reminders regardless of whether they have checked the Active Tasks Reminder option in the Daily Emails section of their Settings
Account Settings
Email
page.
4. Click Save changes at the bottom of the page. Your checked selections will be enabled; unchecked options will be disabled.
[For administrators] To prevent a particular user from receiving email notifications 1. Access the Admin console [page 11] and select Users from the left navigation sidebar. The
Admin
Users
page is displayed.
2. In the table of users, in the row for the user that you want to give administrator status to, click edit. The user's profile page appears. 3. In the Email Settings section, select the Stop all emails option for All and click Save changes.
Figure 60: Disable a specific user's email notifications in SAP Jam
The default for this option is Enable Emails. Setting the All option to stop all notification emails for the selected user.
68
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
[For users] To select which notification emails they receive Table 18: User email settings 1.
As an SAP Jam user, from the top of any non-Admin con sole page, click on your name and select Jam Account Settings, or click on the cog icon and select Account Settings. Your Account Settings page is displayed.
2. Click Email. The Email Settings page is displayed. 3. In the Notifications tab, select or deselect the notification options that you want enabled or disabled. To do this, you can: ○
Select or deselect the check box beside each option
○
Select or deselect the check box in each section title, which will enable or disable all options in that section
4. Once you have selected the notifications that you want to receive, click Save changes.
Note Users will receive Daily Email notifications only if the follow ing five conditions are true: 1.
The Allow Jam to send members content via e-mail option is selected in the E-Mail Settings section of the
Admin
Security
page.
2. The Send daily alert emails to all members option in the
Admin
Features
page is selected.
3. The All option in the user's Email Settings section, ac cessed from the Admin Users page by clicking edit in the row for their account, is set to the default value of Enable Emails. 4. At least one of the Daily Emails options in the user's Email Settings page is selected.
Figure 61: User email settings
5. There is content in the category of the daily summary option(s) that is (are) enabled. If there is no content, no daily summary is sent.
Note If a user has never saved changes in the Email Settings page, then the settings displayed might not accurately reflect the options in use.
User notification emails The following table lists the notification emails that can be sent to SAP Jam members. Note that this information is drawn from the SAP Jam User Guide; it is reproduced here to present a more complete description of SAP Jam notification emails.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
69
Table 19: User notification emails Title
Description
High Priority Emails Direct Messages
Sent when a group member enters an @mention ("@User Name") specifically to you.
Direct Messages to All Followers
Sent when a group member enters an @@notify to all members of a group of which you are a member.
Private messages
Sent when an SAP Jam user sends you a private message by clicking on the envelope icon in the top menu bar of any SAP Jam page and clicking New Message.
Notifications
New Notifications for you or involving you. This setting controls approximately a dozen different notification emails. Examples are you have a new follower, and you’ve been @mentioned from a content item.
Note Administrators should select this option. They will have some additional notification emails sent to them if this option is selected: see the next section, Administrator notification emails for details. Photo tagging
Sent when another user has tagged you in a video posted in an SAP Jam group of which you are a member.
Video tagging
Sent when another user has tagged you in a video posted in an SAP Jam group of which you are a member.
Error Emails on 3rd party integra tions
When integrations you’ve set up (for example, with Google Docs or Twitter) are no longer working correctly.
External Applications
When a group you’re in that is integrated with an external system generates a notification email that the records in that external system have been created, modified, or deleted.
Tasks
When a task has been assigned to you, or a task already assigned to you has been up dated.
Wall posts
When someone has posted something on your wall.
Medium Priority Emails Feed Comments and Likes
A colleague has commented on or liked a feed post you’ve made.
First click on my Wikis, Links, or Documents
A colleague has clicked through for the first time on a wiki, link or document you’ve posted.
Wiki edit to a page you created
A colleague has edited a wiki you created.
Wiki edit only when you were the last editor
A colleague has edited a wiki for which you were the previous editor.
Daily Emails Clicks on my content
Links that I've posted that other's have clicked.
Reminder for old notifications
Inbox notifications older than one day.
Results for tracked items
Any new results for saved search terms.
Yesterday's headlines
Up to 20 feed events from my follows feed, created by other users, yesterday.
Yesterday's top 5 links
Up to 5 most popular links people clicked on yesterday.
Active Tasks Reminder
Reminder of uncompleted Tasks that are assigned to you.
70
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
Administrator notification emails The following table lists the notification emails that can be sent to SAP Jam administrators. Table 20: Administrator notification emails Title
Description
Admin Browser Authentication Re If the Require email authentication for new browsers option has been selected in the quest Admin Security page, this notification email is sent on the detection of a browser being used to access SAP Jam for the first time. Content pending approval
If Content Administration is enabled and a user submits content, this notification requests that the administrator approve the content. For an administrator to receive this notifica tion email, he or she must have checked Notifications in their Settings
Content inappropriate
Account Settings
Email
page.
Notifies company administrators that an SAP Jam user has marked some content as be ing inappropriate. If this occurs, the content is removed, a message that it has been marked as inappropriate is displayed, and the content is listed in the
Admin
Content
Administration section's Items Pending Review panel. This will only occur if you have enabled content administration and the number of reports that the content is inappropri ate have exceeded the configured threshold. An administrator must review the content, and either click Delete if you agree that it is inappropriate, or click Restore if you find the content to be acceptable. Content inappropriate rejection
Notifies the users who reported content as being inappropriate if that content is deemed to be acceptable and is restored by a company administrator. This notification email is not received by administrators, but it does report on an administrator action.
Compliance item flagged
Notifies company administrators that a comment or private message contains words that are listed in the profanity or compliance dictionaries as configured in the Compliance
Admin
section.
Company Storage Space is almost Notifies company administrators when storage used hits 80% of their allocation. If you full receive an "80% usage" notification, you should either free up storage by deleting old content or contact your SAP Jam Support representative to purchase more storage space. These notifications will occur daily, are not configurable, and cannot be turned off except by taking action to resolve the situation. Company Storage Space IS full
Notifies company administrators when storage used hits 100% of their allocation. 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 will occur daily, are not configurable, and cannot be turned off except by taking action to resolve the situation.
Admin Report succeeded
Notifies the administrator who requested a report that the report generation has com pleted successfully.
Admin Report ready for download
Notifies the administrator who requested a report that the report is ready to be down loaded.
Admin Report failed
Notifies the administrator who requested a report that the report generation failed.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
71
3.3
Configure the SAP Jam Mobile app
The SAP Jam Mobile app section of the Admin console allows administrators to configure SAP Jam Mobile app activation and to send invitations to your company's users to use the mobile app.
To configure SAP Jam Mobile app activation: 1. Access the Admin console [page 11] and select SAP Jam Mobile app from the left navigation sidebar. The
72
Admin
SAP Jam Mobile app
page is displayed.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
Figure 62: SAP Jam mobile app page
2. In the Settings section, select which of the following options you want enabled:
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
73
Figure 63: Mobile app activation settings
○ Enable mobile app (enabled by default) If selected, the SAP Jam mobile app is enabled for your company. ○ Enforce app passcode (disabled by default) Select this option to require all mobile users to enter a Personal Identification Number (PIN) to open their SAP Jam app on their mobile device. Optionally, you can also select which app passcode PIN security options you want to require: ○ Disable three or more consecutive numbers Allows a maximum of two ascending or descending digits (for example, 129076 is acceptable, 123654 is not). ○ Disable three or more repeating numbers Allows a maximum of two repeating digits (for example, 114595 is acceptable, 111459 is not). ○ Allow activation via mobile camera (enabled by default) If selected, users will be able to leverage the new one-time-use, QR code-based mobile app activation. If not selected, the web page for QR code-based activation will be disabled and a message informing the user that this feature has been disabled by the SAP Jam administrator will be displayed. ○ Restrict Activations to Managed Devices Sets a token string that is pushed to the mobile device via MDM and which is checked upon sign-up and occasionally during use to ensure that your users' devices are managed by your organization. Note that the token string can be generated, updated, and deleted by clicking Manage Token, which opens the Restrict Activations to Managed Devices dialog box.
74
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
Figure 64: Restrict Activations to Managed Devices dialog box
3. Click Save changes to implement your selections.
Note The above changes can take up to three hours to propagate to your users mobile apps.
To invite users in your company to use the SAP Jam Mobile app, do the following: 1. In the Add People To The Member List text box, begin typing a user's name, their email address, or the name of a member list, and when the person or members list that you are looking for appears in the drop-down auto-completion options list, click on the name of that person or member list. The user or member list that you clicked on will appear in the Invitation List table.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
75
Figure 65: SAP Jam mobile app invitations
2. Alternatively, import a list of members in the form of a comma-separated list of email addresses by clicking Import CSV and using your browser's upload feature to find and select the file on your hard drive. 3. Once you have the list of users that you want to invite to use the SAP Jam Mobile app showing in the Invitation List, click Send. The users shown in the Invitation List will be sent an email invitation to use the SAP Jam Mobile app, with instructions on how to set it up for use on their mobile devices.
3.4
Custom Profile administration
The Admin Custom Profile page allows you to configure the profile page for all SAP Jam users in your company. As a company administrator, you can remove and re-order the profile sections by dragging and dropping them. 1. Access the Admin console [page 11] and select Custom Profile from the left navigation sidebar. The
76
Admin
Custom Profile
page is displayed.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
Figure 66: Customizing Profile pages
2. Select the checkbox beside the profile widgets that you want to have available in your users' profile pages; deselect them to remove them. 3. Drag any widget box to place it in either section of the widgets (Basic Profile Information or Show Additional Information) or to set the order in which they appear. 4. Click Edit in the widget box for any of the following widgets to make modifications to that widget type: 1. Click Edit in the Contact Information widget box to select which particular fields—user's phone numbers, IM addresses, and other options—will be available.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
77
Figure 67: Customizing Profile pages: the 'Contact Information' Edit Selection dialog box
○ Select fields to have them available; deselect them to remove them. ○ To add a new field, type the title in the "Add a New Field" text box.
Note The data for any field that you set must be available, and the name of that field must correspond to data that is present in the user's information. See the Automatic user provisioning table in the SAP Jam integrated with SuccessFactors Foundation [page 7] section. ○ To remove an added custom field, click the "X" to the right of that field's information. When you have made the changes that you want in the Edit Section dialog box, click Save to return to the Custom Profile page. 2. Click Edit in the Job Information widget box to select which particular fields—such as the users' job title, start date, and other options—will be available.
78
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
Figure 68: Customizing Profile pages: 'Job Information' Edit Selection dialog box
○ Select fields to have them available; deselect them to remove them. ○ To add a new field, type the title in the "Add a New Field" text box.
Note The data for any field that you set must be available, and the name of that field must correspond to data that is present in the user's information. See the Automatic user provisioning table in the SAP Jam integrated with SuccessFactors Foundation [page 7] section. ○ To remove an added custom field, click the "X" to the right of that field's information. When you have made the changes that you want in the Edit Section dialog box, click Save to return to the Custom Profile page. 3. OpenSocial Gadgets: Enable this option to show a configured OpenSocial Gadget in users' profiles.
Figure 69: Customizing Profile pages: custom profile Edit Selection dialog box
Note that OpenSocial Gadgets must have been previously configured, as described in the OpenSocial Gadgets section of the SAP Jam Developer Guide. When you have made the changes that you want in the Edit Section dialog box, click Save to return to the Custom Profile page. 5. When you are satisfied with your arrangement of the content to be shown in your organization's users profiles, click Save changes.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
79
3.5
Group templates administration
SAP Jam group templates are a mechanism for replicating group content quickly and consistently. In addition to the set of pre-built templates that are available as a default set of "system group templates", SAP Jam supports the creation of "custom group templates" that can be optimized to meet your organization's business needs and requirements. Both system group templates and custom group templates can be made visible to, or hidden from, your users. Your organization's users can create new groups based on any visible templates, whether they are system or custom templates.
Manage group templates 1. Go to the SAP Jam Admin console and select Group Templates from the left side navigation. The
Admin
Group Templates
page displays, showing a catalog of group templates.
Figure 70: Creating a group: template selection
The catalog lists all group templates available to your organization. They are displayed alphabetically in two groupings. The first grouping lists system templates, which are indicated with the label Pre-built Template underneath the templates name. The second groups lists any custom templates that have been created for
80
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
your organization, which are indicated by the company or support administrator's name that created them underneath the template name. Every template has a visibility toggle in the first column and an Actions button in the last column. A custom template also displays the date and the administrator by whom it was last modified. The list is searchable using the search box on the top right. 2. To create a custom group template, do the following: 1. Click Create a template near the top left of the page. The Create Template dialog box is displayed.
Figure 71: Create Template dialog box
2. Set in the following options: ○ Name: [Required] The template name does not need to be unique 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. ○ Business Records: [Optional] By specifying a business object type, it means the template is purposebuilt for that type. The template is available to an end user only when they create a group based on a business object instance of that type. As an example, you can select a custom "ACE Sales opportunity methodology" template only when you create a new group based on an opportunity business object type from SAP CRM. 3. Click Create.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
81
The (Group Template) page is displayed, from which you can do the following:
Figure 72: (Group Template) page
○ Click Group Admin settings to edit the group options. ○ Click Create An Overview Page to use the page designer to create the overview page. See "Page designer" in the SAP Jam User Guide.
Note Remember that a custom template can also be created by saving an existing group as a template. 3. To manage the visibility of a group template, click the visibility toggle in the first column of the Group Templates catalog. ○ A blue "check mark" switch position indicates a visible group template. ○ A grey "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 organization end 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. 4. The Actions menu options are:
82
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
Figure 73: Actions menu options
Note that the options available vary according to the type of group template (system or custom) and whether the group template is set to be visible or hidden. The options are: ○ Preview: Displays a preview of the group. ○ Edit: Opens the template in the (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. Note that you can add the following placeholder items to a template: ○ Overview: create one or more overview pages for the template. Add text, images, and dynamic widgets (see section on overview page designer on how to create overview pages). ○ Content: upload documents, photos, videos, or create wikis, business decision tools, folders, and private folders. You can copy and move content items within the template. ○ Forums: add forum topics. ○ Links: add links. There are certain items that cannot be added to a template, such as feed updates, recommendations, calendar events, tasks, and reports. Therefore, the corresponding sections on the left hand pane are intentionally disabled when designing a template. If Content and Forum are toggled off for this template (see section on Specify a Template's Default Group Behavior on how to do this), the sections will be hidden on the left hand pane. All changes to a template are saved automatically. ○ Export: Creates a ZIP archive of the group template and opens your browser's download dialog box, allowing you to save the exported group template.
Note The export/import functionality is not designed for long-term/permanent, offline storage of custom templates. You may need to re-export and re-import a custom template in event there is a nonbackwards compatible format, due to ongoing changes or improvements to templates made by the SAP Jam team. Caution: Do not delete a custom template from the source environment until it is successfully imported into the target environment. ○ Delete: Opens a confirmation dialog box, providing you with the option to proceed with, or cancel, the deletion of the group template. Only templates that are set to invisible can be deleted. Warning: template deletion is permanent. It does not go into the personal Trash and is therefore non-recoverable.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
83
5. To import a custom template, access the template catalog in the target company under Admin > Group Templates. Click Import a template, locate the zip file on your hard drive, and click Upload. An email notification is sent to the administrator performing the import when the process is complete at a later time. Any processing errors are noted in the email.
3.6
Create an auto group
Administrators can create groups in which their members are automatically added based on a number of set criteria during auto group creation. During auto group creation, administrators:: 1. Set up the group 2. Add content and general members 3. Activate the group
Note Only SAP Jam company administrators can create auto-groups. In addition to the regular SAP Jam group setup options, auto groups also have an option to specify membership. The Membership tab lets you setup auto groups based on the following profile criteria: ● All employees ● Country ● State ● City ● Location ● ZIP code ● Department ● Division ● Has Direct Report ● Hire Date ● Job Code ● 15 customizable fields You can also add individual members to your Auto Group by listing individual email addresses. Alternatively, you can set Auto Groups to use member lists as membership criteria. This is described in more detail below.
Note Group members are automatically included and cannot choose to opt out. 1. Go to the SAP Jam Admin console and select Auto Groups from the left navigation sidebar. The
84
Admin
Auto Groups
page displays, showing a list of the existing auto groups.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
Figure 74: Existing Auto Groups catalog
2. Click Create a Group. The Create an Auto Group page is displays, with the initial Generaltab showing.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
85
Figure 75: Create an Auto Group: General tab
○ Choose a group template from the list. Group templates contain an overview page as well as placeholder content and group structure including discussion forums that help you quickly set up a group that’s optimized to address specific business scenarios. For more information, see "About group templates" in the Group Administration Guide. ○ Enter a name for your group. Use a name that would help users distinguish your group form others. Click Check Group Name to see if there are other names that are similar to yours. ○ Enter a description for your group. The description captures the group's objectives and helps to inform and attract other people who might be interested. ○ Select a Group Type for your group. There are three type of groups to select from: ○ Public Internal Group - A group that anyone in your company can join, view, and edit. ○ Private Internal Group - A group where members must be explicitly invited in order to view or post group items. This group can only be edited by a group administrator and the group name can only be seen by invited members.
86
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
○ Private External Group - Note: cannot be used for auto groups. A group that lets you communicate with members of different companies in a private, invitation only space. This group can only be edited by administrators.
Note The group type cannot be changed after the group has been created. ○ In the Invite Members section, select Auto-Group to assign members to the group based on membership criteria set in the Membership tab. 3. [Optional] Click the Setup tab and add the following information for your group:
Figure 76: Create an Auto Group: Setup tab
○ Terms of Use: Create a user agreement that all group members will see on their first visit to the group. ○ Announcement: Create a welcome message that all group members will see on their first visit to the group. ○ Photo: Upload a group picture to be displayed on the group's main page. The maximum size for a group image is 110 x 110 px. ○ Overview Page as landing page: If you have created an overview page, you can choose to make it your group's landing page. When this option is selected, the "Overview" page will be the first thing users see each time they enter the group. This can be very helpful if your group has regularly updated goals, a running task list or any group-related information that gets updated frequently. If you don't select this option group members will see the "Overview" page on their first visit after the page has been created and the group's feed wall on subsequent visits. 4. [Optional] Click the Participation tab and select from the following options:
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
87
Figure 77: Create an Auto Group: Participation tab
○ Participation: ○ Collaboration Level controls who can share and collaborate on content. The options are as described in the page: ○ Read-only: Group Admins can share content. All users can view and download content. Chat, Discussions, Polls and Tasks are off. ○ Limited: Group Admins can share content. All users can view and add comments on content. ○ Full: All users can create and collaborate on group content. The Group Admin can customize the upload policy. ○ Upload policy If you choose the full participation setting, you can restrict the upload policy according to your needs: ○ All Members: all members of your company can upload new content items. This applies to public groups only. ○ All Group Members: all members of the group can upload new content items. ○ Only Group Admins: only group admins can upload new content items. All group members are allowed to comment or edit content.
88
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
○ Moderation Policy: If selected, this option requires group administrator approval before contributed content is displayed to members. ○ Task Policy controls who can update tasks. The options are as described in the page: ○ Read-only: Assignees can update their own task status. Non-assignees can view tasks only. ○ Limited: All users can update the status of any task. Non-assigneers can also view, but not update, other task details. ○ Full: All users can edit the details for any task.
Note Tasks can always be edited by group administrators and the task creators. ○ Enable Content Rating: If selected, this option allows users to rate group content items. 5. In the Membership tab, set how members are added to the group by selecting one of the follow options:
Figure 78: Create an Auto Group: Membership tab
○ If you select Add members by their profile attributes, add a criterion or a combination of criteria from the Add drop-down menu. For example, you can add a Hire Date range along with the additional criterion of only employees in the Professional Services Department. Add email addresses of members that don't fit the criteria. You can also make them group admins by checking the Make Group Admin checkbox.
Figure 79: Membership tab: Add by profile attributes
○ If you select Add members using member lists, use one or more member lists as membership criteria. As the members in the member lists change, so do the memberships of the Auto Groups that use those member lists as membership criteria. You can also group admins from the member lists used as membership criteria.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
89
Figure 80: Membership tab: Add by member lists
Note As you set the membership options, you can click Update Member Count at any time to see how many members your selections include. 6. When you have set all the options for the Auto Group to your satisfaction, click Create a Group at the bottom of the page. Auto Groups are set up as inactive to allow for initial structure and content setup. Only Group Admins have access to inactive groups. 7. In the Auto Groups list, click Activate next to your new group to put the group into use.
3.7
Hashtags administration
Hashtags provide a form of auto-completion for user text entry in wikis. You either create a CSV file, with only one entry per line, of the words or phrases that users can use the hashtag autocompletion with. In the editors in SAP Jam that support hashtag use, the user begins writing the word or phrase in the hashtag field, and as soon as they have typed enough for a unique match, the word or phrase is shown in the hashtag field. The user can then elect to add this term to the end of the text that they are writing. To configure hashtags, do the following: 1. Access the Admin console [page 11] and select Hashtags from the left navigation sidebar to view general information on your SAP Jam service. The
Admin
Hashtags
page is displayed.
Figure 81: Adding Hashtags
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 Foundation, click Import and select the file from the SuccessFactors Foundation hashfiles that are listed.
90
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
3.8
Overview of extranet administration
In SAP Jam terms, extranet administration involves the configuration and management of external users and the SAP Jam features that affect those external users' experience of SAP Jam. The location of the configuration settings for these features is a bit scattered throughout the Admin console's interface, so this section provides an overview of the various locations and procedures that relate to extranet administration. The default number of licensed external users is 100, although your organization can buy more at any time. To find out how many external user licenses your organization has purchased, and how many external user licenses are currently being used, please View your SAP Jam service General information [page 15]. You can do the things described in the following sections to manage your extranet users and their experience of SAP Jam. Manage extranet domains To make external logins more secure, you can set either a whitelist or a blacklist of email domains from which external users can log in to SAP Jam. For information, see the "Domain Management" section in Extranet Management [page 92]. Manage extranet users You can view a list of current and invited external users, see their status as external users, and Disable, Block, or Enable their access individually. For information, see the "Extranet users management" section of Extranet Management [page 92]. Set the Extranet Log-On Introductory Text When users are invited to External Groups, they receive a link to the Extranet log-in page. The login page, are presents external users with an introductory message. You can set the text of this message and the language or languages that it, or they, will be displayed in. For information, see step 6 in the procedure Configure SAP Jam Branding and Support options [page 27]. Set the log-on background image and the help page for extranet users You can set the background image shown in the login page for external users, and you can set whether they can view a custom help page. For information, see step 7 in the procedure Configure SAP Jam Branding and Support options [page 27]. Set a customized Terms of Service agreement for your extranet users You can set whether external users will be shown a "Terms of Service" agreement when they log in for the first time, and you can set the text of the terms of service agreement. For information, see the procedure Configure an Extranet Terms of Service [page 45]. Invite external users to an external group To have external users access your organization's SAP Jam service, you can send them invitations to join one of your organization's external groups. For information on how to do this, see the procedure "Invite external participants to a group" in the "Users and groups" section of the SAP Jam Group Administration Guide.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
91
3.9
Extranet Management
Domain Management To make external logins more secure, you can set either a whitelist or a blacklist of email domains from which external users can or cannot log in to your company's instance of SAP Jam. 1. Access the Admin console [page 11] and select Extranet Management from the left navigation sidebar to view general information on your SAP Jam service. The
Admin
Extranet Management
page is displayed.
Figure 82: Domain Management
2. In the Domain Management section, click the radio button for the type of list that you want to use. ○ Select Use a blacklist if you want users from all email domains to be able to connect, except those that you add to the text box. This is a less secure option, but it will likely require much less work to maintain. ○ Select Use a whitelist if you want users to be able to connect only if they have email addresses with domains that match those that you add to the text box. This is a more secure option, but you may have to make frequent changes whenever your organization collaborates with different external companies. 3. Add a space-separated list of email domains that you want to use as your whitelist or blacklist. 4. Click Save changes to enable the options that you have set. The email domains that you added are shown as a catalog on table format between the text box and and Save changes button. 5. Optionally, to remove a domain entry, select the checkbox beside the domain entry in the domains catalog that you want to remove, and click Save changes. The domain entry is removed from the domains catalog.
92
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
Extranet users management You can view a list of current and invited external users, see their status as external users, and Disable, Block, or Enable their access individually. 1. Access the Admin console [page 11] and select Extranet Management from the left navigation sidebar to view general information on your SAP Jam service. The
Admin
Extranet Management
page is displayed.
2. In the Extranet Users section, click the Show drop-down menu, and select the type of users that you want to view.
Figure 83: Extranet Users
The options are All, Active, Unaccepted Invites, Blocked Extranet, and Disabled. Note that the drop-down menu options show the number of users of each type so that you can avoid choosing to view an empty catalog. The Extranet Users catalog refreshes after a few seconds and displays the category of users that you selected. 3. To change a user's access: ○ To disable an "Extranet" user, select the checkbox beside their Email entry and click Disable Users. ○ To block an "External Companies" user, select the checkbox beside their Email entry and click Block Users. ○ To enable an "Disabled" user, select the checkbox beside their Email entry and click Enable Users. 4. Optionally, click the "edit" link in the status column for any user. The user's Edit Profile page is displayed, where you can edit and save their profile information. 5. Optionally, click the "Review Usage link in the status column for any user. The Content Administration page is displayed, with the Audit Usage tab activated, where you can view the user's activities in SAP Jam.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
93
3.10 Company administrator Reports SAP Jam reports display information on many aspects of SAP Jam usage, including adoption metrics such as user information, user contribution and consumption activity, and disk usage statistics. SAP Jam Reports can be downloaded as CSV files from the Reports tab. Most reports are available to Group Administrators for groupspecific data.
Note Report 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, 2014 to May 31, 2014, you would have to generate two reports. The first report would have a date range of January 1, 2014 to March 31, 2014, and the second report would span April 1, 2014 to May 31, 2014. To run a report 1. Access the Admin console [page 11] and select Reports from the left navigation sidebar. The
Admin
Reports
page is displayed.
Figure 84: Company administrator Reports options
2. Select the options for the report that you want to run: ○ Users: Select either This Company or Guest Users. ○ Select Report: Select the type of report that you want to run. The report types, and in some cases the report parameters, that are available are described below. ○ Time Frame: Click on 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. ○ Group: Select either All Company or any of the groups that have been created in your company.
94
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
○ Show metadata: 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). 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. For details on the reports that are available to SAP Jam Administrators, see the following descriptions: ● Activity Summary by Month or Week report details [page 108] ● Company User Detail Report details [page 97] ● Content Consumption by Week or Month report details [page 95] ● Contribution Report by Object by Week or Month report details [page 99] ● Engagement Report details [page 101] ● Expertise Report details [page 101] ● Group Activity Report details [page 102] ● Group Member Activity Report details [page 103] ● Group Template Activity Report details [page 104] ● Kudos Detail report details [page 105] ● Mobile Activation Report details [page 106] ● Terms of Service Compliance Report details [page 107] ● Top Disk Usage per Group or per User report details [page 107] ● User Activity Report details [page 109] ● User Consumption by Week or Month report details [page 110] ● User Contribution by Week or Month report details [page 100]
Note If 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.
3.10.1 Activity Summary by Month or Week report details 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:
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
95
● Users: Whether to report on company users or guest users. ● Time Frame (Start Date and End Date): The calendar-selected start and end points for the reporting period. ● Group: Whether to report on all groups, or the selected specific group. ● Show metadata: Whether to include report headings that show the report name and the selected report options.
Report details Shows a column per week or month in the time period selected, as well as a total for the time frame selected, with a row for each of the following content creation activities: ● Blogs: The number of blogs created in the week/month, as well as a total for the entire period. ● Chats: The number of chat posts added in the week/month, as well as a total for the entire period. ● Comments: The number of comments made in the week/month, not counting those in Discussions or Ideas, as well as a total for the entire period. ● Discussion Comments: The number of comments made in discussions in each week/month, as well as a total for the entire period. ● Discussions Created: The number of discussions created in each week/month, as well as a total for the entire period. ● Document Annotations: The number of documents annotated in each week/month, as well as a total for the entire period. ● Documents: The number of documents uploaded in the week/month, as well as a total for the entire period. ● Groups Created: The number of groups created in the week/month, as well as a total for the entire period. ● Idea Comments: The number of comments made in the week/month on ideas, as well as a total for the entire period. ● Ideas Created: The number of ideas created in the week/month, as well as a total for the entire period. ● Kudos Sent: The number of kudos sent in the week/month, as well as a total for the entire period. ● Links: The number of links added in the week/month, as well as a total for the entire period. ● New Members: The number of new group members in the week/month, as well as a total for the entire period. ● Nudges Sent: The number of nudges sent in the week/month, as well as a total for the entire period. ● Photo Annotations: The number of photo annotation added in the week/month, as well as a total for the entire period. ● Photos: The number of photos uploaded in the week/month, as well as a total for the entire period. ● Poll Votes: The number of poll votes cast in the week/month, as well as a total for the entire period. ● Polls: The number of polls created in the week/month, as well as a total for the entire period. ● Questions Answered: The number of answers to questions added in the week/month, as well as a total for the entire period. ● Questions Created: The number of questions created in the week/month, as well as a total for the entire period. ● Status Updates: The number of status updates made in the week/month, as well as a total for the entire period. ● Tasks Created: The number of tasks created in the week/month, as well as a total for the entire period. ● Videos: The number of videos created in the week/month, as well as a total for the entire period. ● Wiki Pages: The number of wiki pages created in the week/month, as well as a total for the entire period.
96
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
3.10.2 Company Settings Changes report details This report shows each company configuration change that has occurred in the specified time period.
Report options The options that are available when this report type is selected are: ● Time Frame (Start Date and End Date): The calendar-selected start and end points for the reporting period. ● Show metadata: Whether to include report headings that show the report name and the selected report options.
Report details Shows a row for each company configuration change that has occurred in the specified time period with the following columns of information: ● First Name: The first name of the member who made the configuration change. ● Last Name: The last name of the member who made the configuration change. ● Email Address: The email address of the member who made the configuration change. ● User ID: The log-in ID of the member who made the configuration change. ● Date: The date and time that the configuration change was made. ● Setting: The configuration setting that was changed. ● Original Value: The value of the setting prior to the change. ● New Value: The value of the setting after the change. ● Action: Whether the setting was enabled or disabled (Enable or Disable).
3.10.3 Company User Detail Report details This report shows information on each user with access to SAP Jam.
Report options The options that are available when this report type is selected are: ● Users: Whether to report on company users or guest users. ● Show metadata: Whether to include report headings that show the report name and the selected report options.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
97
Report details Shows a row for each user with the following columns of information: ● User ID: The user's SAP Jam ID. ● First Name: The user's first name. ● Last Name: The user's last name. ● Title: The user's title. ● Email Address: The user's email address. ● Country: The user's country of residence. ● Joined?: Whether or not the user has logged in to SAP Jam. ● 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 Company Administrator). ● Status: The user's member status (New, Pending, Active, or Alumni). ● Invited By: A semi-colon separated list of the users that invited this user to join SAP Jam.
3.10.4 Compliance report details This report shows information on each outstanding violation (match of terms listed in the compliance and profanity dictionaries) of the compliance rules.
Report options The options that are available when this report type is selected are: ● Users: Whether to report on company users or guest users. ● Show metadata: Whether to include report headings that show the report name and the selected report options.
Report details Shows a row for each violation of the profanity and compliance dictionaries: ● 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.
98
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
● Action: The action taken in response to the flag: "Ignored", "Alerted", or null.
3.10.5 Content Views Report by Week or Month details These reports show information on each content type in the selected time frame, for the selected group or for all groups.
Report options The options that are available when these report types are selected are: ● Users: Whether to report on company users or guest users. ● Time Frame (Start Date and End Date): The calendar-selected start and end points for the reporting period. ● Group: Whether to report on all groups, or the selected specific group. ● Show metadata: Whether to include report headings that show the report name and the selected report options.
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: ● Blogs: The views of blogs in the indicated week/month, as well as the total views for the entire period. ● Discussions: The views of discussions in the indicated week/month, as well as the total views for the entire period. ● Documents: The views of documents in the indicated week/month, as well as the total views for the entire period. ● Ideas: The views of ideas in the indicated week/month, as well as the total views for the entire period. ● Links: The views of links in the indicated week/month, as well as the total views for the entire period. ● Photos: The views of photos in the indicated week/month, as well as the total views for the entire period. ● Questions: The views of questions in the indicated week/month, as well as the total views for the entire period. ● Videos: The views of videos in the indicated week/month, as well as the total views for the entire period. ● Wiki Pages: The views of wiki pages in the indicated week/month, as well as the total views for the entire period.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
99
3.10.6 Contribution Report by Object by Week or Month report details These reports shows aggregated counts for each type of activity in the selected group or groups in the selected period of time.
Report options The options that are available when these report types are selected are: ● Users: Whether to report on company users or guest users. ● Time Frame (Start Date and End Date): The calendar-selected start and end points for the reporting period. ● Group: Whether to report on all groups, or the selected specific group. ● Show metadata: Whether to include report headings that show the report name and the selected report options.
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: ● Blogs: The number of blogs created or edited. ● Chats: The number of chats participated in. ● Comments: The number of comments made. ● Discussions: The number of discussions created or added to. ● Documents: The number of documents uploaded. ● Expertise Added: The number of expertise entries made. ● Expertise Endorsed: The number of expertise endorsements made. ● Ideas: The number of ideas added. ● Questions: The number of questions asked. ● Kudos Sent: The number of kudos awarded. ● Links: The number of links added. ● Photos: The number of photos uploaded. ● Polls: The number of polls created. ● Poll Votes: The number of poll votes cast. ● Status Updates: The number of status updates made. ● Tasks: The number of tasks assigned. ● Events: The number of calendar events created. ● Tags: The number of tags applied. ● Videos: The number of videos added. ● Wikis: The number of wikis created.
100
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
● Groups Created: The number of groups created.
3.10.7 Engagement Report details This report shows information on each active user in the company, with metrics for tracking user engagement.
Report options The options that are available when this report type is selected are: ● Users: Whether to report on company users or guest users. ● Show metadata: Whether to include report headings that show the report name and the selected report options.
Report details Shows a row for each user with the following columns of information: ● User ID: The user's SAP SAP Jam. ● Email Address: The user's email address. ● First Name: The user's first name. ● Last Name: The user's last name. ● Number of Followers: The user's number of followers. ● Number of People Following: The number of people that the user is following. ● Number of Groups Following: The number of groups that the user is following (is a member of). ● Number of Groups where the user is the Admin: The number of groups for which the user is an Administrator. ● Number of Wiki Pages Following: The number of wiki pages that the user is following. ● Number of Tasks Assigned: The number of tasks that the user has been assigned. ● Number of Tasks Following: The number of tasks that the user is following.
3.10.8 Expertise Report details This report shows information on each user who has defined an expertise, with details on their listed areas of expertise.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
101
Report options The options that are available when this report type is selected are: ● Users: Whether to report on company users or guest users. ● Show metadata: Whether to include report headings that show the report name and the selected report options.
Report details Shows a row for each user who has defined an expertise with the following columns of information: ● User ID: The user's SAP Jam ID. ● Email Address: The user's email address. ● First Name: The user's first name. ● Last Name: The user's last name. ● Expertise: A comma-separated list of the user's areas of expertise.
Note If 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.
3.10.9 Group Activity Report details This report shows information on each group in your company's instance of SAP Jam, with counts of the activity within the listed groups.
Report options The options that are available when these report types are selected are: ● Users: Whether to report on company users or guest users. ● Show metadata: Whether to include report headings that show the report name and the selected report options.
102
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
Report details Shows a row for each group in your company's instance of SAP Jam with the following columns of information: ● Group ID: The numeric ID for the group within SAP Jam. ● Group Name: The name of the group.
Note Non-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 Company", or "Public". ● Group Creator email address: The email address of the user that 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. ● Cross Company Domains: A comma-separated list of the company 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. ● # 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.
3.10.10 Group Member Activity Report details This report shows information on each group member in the specified group and the member's activities in the group.
Report options The options that are available when this report type is selected are: ● Users: Whether to report on company users or guest users. ● Group: Whether to report on all groups, or the selected specific group. ● Show metadata: Whether to include report headings that show the report name and the selected report options.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
103
Report details Shows a row for each group member with the following columns with the following columns of information: ● Group ID: The numeric ID for the group within SAP Jam. ● Group Name: The name of the group.
Note Non-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 Company", or "Public". ● Status: Whether the group is "Active", "Inactive", or "Deleted". ● User ID: The user's username. ● Email Address: The user's email address. ● First Name: The user's first name. ● Last Name: The user's last name. ● User Status: Whether the user is "Active" or an "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.
3.10.11 Group Template Activity Report details This report shows information on each template listed, with one row for each template used in the specified time period.
Report options The options that are available when this report type is selected are: ● Users: Whether to report on company users or guest users. ● Time Frame (Start Date and End Date): The calendar-selected start and end points for the reporting period. ● Show metadata: Whether to include report headings that show the report name and the selected report options.
104
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
Report details Shows a row for each template used in the specified time period with the following columns of information: ● Template ID: The numeric ID for the template within SAP Jam. ● Template Type: The type of the group template, which can be "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 Template" types. ● Create Date: The date that the template was created. This is only shown for "Custom Group Template" types. ● Last Modified: The date and time at which the template was more recently changed. This is only shown for "Custom Group Template" types. ● Business Record Dependency: If the template has a business record dependency, the name of the business record type that is shown in the form " > "; 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 Template" types. ● Consumption: The number of groups that have been created from this template.
3.10.12 Kudos Detail report details This report shows information on each kudos awarded in the specified reporting period.
Report options The options that are available when this report type is selected are: ● Users: Whether to report on company users or guest users. ● Time Frame (Start Date and End Date): The calendar-selected start and end points for the reporting period. ● Show metadata: Whether to include report headings that show the report name and the selected report options.
Report details Shows a row for each user with the following columns with the following columns of information: ● Kudos Type: The name of the kudos type. ● To: Email Address: The email address of the recipient of the kudos. ● Date Sent: The date that the kudos was awarded. ● To: First Name: The first name of the recipient of the kudos.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
105
● To: Last Name: The last name of the recipient of the kudos. ● To: User ID: The SAP Jam user ID of the recipient of the kudos. ● Comment: The comment, if any sent with the kudos. ● Status: Whether or not the kudos was Hidden or Shown. ● From: Email Address: The email address of the user who awarded the kudos. ● From: First Name: The last name of the user who awarded the kudos. ● From: Last Name: The last name of the user who awarded the kudos. ● From: User ID: The SAP Jam user ID of the user who awarded the kudos.
3.10.13 Mobile Activation Report details This report shows information on each user listed, which are the users who have installed the SAP Jam Mobile app and activated it in response to the invitations sent from the
Admin
SAP Jam Mobile app
page.
Report options The options that are available when this report type is selected are: ● Users: Whether to report on company users or guest users. ● Show metadata: Whether to include report headings that show the report name and the selected report options.
Report details Company-wide totals are shown for: ● Number of Users with Activated Devices: The number of unique users who have activated devices. ● Activated iOS Devices: The number of iOS devices in your company. ● Activated Android Devices: The number of Android devices in your company. ● Total Number of Activated Devices: The total number of mobile devices in your company. Also, rows are shown for each user with the following columns of information: ● User ID: The SAP Jam ID of the user who activated their SAP Jam Mobile app on their device. ● First Name: The first name of the user who activated their SAP Jam Mobile app on their device. ● Last Name: The last name of the user who activated their SAP Jam Mobile app on their device. ● Email Address: The email address of the user who activated their SAP Jam Mobile app on their device. ● Activated iOS Devices: The number of iOS devices on which the user has activated the SAP Jam Mobile app. ● Activated Android Devices: The number of Android devices on which the user has activated the SAP Jam Mobile app. ● Total Number of Activated Devices: The total number of mobile devices on which the user has activated their SAP Jam Mobile app.
106
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
3.10.14 Terms of Service Compliance Report details This report shows information on each user listed, which are the users who have accepted the Terms of Service set in the
Admin
Custom Terms of Service
page.
Report options The options that are available when this report type is selected are: ● Users: Whether to report on company users or guest users. ● Show metadata: Whether to include report headings that show the report name and the selected report options.
Report details Shows a row for each user with the following columns of information: ● User ID: The SAP Jam 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 that the user has accepted. Terms of Service as numbered incrementally as they are added (1, 2, 3, etc.). ● Accepted Time: The time at which the user has accepted their Terms of Service. ● Link: The URL to the Terms of Service that the user has accepted.
3.10.15 Top Disk Usage per Group or per User report details 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 company 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 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. The configuration required to ensure that you (administrators) receive these notifications is described in About notification emails [page 67].
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
107
Report options The options that are available when these report types are selected are: ● Users: Whether to report on company users or guest users. ● Show metadata: 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: ● User ID (User report only): The SAP Jam user ID of the user that is being reported on. ● First Name (User report only): The first name of the user that is being reported on. ● Last Name (User report only): The last name of the user that is being reported on. ● Email (User report only): The email address of the user being reported on. ● (Group) Name (Group report only): The name of the group that is being reported on. ● Last Updated (Group report only): The date and time that the group's content was last updated. ● 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.
3.10.16 User Contribution Activity Report details 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 The options that are available when this report type is selected are: ● Users: Whether to report on company users or guest users. ● Time Frame (Start Date and End Date): The calendar-selected start and end points for the reporting period.
Note For this report, the start date and end dates that are selected must be in the same month. ● Group: Whether to report on all groups, or the selected specific group. ● Show metadata: Whether to include report headings that show the report name and the selected report options.
108
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
Report details Shows a row for each user with the following columns of information: ● User ID: The user's SAP Jam user ID. ● Email Address: The user's email address. ● First Name: The user's first name. ● Last Name: The user's last name. ● User Status: Whether the user is 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. ● Chats: A count of the chats participated that the user in during 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. ● Kudos Sent: A count of the kudos awarded in the specified period. ● Links: A count of the links added in the specified period. ● Photos: A count of the photos 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. ● Tasks: A count of the tasks assigned 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.
3.10.17 User Contribution by Week or Month report details 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 The options that are available when these report types are selected are:
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
109
● Users: Whether to report on company users or guest users. ● Time Frame (Start Date and End Date): The calendar-selected start and end points for the reporting period. ● Group: Whether to report on all groups, or the selected specific group. ● Show metadata: Whether to include report headings that show the report name and the selected report options.
Report details Shows a row for each user with the following columns of information: ● User ID: The user's SAP Jam user ID. ● Email Address: The user's email address. ● First Name: The user's first name. ● Last Name: The user's last name. ● User Status: Whether the user is 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.
3.10.18 User Page Views Report by Week or Month details 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 The options that are available when these report types are selected are: ● Users: Whether to report on company users or guest users. ● Time Frame (Start Date and End Date): The calendar-selected start and end points for the reporting period. ● Group: Whether to report on all groups, or the selected specific group. ● Show metadata: Whether to include report headings that show the report name and the selected report options.
Report details Shows a row for each user with the following columns of information: ● User ID: The user's SAP Jam user ID.
110
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Administration
● Email Address: The user's email address. ● First Name: The user's first name. ● Last Name: The user's last name. ● (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.
SAP Jam Administrator Guide Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
111
4
Integrations
4.1
Integrations overview
This section describes how to integrate various applications with SAP Jam. There are three general types of integrations available: ● Business records integrations: You can integrate data from business-critical applications, which SAP Jam refers to as "business records". ● Document repositories integrations: You can integrate repositories or libraries of documents. ● Other SAP Jam integrations: There are also other types of integrations, including OpenSocial gadgets, gamification, web widgets, or integrating SAP Jam features into other applications using the SAP Jam API.
Note The SAP Jam Administration Guide section numbers referred to in the following diagrams and listed section refer to the section numbers that appear in the PDF version of the guide.
112
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
SAP Jam business records integrations
Figure 85: SAP Jam business records integrations
● New or custom integrations: SAP Jam allows you to develop new or custom integrations by leveraging the external application's OData API and OData Annotations. This approach requires some programming work. The mechanisms through which you can develop new or custom integrations are: ○ Through the SAP NetWeaver Gateway (which can supply OData and user identity services for onpremises applications). ○ Through the SAP HANA Cloud Platform (which can supply OData and user identity services for cloudhosted applications [SaaS]). ○ By directly accessing the external application's existing OData API and annotations. For these new or custom integrations, some development work is required. The procedures for developing these integrations are discussed in the External Applications section of the SAP Jam Developer Guide. ● Pre-configured integrations: The most common business record integrations are available as "ready-made" configurations for which the OData Annotations file has already been developed. These integrations are documented in the Integrate business records [page 116] section, which includes instructions on how to: ○ Integrate SAP CRM [page 122] ○ Integrate SAP ECC (SD) [page 132] ○ Integrate SAP Cloud for Customer [page 145]
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
113
○ Integrate SuccessFactors Learning [page 146] ● Configure access and authorization for integrated applications: To enable access between SAP Jam and these various external applications, one or more of the following access and authorization mechanisms must be configured: ○ Add a Trusted Certificate Authority [page 156] for external applications (business records and document repositories) if your organization's network uses unrecognized, self-signed SSL certificates. ○ Add an OAuth Client [page 158] to configure an entry point which is used by external applications to request authorizations from SAP Jam, which is required for the external application to initiate requests to the SAP Jam API. ○ Add SAML Trusted IDPs [page 161] to setup a relationship that SAP Jam trusts to make authenticated per-user requests from SAP Jam, for example, to display data from SAP Jam by using the SAP Jam API. ○ Configure SAP Jam as a SAML Local Identity Provider [page 163] to have SAP Jam act as the trusted SAML identity provider for external applications seeking single sign-on (SSO) user identity confirmation, which allows SAP Jam to make per-user requests of external applications' APIs.
SAP Jam document repository integrations
Figure 86: SAP Jam document repository integrations
114
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Integrate document repositories [page 165] from external applications to display the structured containers of those documents, and the documents that are contained in those structures, in SAP Jam. You can: ● Integrate SharePoint 2010 or 2013 [page 171] ○ Note that for SharePoint 2013 & 2010 integrations, you can include SAP Jam documents in the searches on SharePoint, as described in Federate SAP Jam search results into SharePoint searches [page 174]. This option uses SharePoint's OpenSearch conformance, as shown in the above diagram. ● Integrate Alfresco One 4.2 [page 179] ● Integrate SAP Extended ECM by OpenText [page 182] ● Integrate SAP Mobile Documents [page 190] ● Integrate Box [page 195] ● Integrate Office 365 SharePoint Sites [page 186] ● Integrate Google Drive [page 201]
Other SAP Jam integrations
Figure 87: Other SAP Jam integrations
Other SAP Jam integrations that are available include: ● Add OpenSocial gadgets [page 205] to extend SAP Jam's abilities to interact with any software or service. Also see the OpenSocial gadgets section in the SAP Jam Developer Guide for information on how to develop an OpenSocial gadget. ● Integrate SAP Jam with gamification vendors [page 210] to help guide and reward new hires and existing employees to rapidly integrate SAP Jam into their work processes. ● Use the SAP Jam Widget Builders [page 215] to integrate several SAP Jam features into web pages. Also see the Embeddable widgets section in the SAP Jam Developer Guide.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
115
● Use the SAP Jam API to integrate SAP Jam features into external applications. This documentation is in the SAP Jam Developer Guide. ● You can also integrate the SuccessFactors Human Capital Management (HCM) Suite's Time Off and Employee Central Payroll data, although this integration is actually done in SuccessFactors Foundation. The integration procedures are documented in the following documents, which are located in the SuccessFactors HCM Suite Integration section of the SAP Help Portal: ○ Time Off and Employee Central Payroll Integration Guide ○ Metadata Framework (MDF) Implementation Guide , Chapter 10 MDF Security Using Role-Based Permissions, sections 10.1 and 10.2. Note that you may need to modify rules for the EmployeeTime object (see "Adding Rules", section 3.3.4).
4.2
Integrate business records
Content from business-critical applications can be integrated into SAP Jam for viewing and interactive use. There are two main types of content that can be integrated into SAP Jam: Business Records and Document Repositories. Each type of content can be integrated using the particular technologies that are appropriate for the specific selected application. ● Business Records: Data from a variety of business applications can be displayed in SAP Jam by getting the data from that application's OData API, or from an intermediary platform that supplies an OData API for that application, and using an OData annotations file to specify how each type of data is displayed in a specified UI element. This type of content is referred to as Business Records. ● Document Repositories: For more information on integrating documents from an external document repository or library, please see the Integrate document repositories [page 165] section, later in this chapter.
Procedures required to integrate business records into SAP Jam The procedures for integrating business records are listed below, and are illustrated in the diagram that follows: 1. Perform any required preparations on the external application or the intermediary platform. This mostly involves establishing trusted data communications with SAP Jam. 2. Add a Trusted Certificate Authority if your organization requires the use of unrecognized or self-signed certificates. This allows your browser to use the HTTPS/TLS connection to access the external application's data without obstruction. 3. Optionally, you can also allow the external application to open a connection to SAP Jam, which allows updates and feed events to be forwarded to SAP Jam. There are two ways to configure this, depending on the requirements of your external application: 1. Add an OAuth Client 2. Add a SAML Trusted IDP 3. Configure SAP Jam as a SAML Local Identity Provider 4. Register the external business application in SAP Jam. This mostly involves establishing trusted data communications with the external application. 5. Develop an OData Annotations file to display the business records if you are integrating business records via the SAP HANA Cloud Platform, or you are doing a new or custom integration via SAP NetWeaver Gateway,
116
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
or integrating a business application directly from a Third Party OData Source. Note that this is a developer task, and you should be following the procedures described in the External Applications section of the SAP Jam Developer Guide. 6. Register the business records that you want to expose for viewing in SAP Jam. 7. You can modify the data exposed in business records in two ways: 1. Add a filter to any business record to narrow the range of results displayed in a particular business record, allowing finer-grained usage of the data across multiple business records that can be displayed in different SAP Jam groups. 2. Set a sort order for any business record, which determines the order in which the rows of information will be displayed in the business record. Note that for SuccessFactors Learning, filters are pre-configured and cannot be modified, and a sort order is not relevant. 8. Add the business records to a SAP Jam group and your group members will be able to view and discuss the external data in SAP Jam.
Figure 88: Work required to integrate business records
Organization and coverage of these procedures in the SAP Jam Administrator Guide Procedure 1 (Perform any required preparations), procedure 4 (Register the external business application in SAP Jam), and procedure 6 (Register the business records) in the above diagram are documented together in per-
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
117
application integration pages, as these sections require considerable application-specific information, and they are most clearly dealt with by combining these instructions in the following sections: ● Integrate SAP CRM [page 122] ● Integrate SAP ECC (SD) [page 132] ● Integrate SAP Cloud for Customer [page 145] ● Integrate SuccessFactors Learning [page 146] The procedures for configuring access and authorization, which are procedure 2 (Add a Trusted Certificate Authority), procedure 3a (Add an OAuth Client), procedure 3b (Add a SAML Trusted IDP), and procedure 3c (Configure SAP Jam as a SAML Local Identity Provider) in the above diagram, are documented in separate sections as these steps are generally the same for all business records and document repositories integrations (although application-specific information is required in some fields). These procedures are documented in the following pages: ● Add a Trusted Certificate Authority [page 156] to configure access to web-based applications and services within your organization if unrecognized or self-signed certificates are used. ● Add an OAuth Client [page 158] to allow an external application to access the SAP Jam API. ● Add SAML Trusted IDPs [page 161] to allow an external application to access SAP Jam user ID and authorization information so that it will display only the material that a user is authorized to view when SAP Jam features are integrated into the external application. ● Configure SAP Jam as a SAML Local Identity Provider [page 163] to allow SAP Jam to access an external application's user ID and authorization information so that it will display only the material that a user is authorized to view when they view pages where integrated external application business records are displayed in SAP Jam. Procedure 5 (Develop the business record's annotations file) is a development step that is only required if you are developing a new or custom integration, in which case you should be following the procedures described in the External Applications section of the SAP Jam Developer Guide. With the specific business records added, you can also modify the data displayed in the business records for SAP CRM, SAP ECC (SD), and SAP Cloud for Customer, (in other words, these configurations are not available for a SuccessFactors Learning integration) in the following ways: ● procedure 7a Add a business record filter [page 153] This configuration allow you to narrow the range of results displayed in a particular business record, which permits finer-grained usage of the data across multiple business records that can be displayed in different SAP Jam groups. ● procedure 7b Add a business record sort order [page 154] This configuration determines the order in which the rows of information will be displayed in the business record. Now that all of the configuration steps are done, users can add business records to their groups, procedure 8 (Add the business records to a SAP Jam group), which is described in the section: ● Configure access to business records in SAP Jam [page 155]
A preview of the Admin UI screens and the information required to integrate External Applications This section provides a quick preview of the SAP Jam Admin console pages in which the configuration procedures are performed, and the information that is required in those pages, for the integration steps described in the perapplication integration pages listed above (procedures 4 and 6).
118
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
These SAP Jam Admin console pages and the required information to fill these forms are as follows: ● After the required configuration is done on the external application or intermediary platform, the external business application must be registered in SAP Jam by accessing the Admin console [page 11] and selecting External Applications from the left navigation sidebar, clicking Add Application, and then selecting the type of application that you want to integrate from the drop-down menu.
Figure 89: Register the external business application in SAP Jam
The available options for adding a business records application are: ○ SAP NetWeaver Gateway: This platform is used to provide OData APIs and related services for onpremises applications. Use this option to integrate the preconfigured applications: ○ SAP CRM ○ SAP ECC (SD) ○ SAP Cloud for Customer: Use this option for the preconfigured integration of SAP Cloud for Customer only. ○ SuccessFactors Learning: Use this option for the preconfigured integration of SuccessFactors Learning only. ○ SAP HANA Cloud Platform and Third Party OData Source: Use these option to develop a new integration of an application accessed by the HANA Cloud Platform or one that already has its own OData API. Again, please note that if you are developing a new or custom integration with a business records application, you should be following the procedures in the External Applications section of the SAP Jam Developer Guide. When you select one of the above-listed business record integration options, a page is displayed showing a form for the fields and options required to establish a trusted data exchange between SAP Jam and either the
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
119
business application being integrated or the intermediary platform that is hosting the business application. There is some variation in the fields of information that are required for these different options, which are shown in the following diagram.
Figure 90: Fields available in the business record Add Application forms
● You must also Register each of the business records that you want to expose for use in SAP Jam. This page is accessed by clicking on the Action menu in the row for the application in the External Applications main page that you are integrating, and selecting Manage Record Types from the drop-down menu, and then clicking Add Record Type.
120
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Figure 91: The Add Record Type page
The options in this page are the same for all business records integrations.
Note Next: If you are ready to begin to integrate an external application's business records into SAP Jam, proceed to the appropriate instructions: ● Integrate SAP CRM [page 122] ● Integrate SAP ECC (SD) [page 132] ● Integrate SAP Cloud for Customer [page 145] ● Integrate SuccessFactors Learning [page 146] If you intend to perform a new or custom integration, not one of the above-listed "pre-configured" integrations, see: ● Develop a new or custom business records integration [page 122]
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
121
4.2.1 Develop a new or custom business records integration SAP Jam offers the capability to develop new or custom business records integrations. The approaches to doing so are: ● You can develop a new or custom integration with an on-premises application that lacks an OData API by using the SAP NetWeaver Gateway. ● You can develop a new integration with a cloud-hosted application (SaaS) that lacks an OData API by using the SAP HANA Cloud Platform. ● You can develop a new integration with an application that does have an OData API by using the SAP Jam "Third Party OData Source" option. If you are planning on developing any of these options, you should follow the instructions in the External Applications section of the SAP Jam Developer Guide. Note that the SAP HANA Cloud Platform offers a wide array of options for accessing an application's data via an OData API. To select and configure the option that works best for you and your organization, please see the SAP HANA Cloud Platform documentation Help Portal at https://help.hana.ondemand.com/.
4.2.2 Integrate SAP CRM
Overview Configuring a SAP Jam integration with SAP CRM and SAP NetWeaver Gateway involves three main steps: 1. Configure SAP CRM to call SAP Jam. to set up SAP Jam to trust SAP CRM as a Use the guide Connecting SAP Jam with SAP ABAP Systems SAML Identity Provider, and set up the OAuth client in SAP Jam so that CRM users can make status posts to Jam from within SAP CRM. 2. Configure SAP NetWeaver Gateway to send SAP CRM business record change notifications to Jam. Use the guide Distributing SAP Gateway Notifications to SAP Jam to set up Jam to trust the SAP NetWeaver Gateway as a SAML Identity Provider and set up the OAuth client in SAP Jam so that the SAP NetWeaver Gateway can post business record change notification events to SAP Jam. 3. Configure SAP Jam to call SAP NetWeaver Gateway OData APIs. Use either the Common User Authentication or Per-User Authentication configurations in SAP Jam Admin console External Applications Add/Edit External Application CRM data using the SAP NetWeaver Gateway OData APIs.
to enable SAP Jam to display SAP
Note You will need to open a port in your company’s firewall to allow SAP Jam to call into your SAP NetWeaver Gateway system.
122
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Using Common-User authentication in a CRM integration Note This configuration uses a common user for Jam-to-Gateway OData calls, which is suitable for testing and prototyping development or test environments only.
Figure 92: Common-User authentication in a CRM integration
Using Per-User Authentication in a CRM integration In this configuration, SAP Jam makes OData calls to the SAP NetWeaver Gateway using SuccessFactors BizX user accounts that are mapped to SAP NetWeaver Gateway and SAP CRM accounts. In this way, each user can have different permissions set for different SAP CRM business records. SAP strongly recommends that you configure Per-User Authentication for production systems.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
123
Figure 93: Per-User authentication in a CRM integration
SAP NetWeaver Gateway Configuration Steps Before configuring the SAP NetWeaver Gateway, ensure that you have applied note (patch) 2083419. Once this is done, perform the following procedures. On the Gateway hub server: 1. Call the transaction /n/IWFND/MAINT_SERVICE and register the new service /CRMSWI01/CRMSMI_SRV (version = 0001). 2. Specify the system alias of the back-end system that will be connected. If necessary, a new system alias can be created from the given transaction by pressing the Customizing button in the System Aliases section. 3. Check whether the OData ICF node is activated by doing the following: 1. Select the registered OData Service in the service catalog. 2. Click the ICF Node button on the OData ICF node entry. 3. In the button menu select Activate. Activate the OData Service for Business Record Change Notification: 1. Choose the Customizing activity Gateway Notifications
SAP NetWeaver
Application Server
Basis Services
Collaboration
Activate OData Service for Notification .
2. Register the following OData Services: Table 21:
124
Service
Provider
External Service Name
Send
Jam
CRMSWI01
CRMSMI_SRV
All notifications
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Service
Provider
External Service Name
Send
StreamWork
CRMSWI01
CRMSMI_SRV
All notifications
3. Establish a secure connection between your SAP Jam instance and your Gateway hub server (or proxy), using the OAuth 2.0 SAML bearer assertion flow. Follow the instructions at Using OAuth 2.0 from a Web Application with SAML Bearer Assertion Flow . 4. On the CRM system: 1. Start transaction SM31 2. At view CLBV_APPLI_CONT, be sure that the following application contexts exist: ○ CRM - SAP Jam Integration with SAP CRM ○ SAIL - Social Media ABAP Integration Library (Default) 5. Choose the Customizing activity Gateway Notifications
SAP NetWeaver
Application Server
Basis Services
Collaboration
Define OData Service Registry .
6. Add the following entries: BUS1006 CRM ==> New external service name /CRMSWI01/CRMSMI_SRV, new OData request URL /sap/opu/odata/CRMSWI01/CRMSMI_SRV/ BUS2000111 CRM==> New external service name /CRMSWI01/CRMSMI_SRV, new OData request URL /sap/opu/odata/CRMSWI01/CRMSMI_SRV/ 7. Add the following new entries for the corresponding annotation files: BUS1006/ANNO_P CRM /CRMSWI01/CRMSMI_SRV /sap/opu/odata/CRMSWI01/CRMSMI_SRV/AnnotationCollection('x')/Content/$value BUS2000111/ANNO_P CRM /CRMSWI01/CRMSMI_SRV /sap/opu/odata/CRMSWI01/CRMSMI_SRV/AnnotationCollection('x')/Content/$value For all these services, Service Provider = StreamWork will be registered in the view cluster. This means that SAP Jam is in compatibility mode with SAP StreamWork.
Connecting Gateway to Multiple CRM Systems If your Gateway system is connected to multiple CRM systems, you can either: ● Configure aliases in the Gateway ● Set the NetWeaver Client ID in Jam Setting the NetWeaver Client ID in Jam has the advantage of allowing you to keep Development, Test, and Production systems separate. The user authentication between the different clients and CRM systems are completely separate in this approach. For example: Gateway System GW2, Client 001, User JOHNSMITH may be able to access CRM System CR1, Client 002, User JOHNSMITH, but not CRM System CR2, Client 002, User JOHNSMITH. It is also simpler to configure. ● To configure aliases in the Gateway: 1. Specify multiple system aliases in the Gateway hub system. 2. Register all these systems aliases at transaction /n/IWFND/MAINT_SERVICE of the Gateway hub for service /CRMSWI01/CRMSMI_SRV;.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
125
3. Change the object registration at SAP Jam accordingly: for all objects mentioned before, the URL will contain /CRMSMI_SRV;o=/ instead of /CRMSMI_SRV/. Duplicate the objects (per system alias) that you would like to address. For example, an Account URL for CRM System CR2, Client 003 would become: https://gw.mycompany.com/sap/opu/odata/CRMSWI01/ CRMSMI_SRV;o=CR2CLNT003/$metadata#PartnerCollection ● To set the NetWeaver Client ID in Jam: ○ Follow the instructions in "Register SAP CRM business records in SAP Jam" below.
Set up required access and authorization These procedures establish the access and authorization configurations in SAP Jam that are required for the integration of SAP CRM: ● Add a Trusted Certificate Authority [page 156] if your network uses unrecognized or self-signed HTTP with TLS or SSL certificates. ● Add an OAuth Client [page 158] to configure an authorized entry point, for SAP CRM to initiate requests to the SAP Jam API in order to display SAP Jam content in SAP CRM. ● Add SAML Trusted IDPs [page 161] to establish a trust relationship between SAP CRM and SAP Jam that allows SAP CRM to use SAP Jam identity and authorization information, which ensures that SAP CRM users can only view the SAP Jam content that they are allowed to view when SAP Jam content is displayed in SAP CRM. ● Configure SAP Jam as a SAML Local Identity Provider [page 163] to establish a trust relationship between SAP Jam and SAP CRM that allows SAP Jam to use SAP CRM identity and authorization information, which ensures that SAP Jam users can only view the SAP CRM content that they are allowed to view when SAP CRM content is displayed in SAP Jam.
Register SAP CRM as an External Application in SAP Jam Create an External Application entry to register your SAP CRM application with SAP Jam. This procedure is the required step in SAP Jam for setting up a secure data connection with your external business application via SAP NetWeaver Gateway. 1. Access the Admin console [page 11] and select External Applications from the left navigation sidebar. The Admin External Applications page is displayed. This initial page is a catalog of the external applications that have been configured for your organization's SAP Jam instance. 2. Click Add Application. A drop-down menu listing the available external application types is displayed.
126
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Figure 94: Register SAP CRM in SAP Jam
3. Select SAP NetWeaver Gateway as the external application type that you want to add from the drop-down menu. 4. Type in a meaningful name in the Name text box, such as one that names the external application and/or its dedicated use.
Note This name will appear in the SAP Jam navigation sidebar and in other locations in SAP Jam, so it is important to make it something recognizable. 5. Select the Authentication Type. ○ Use the Common user option for testing and development purposes only.
Figure 95: Common user options
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
127
For the Common user option, set the following: 1. User name: This is the user name of the generic user account that will be used to access the service on behalf of all of the SAP Jam users. 2. Password: This is the password of the generic user account that will be used to access the service on behalf of all of the SAP Jam users. In the Common User authentication mode, all access from SAP Jam to the external data source will be made through an HTTP Basic authentication call using the provided user credentials. This is recommended only if you wish to expose all of the data in the data source to all SAP Jam users in your company. In other words, ensure that all the data exposed through the application can be considered "public" within your company. ○ Use the Per user option for production systems.
Figure 96: Per-user options
For the Per user option, set the following: 1. OAuth 2.0 Client Id: Your organization's client ID with your OAuth 2.0 SSO provider. 2. Secret: Your organization's OAuth 2.0 SSO secret. 3. Service Provider: The URL of your organization's OAuth 2.0 SSO provider, set in three parts: protocol, host, and port number. 4. Service Provider Name: The name of your organization's OAuth 2.0 SSO provider. 5. Scope: Your organization's company name as set in SAP Jam. This can be found in the General
Jam Admin
page.
In the Per-User authentication mode, SAP Jam authenticates the current user against the external application through the OAuth 2.0 SAML bearer assertion work flow. Since SAP Jam delegates its user authentication to SuccessFactors Platform, a trust relationship must first be established between the external application and the SuccessFactors Platform. Once this relationship is established, an OAuth client for SAP Jam is configured in the external application, using the SuccessFactors Platform IDP as the issuer of identity assertions for the client. When an SAP Jam user attempts to access the external data source, Jam will first post a SAML assertion on the user's identity to the external object in exchange for an OAuth token for that user. If successful, SAP Jam will use this OAuth token for all subsequent data access on behalf of that user. More detail can be found at: http://tools.ietf.org/html/draft-ietf-oauth-saml2-bearer-20 . 6. Set the NetWeaver Client Id. This is the three-digit login parameter for your NetWeaver client.
128
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Figure 97: The Add External Application dialog box, latter options
7. Optionally, Select Trusted OAuth Client from the drop-down menu. This is required if you want the external application, which supplies the business records, to be able to post feed updates in SAP Jam. 8. Select the source of the SAML assertion provided by SAP Jam from the drop-down menu. The default for this option is SAP Jam, but you can select SuccessFactors Foundation. This should be set to match the source that you use to supply your user identity information. 9. Click Save. You are returned to the Jam Admin External Applications page, where the list of external applications that have been added is displayed, now including the external application that you have just registered.
Troubleshooting If you only see the notification in SAP Jam, but no back-end data is rendered in the Quick View on mouse-over, you should check the error log (transaction /IWFND/ERROR_LOG) and the application log (transaction SLG1, application /IWFND/) of the connected Gateway hub system.
Register SAP CRM business records in SAP Jam Once you have completed the required configuration to access your external SAP CRM application from SAP Jam, you need to further configure it by adding the particular business records that you want to access. To register business records: 1. In the Admin console External Applications section, click on Action beside the OData application for which you want to add objects and select Manage Record Types from the context menu. The Manage Record Types screen is displayed for that application. 2. Click Add Record. The Manage Record Types screen is displayed for that application. 3. Click Add Record. The Add Record Type dialog box is displayed.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
129
Figure 98: The Add Record Type dialog box
4. In the Name field, enter a meaningful name for the object that you want to add. 5. Enter the External Type and Annotation for the type of object that you want to add. The External Type must be the URL to OData metadata EntityType of the record that you are adding; the Annotation must be the URL to the OData annotations file, which describes how the incoming data will be laid out in a graphical element of the UI. These entries differ for each Application Type and record type that you want to display: ○ For a Corporate Account business record, enter: External Type: https:///sap/opu/odata/CRMSWI01/CRMSMI_SRV/ $metadata#CorporateAccountCollection Annotation: https:///sap/opu/odata/CRMSWI01/CRMSMI_SRV/ AnnotationCollection(Content='x')/ Content/$value
130
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
○ For an Individual Account business record, enter: External Type: https:///sap/opu/odata/CRMSWI01/CRMSMI_SRV/ $metadata#IndividualAccountCollection Annotation: https:///sap/opu/odata/CRMSWI01/CRMSMI_SRV/ AnnotationCollection(Content='x')/ Content/$value ○ For an Opportunity business record, enter: External Type: https:///sap/opu/odata/CRMSWI01/CRMSMI_SRV/ $metadata#OpportunityCollection Annotation: https:///sap/opu/odata/CRMSWI01/CRMSMI_SRV/ AnnotationCollection(Content='x')/ Content/$value ○ For an Service Request business record, enter: External Type: https:///sap/opu/odata/CRMSWI01/CRMSMI_SRV/ $metadata#ServiceRequestCollection Annotation: https:///sap/opu/odata/CRMSWI01/CRMSMI_SRV/ AnnotationCollection(Content='x')/ Content/$value In the above examples, the External Type URLs are fixed except for the host domain. For the Annotation URLs, however, the actual URL will depend on where you have placed your annotation XML file; whatever the URL is, it must return the appropriate annotation file. 6. Select the language or languages that the imported record will be displayed in by clicking Add Language and checking the check box in front of each language that you want the data displayed in. The selected language or languages will appear above the Add Language button. Click the "X" on the right side of any language button to remove it. Note that the first language listed will always be the "Primary" language. 7. Select Import External Resources to import the data using the URLs listed above. SAP Jam will attempt to import the indicated resources, and it will display a message indicating the success or failure of the import, and information on the cause of a failure if one occurs and the cause can be determined. 8. Select Can be featured or unfeatured in groups to enable this option. 9. Select Can be primary object in top-level group to enable this option. 10. Select Can be primary object in subgroup to enable this option. 11. Select Filter Feed to enable users to add or remove feed entries of this object type. 12. Select Feed History to see the feed history independently of follows, which means: ○ If disabled, the user will only see the subset of feed items that were routed to their home feed; that is, they will only see items which had a distribution list that included them, or items in which the user was atmentioned.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
131
○ If enabled, and if authorization is successful, the user will see the full feed for the object, including items that would otherwise not be visible to them. 13. Select Show Search to enable keyword searching in the business data browser. When rendering a list of External Objects, SAP Jam may also show a "search" box. If this option is selected, you can also set: ○ In the Hint field, you can enter a display string that tells the user what field the search is performed on. ○ In the Property field, you can enter the actual OData property name that the search is performed on. Internally, Jam will make a [GET] request to the OData collection for the given object type, using an OData $filter expression on the Property specified in the configuration screen. For example: [GET] /ObjectCollection?$filter=startswith('text', Property) 14. Select Can be mentioned in feed posts to enable this option. If this option is selected, you can also set: ○ Primary (Search) Property: enter the OData property name that an at-mention look-up will search for. ○ Secondary (Display) Property: enter the OData property name that an at-mention look-up will display. 15. Once you have configured the record to your satisfaction, click Save. You are returned to the Record Types catalog, and the record type that you just added will be listed in the table.
Note Next: You can now, optionally, add an External Application Object Filter [page 153] to narrow the range of data shown in a particular external application data object. Additionally, you can now, optionally, add an External Application Object Sort Order [page 154] to set the order in which the external data is arranged in a particular external application data object. If you do not want or need to add Filters or Sort Fields to your External Application Objects, you can proceed to Configure access to business records in SAP Jam [page 155].
4.2.3 Integrate SAP ECC (SD) A SAP Jam integration with SAP Sales and Distribution (SD) allows you to integrate SD processes with SAP Jam, such as creating a SAP Jam group from a business record overview page, or following updates to a SAP Jam group from within the SD GUI. Also, SAP NetWeaver Gateway services are used to send notifications about changes to SD business records to SAP Jam subscribers. SAP Jam subscribers receive these updates in SAP Jam as feed entries. This integration can, optionally, include an integration with SAP CRM. If you choose this option, you must perform both the NetWeaver preparation procedures in Integrate SAP CRM [page 122] and the procedures in this page. This page covers the following configuration tasks: ● Enabling subscriptions to the following SD-specific business records: ○ Sales Orders ○ Invoices ○ Quotations
132
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
○ Customers ○ Outbound Deliveries ● Configuring the SD-specific ESJI_SD_SRV OData service to distribute SAP Gateway notifications for the supported business records. provides generic The SAIL configuration guide Distributing SAP Gateway Notifications to SAP Jam descriptions of the required tasks for configuring the Send Notifications scenario. You have to complete these tasks to distribute SAP Gateway notifications. Use the SD-specific information for the Send Notification scenario in SAP ECC SD, as described in this page, when you complete the respective sections in the generic SAIL guide.
Note You must complete the configuration steps as described in the SAIL configuration guide Connecting SAP Jam with SAP ABAP Systems before continuing with the rest of the procedures in this page.
Figure 99: SAP ECC ERP with SAP CRM network overview
Required SAP Versions ● SAP ECC: ○ EhP7 SP04 with Note 2009570 ○ EhP7 SP05 (RTC in July, 2014) ○ EhP7 SP06 (RTC EO November, 2014) ● SAP Netweaver Gateway: The SAP ECC scenario has the same requirements as the SAP CRM scenario. ● SAP CRM: ○ Software Component: CRMSWI01 CRM-BF-SW ○ 2003000: Allows you to view Quotations in a CRM Corporate Account group; adds a link to ECC Quotations from the CRM annotation
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
133
○ SAP CRM Add-On: 1797033 Customizing Guide: Business Object Change Notification 1835654 No notifications for address fields of corporate account 1837380 Block BO Notifications on BO Org. Data Change ○ SAP CRM Add-On: Thing Inspector 1891369 Opportunity and Account OData Services for SAP Jam 1928182 Service Request: OData Service for SAP Jam 1941833 OData Service for SAP Jam integration: Corrections 1988318 Exception occurred with request for individual and corporate account 1938485 Globalization: Multiple Language Support for OData Service /CRMSWI01/CRMSMI_SRV/ 1989573 Missing properties at account entity types 1972217 OData service /CRMSWI01/CRMSMI_SRV/ shall support the combination of OrderBy and Top 1896961 HTTP/HTTPS Configuration for SAP NetWeaver Gateway (GW) 1797103 OAuth Implementation for NW Releases < 7.40 (GW)
Subscriptions in SAP SD To enable users to follow or unfollow particular business records, the Generic Object Services (GOS) drop-down menu has to be available in the user interface of SAP Sales and Distribution (SD). GOS provides different functions such as adding an attachment, creating a document link, or displaying all attachments. Attachments are specific to a particular SAP object. Prerequisites You have activated the following business functions: ● BC_SRV_STW_03 ● LOG_SD_JAM_INTEG To activate the GOS drop-down menu in the SD SAP GUI:
134
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Figure 100: The Follow button in ECC
1. Run transaction SU3. 2. On the Parameters tab, in the SET/GET Parameter ID field, enter SD_SWU_ACTIVE. 3. In the Parameter Value field, enter X or *. This activates the GOS button in the following SD transactions: ○ Update Sales Order (VA02)/Display Sales Order (VA03) ○ Update Invoice (vf02)/Display Invoice (vf03) ○ Update Quotation (VA22)/Display Quotation (VA23) ○ Update Customer (XD02)/Display Customer (XD03) ○ Update Delivery (VL02n)/Display Delivery (VL03n)
Configuring the ESJI_SD_SRV OData Service on the SAP Gateway server The configuration tasks on the SAP Gateway server for the Send Notifications scenario are described in chapter 3, Configuration of the SAP Gateway Server, of the SAIL configuration guide Distributing SAP Gateway Notifications to SAP Jam . In this procedure, you register the ESJI_SD_SRV OData service in the Gateway system. This service is defined in, and delivered with, the back-end system add-on. Use the values in the following procedure when completing section 3.7 Configuring OData Services of the SAIL guide. To configure the ESJI_SD_SRV OData service
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
135
1. Log on to the Gateway server as an administrator. 2. In Customizing for SAP NetWeaver, choose SAP NetWeaver Gateway to SAP System
Gateway
OData Channel
Administration
Activate and Maintain Services
General Settings
(or run transaction /IWFND/
MAINT_SERVICE). 3. On the Activate and Maintain Services screen, select Add Service. 4. On the Add Selected Services screen, enter the system alias name you created and press Enter. 5. In the External Service Name column, select the service ESJI_SD_SRV. 6. In the Add Service dialog, in the Creation Information group box, select a package. 7. Press F3 (Back). 8. Verify that OData ICF nodes are activated for all registered OData Services as follows: ○ In the service catalog, select the registered OData Service and, on the OData ICF node, select ICF Node. ○ Select Activate and confirm the selection. 9. Save your entries.
SAIL on the SAP Gateway Server The generic configuration tasks for configuring SAIL on the SAP Gateway server are described in chapter 4, Configuring SAIL on the SAP Gateway Server, of the SAIL configuration guide Distributing SAP Gateway Notifications to SAP Jam . It is mandatory that you maintain the notification filter. This filter restricts the number of notifications that are sent. You must specify the OData services for which notifications are to be sent to the service provider. The following views represent the notification filter: ● CLBV_GW_NOTIFY_S: Entries delivered by SAP ● CLBV_GW_NOTIFY_C: Customer-defined settings The system, which decides whether a notification is sent, first checks if an entry exists in the C table for your service provider type and OData service. If so, the S table is not taken into account. This means that entries in the C table override the SAP defaults. Use the values in the following procedure when completing section 4.3, Maintaining Notification Filter, of the SAIL guide. To activate the ESJI_SD_SRV OData service: 1. To customize SAP NetWeaver, choose Notifications
Application Server
Activate OData Service for Notification
Basis Services
Collaboration
Gateway
(or call up view CLBV_GW_NOTIFY_C).
The Change View OData Service Settings for Notifications: Overview screen appears. 2. To activate notifications for the ESJI_SD_SRV OData service, complete the fields as follows: Table 22: ESJI_SD_SRV OData service fields
136
Field
Value
Serv. Provider Type
Enter the service provider type, for example, Jam.
Ext. Srv. Name
Enter ESJI_SD_SRV.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Field
Value
Send Notifications
Select All Notifications.
Note The Customizing filter entries are related to an external service name. This is the same name that has been registered at the Gateway server (see "Configuring the ESJI_SD_SRV OData Service on the SAP Gateway server" above). 3. Save your entries.
SAIL in the Application Back End The generic configuration tasks for configuring SAIL in the application back end are described in chapter 5, Configuring SAIL in the Application Back End, of the SAIL configuration guide Distributing SAP Gateway Notifications to SAP Jam . This section contains SD-specific information for defining the SD-specific entries in the OData service registry. Registering the ESJI_SD_SRV OData Service The Social Media ABAP Integration Library (SAIL) provides an OData service registry as a reuse component for SAP applications. The registry allows you to define a subset of OData services that can be exposed in a specific application context to external or on-demand platforms. In contrast to the notification filter, the service registry is not integrated into the Gateway or SAIL part of the notification process. It represents an independent service that applications can use. There are the following use cases: ● Supply OData URIs that are part of the notification. For example, OData URIs for addressing the annotation resource. ● Supply resource URL of the OData service for a subscription (base URL). The metadata link is implicitly derived from this base URL. Use the values in the following procedure when completing section 5.5.1, Defining OData Service Registry, of the SAIL guide. To register the ESJI_SD_SRV OData Service: 1. In Customizing for SAP NetWeaver, choose Notifications
Define OData Service Registry
Application Server
Basis Services
Collaboration
Gateway
(or run transaction CLB_GW_SRV_C).
2. On the Change View Services: Overview screen, select New Entries. 3. Enter the following: Table 23: CLB_GW_SRV_C new entries Field
Value
Bus. Object Type
The Business Object Type is mandatory to determine your business context.
Appl. Context
Enter ECC_OTC.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
137
Field
Value
Ext. Srv. Name
Enter ESJI_SD_SRV. The value must correspond to an entry in Customizing for the Gateway server (See Customizing for SAP NetWeaver under OData Channel
Gateway Service Enablement
Maintain Services
Service Development for Backend
).
OData services delivered by the SAP NetWeaver Gateway have the following format:
/sap/opu/odata/{NAMESPACE}/{SERVICE}/{COLLECTION}/ Request URI
Enter the static part of the OData service. OData services delivered by the SAP NetWeaver Gateway have the following format:
/sap/opu/odata/{NAMESPACE}/{SERVICE}/{COLLECTION}/ 4. Save your entries.
Note ○ The service registry can be evaluated by calling method IF_CLB_CUST_QUERIES~ GET_REGISTRY_SERVICES_BY_PTYPE( ). In this convenience method, the internal URI prefix for addressing the Gateway system is added from the information that has been maintained in the Customizing activity Server Settings through the Gateway server’s RFC destination. This means applications calling the method IF_CLB_CUST_QUERIES~ GET_REGISTRY_SERVICES_BY_PTYPE( ) must not add the URI prefix to the Request URI field of the view cluster. ○ Applications can also call IF_CLB_CUST_GW_SRV~GET_SERVICES_BY_PTYPE directly. This access class returns the Customizing content as it is, without adding the URI prefix. To maintain the ESJI_SD_SRV OData Service: In this step, you customize the ESJI_SD_SRV OData service. 1. Run transaction SM31. 2. Open view CLBV_APPLI_CONT, and check for the following entries: ○ ECC_OTC - ECC Order To Cash Scenario ○ SAIL - Social Media ABAP Integration Library (Default) 3. Open view CLBV_APPLI_PLATF, and check for the following entries: ○ Application ID: SAIL ○ Service Provider Type: Jam ○ Server: Jam productive 4. Open view CLBV_GW_SRV_C, and check for the following entries in the OData service registry. Table 24: OData service registry entries
138
Business Object Type
External Service Name
OData Request URI
BUS2032
ESJI_SD_SRV
/sap/opu/odata/sap/ESJI_SD_SRV;o=/
BUS2032/ANNO
ESJI_SD_SRV
/sap/opu/ODATA/sap/ESJI_SD_SRV;o=/ AnnotationCollection('x')/Content/$value
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Business Object Type
External Service Name
OData Request URI
BUS2037
ESJI_SD_SRV
/sap/opu/odata/sap/ESJI_SD_SRV;o=/
BUS2037/ANNO
ESJI_SD_SRV
/sap/opu/ODATA/sap/ESJI_SD_SRV;o=/ AnnotationCollection('x')/Content/$value
BUS2031
ESJI_SD_SRV
/sap/opu/odata/sap/ESJI_SD_SRV;o=/
BUS2031/ANNO
ESJI_SD_SRV
/sap/opu/ODATA/sap/ESJI_SD_SRV;o=/ AnnotationCollection('x')/Content/$value
KNA1_ESJI
ESJI_SD_SRV
/sap/opu/odata/sap/ESJI_SD_SRV;o=/
KNA1_ESJI/ ANNO
ESJI_SD_SRV
/sap/opu/ODATA/sap/ESJI_SD_SRV;o=/ AnnotationCollection('x')/Content/$value
LIKP
ESJI_SD_SRV
/sap/opu/ODATA/sap/ESJI_SD_SRV;o=/
LIKP/ANNO
ESJI_SD_SRV
/sap/opu/ODATA/sap/ESJI_SD_SRV;o=/ AnnotationCollection('x')/Content/$value
Note The variable in the table refers to the system alias of the back end you created earlier as described in section 3.3, Creating System Alias for Application Systems, of the SAIL guide Distributing SAP Gateway Notifications to SAP Jam . 5. In the Application Context field, enter ECC_OTC. 6. Open view CLBV_SERV_PTYPE_C, and enter the ODATA Service UUID of the services you have maintained in the view CLBV_GW_SRV_C.
Note ○ You can retrieve the OData Service UUID by double clicking on the entry maintained in view CLBV_GW_SRV_C. You can copy the service UUID and register the service provider type as Jam for the services you have added in the view CLBV_GW_SRV_C. ○ Similarly, open view CLBV_SRV_PTYPE_S, and verify that the service provider is Jam for the services maintained in the view CLBV_GW_SRV_S.
Set up required access and authorization These procedures establish the access and authorization configurations in SAP Jam that are required for the integration of SAP ECC (SD): ● Add a Trusted Certificate Authority [page 156] if your network uses unrecognized or self-signed HTTP with TLS or SSL certificates. ● Add an OAuth Client [page 158] to configure an authorized entry point for SAP ECC (SD) to initiate requests to the SAP Jam API in order to display SAP Jam content in SAP ECC (SD). ● Add SAML Trusted IDPs [page 161] to establish a trust relationship between SAP ECC (SD) and SAP Jam that allows SAP ECC (SD) to use SAP Jam identity and authorization information, which ensures that SAP
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
139
ECC (SD) users can only view the SAP Jam content that they are allowed to view when SAP Jam content is displayed in SAP ECC (SD). ● Configure SAP Jam as a SAML Local Identity Provider [page 163] to establish a trust relationship between SAP Jam and SAP ECC (SD) that allows SAP Jam to use SAP ECC (SD) identity and authorization information, which ensures that SAP Jam users can only view the SAP ECC (SD) content that they are allowed to view when SAP ECC (SD) content is displayed in SAP Jam.
Register SAP ECC (SD) as an External Application in SAP Jam Create an External Application entry to register your external SAP ECC (SD) application with SAP Jam. This procedure is the required step in SAP Jam for setting up a secure data connection with your external business application via the SAP NetWeaver Gateway. 1. Access the Admin console [page 11] and select External Applications from the left navigation sidebar. The Admin External Applications page is displayed. This initial page is a catalog of the external applications that have been configured for your organization's SAP Jam instance. 2. Click Add Application. A drop-down menu listing the available external application types is displayed.
Figure 101: Register SAP ECC (SD) in SAP Jam
3. Select SAP NetWeaver Gateway as the external application type that you want to add from the drop-down menu.
140
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
4. Type in a meaningful name in the Name text box, such as one that names the external application and/or its dedicated use.
Note This name will appear in the SAP Jam navigation sidebar and in other locations in SAP Jam, so it is important to make it something recognizable. 5. Select the Authentication Type. ○ Use the Common user option for testing and development purposes only.
Figure 102: Common user options
For the Common user option, set the following: 1. User name: This is the user name of the generic user account that will be used to access the service on behalf of all of the SAP Jam users. 2. Password: This is the password of the generic user account that will be used to access the service on behalf of all of the SAP Jam users. In the Common User authentication mode, all access from SAP Jam to the external data source will be made through an HTTP Basic authentication call using the provided user credentials. This is recommended only if you wish to expose all of the data in the data source to all SAP Jam users in your company. In other words, ensure that all the data exposed through the application can be considered "public" within your company. ○ Use the Per user option for production systems.
Figure 103: Per user options
For the Per user option, set the following: 1. OAuth 2.0 Client Id: Your organization's client ID with your OAuth 2.0 SSO provider.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
141
2. Secret: Your organization's OAuth 2.0 SSO secret. 3. Service Provider: The URL of your organization's OAuth 2.0 SSO provider, set in three parts: protocol, host, and port number. 4. Service Provider Name: The name of your organization's OAuth 2.0 SSO provider. 5. Scope: Your organization's company name as set in SAP Jam. This can be found in the General
Jam Admin
page.
In the Per-User authentication mode, SAP Jam authenticates the current user against the external application through the OAuth 2.0 SAML bearer assertion work flow. Since SAP Jam delegates its user authentication to SuccessFactors Platform, a trust relationship must first be established between the external application and the SuccessFactors Platform. Once this relationship is established, an OAuth client for SAP Jam is configured in the external application, using the SuccessFactors Platform IDP as the issuer of identity assertions for the client. When an SAP Jam user attempts to access the external data source, Jam will first post a SAML assertion on the user's identity to the external object in exchange for an OAuth token for that user. If successful, SAP Jam will use this OAuth token for all subsequent data access on behalf of that user. More detail can be found at: http://tools.ietf.org/html/draft-ietf-oauth-saml2-bearer-20 . 6. Set the NetWeaver Client Id. This is the three-digit login parameter for your NetWeaver client.
Figure 104: The Add External Application dialog box, latter options
7. Optionally, Select Trusted OAuth Client from the drop-down menu. This is required if you want the external application, which supplies the business records, to be able to post feed updates in SAP Jam. 8. Select the source of the SAML assertion provided by SAP Jam from the drop-down menu. The default for this option is SAP Jam, but you can select SuccessFactors Foundation. This should be set to match the source that you use to supply your user identity information. 9. Click Save. You are returned to the Jam Admin External Applications page, where the list of external applications that have been added is displayed, now including the external application that you have just registered.
Register SAP ECC (SD) business records in SAP Jam Once you have completed the required configuration to access your external application from SAP Jam, you need to further configure it by adding the particular business records objects that you want to access.
142
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
To register business records: 1. In the Admin console External Applications section, click on Action beside the OData application for which you want to add objects and select Manage Record Types from the context menu. The Manage Record Types screen is displayed for that application. 2. Click Add Record. The Add Object dialog box is displayed.
Figure 105: The Add Record Type dialog box
3. In the Name field, enter a meaningful name for the object that you want to add. 4. Enter the External Type and Annotation for the type of object that you want to add. The External Type must be the URL to OData metadata EntityType of the record that you are adding; the Annotation must be the URL to the OData annotations file, which describes how the incoming data will be laid out in a graphical element of the UI. These entries differ for each Application Type and record type that you want to display: For access to both SAP ECC (SD) and CRM business records, add the business records for each of the CRM object types—CorporateAccount, IndividualAccount, Opportunity, and Service Request—as shown in the "For
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
143
a CRM-only via NetWeaver Gateway integration" section immediately above. Add the following ECC (SD) business records to the same External Application for which you registered the CRM business record types: ○ For an ECC Customer Collection business record, enter: External Type: https:///sap/opu/odata/sap/ESJI_SD_SRV/$metadata#CustomerCollection Annotation: https:///sap/opu/odata/sap/ESJI_SD_SRV/AnnotationCollection('x')/ Content/$value ○ For an ECC Sales Order Collection business record, enter: External Type: https:///sap/opu/odata/sap/ESJI_SD_SRV/$metadata#SalesOrderCollection Annotation: https:///sap/opu/odata/sap/ESJI_SD_SRV/AnnotationCollection('x')/ Content/$value ○ For an ECC Invoice Collection business record, enter: External Type: https:///sap/opu/odata/sap/ESJI_SD_SRV/$metadata#InvoiceCollection Annotation: https:///sap/opu/odata/sap/ESJI_SD_SRV/AnnotationCollection('x')/ Content/$value ○ For an ECC Quotation business record, enter: External Type: https:///sap/opu/odata/CRMSWI01/CRMSMI_SRV/ $metadata#QuotationCollection Annotation: https:///sap/opu/odata/CRMSWI01/CRMSMI_SRV/AnnotationCollection('x')/ Content/ $value In the above examples, the External Type URLs are fixed except for the host domain. For the Annotation URLs, however, the actual URL will depend on where you have placed your annotation XML file; whatever the URL is, it must return the appropriate annotation file. 5. Select the language or languages that the imported record will be displayed in by clicking Add Language and checking the check box in front of each language that you want the data displayed in. The selected language or languages will appear above the Add Language button. Click the "X" on the right side of any language button to remove it. Note that the first language listed will always be the "Primary" language. 6. Select Import External Resources to import the data using the URLs listed above. SAP Jam will attempt to import the indicated resources, and it will display a message indicating the success or failure of the import, and information on the cause of a failure if one occurs and the cause can be determined. 7. Select Can be featured or unfeatured in groups to enable this option.
144
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
8. Select Can be primary object in top-level group to enable this option. 9. Select Can be primary object in subgroup to enable this option. 10. Select Filter Feed to enable users to add or remove feed entries of this object type. 11. Select Feed History to see the feed history independently of follows, which means: ○ If disabled, the user will only see the subset of feed items that were routed to their home feed; that is, they will only see items which had a distribution list that included them, or items in which the user was atmentioned. ○ If enabled, and if authorization is successful, the user will see the full feed for the object, including items that would otherwise not be visible to them. 12. Select Show Search to enable keyword searching in the business data browser. When rendering a list of External Objects, SAP Jam may also show a "search" box. If this option is selected, you can also set: ○ In the Hint field, you can enter a display string that tells the user what field the search is performed on. ○ In the Property field, you can enter the actual OData property name that the search is performed on. Internally, Jam will make a [GET] request to the OData collection for the given object type, using an OData $filter expression on the Property specified in the configuration screen. For example: [GET] /ObjectCollection?$filter=startswith('text', Property) 13. Select Can be mentioned in feed posts to enable this option. If this option is selected, you can also set: ○ Primary (Search) Property: enter the OData property name that an at-mention look-up will search for. ○ Secondary (Display) Property: enter the OData property name that an at-mention look-up will display. 14. Once you have configured the record to your satisfaction, click Save. You are returned to the Record Types catalog, and the record type that you just added will be listed in the table.
Note Next: You can now, optionally, add an External Application Object Filter [page 153] to narrow the range of data shown in a particular external application data object. Additionally, you can now, optionally, add an External Application Object Sort Order [page 154] to set the order in which the external data is arranged in a particular external application data object. If you do not want or need to add Filters or Sort Fields to your External Application Objects, you can proceed to Configure access to business records in SAP Jam [page 155].
4.2.4 Integrate SAP Cloud for Customer Integration of SAP Jam with your SAP Cloud for Customer solution enables cross-application collaboration using the SAP Jam feed, and allows users to feature SAP Cloud for Customer accounts, opportunities, products, and service tickets in SAP Jam groups.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
145
Prerequisites SAP Jam: An SAP Jam tenant has been provisioned for your company, and you have been given administrator access. You know how your users were provisioned for your SAP Jam system. SAP Cloud for Customer: Initial setup and configuration has been performed in tenant, as per the SAP Cloud for Customer Administrator Guide. You have administrator access and know how your users were provisioned for your SAP Cloud for Customer system. Cross-system authentication: If your user IDs or your user email addresses are identical in both SAP Jam and SAP Cloud for Customer (C4C), then you can use dynamic onboarding and there is no explicit user mapping needed. If neither of these conditions are true, the you will not be able to use dynamic onboarding and explicit user mapping will be required. While the SAP C4C user ID is used as the logon user ID, the SAP Jam user ID is not. The SAP Jam user ID must be in uppercase and less than 40 characters for this integration to work without explicit user mapping. Using users' email addresses as the key identifier means that your SAP C4C and SAP Jam are using the email address for back-end authentication during API calls. It does not necessarily mean users are logging in with their email address. Integration Steps: To successfully integrate SAP Jam with SAP Cloud for Customer, please refer to the document INTEGRATION: SAP Cloud for Customer + SAP Jam, which can be found in https://websmp202.sap-ag.de/ cloud4customer . This document contains complete instructions for integrating SAP Cloud for Customer with SAP Jam.
4.2.5 Integrate SuccessFactors Learning In your SuccessFactors HCM Suite, gather the OAuth token information that you will need to enter in your SAP Jam configuration.
Gather SuccessFactors Learning OAuth token information The first procedure in setting up your SuccessFactors Learning integration with SAP Jam is to configure the SuccessFactors HCM Suite to work with your SAP Jam service. To configure the SuccessFactors HCM Suite, do the following: 1. Log in to the SuccessFactors HCM Suite and select Admin Center from the main menu. 2. Click the Learning icon in the Company Processes & Cycles panel, and select Learning Administration from the context menu. The Learning Administration section is displayed. 3. Enable the integration of SuccessFactors LMS and SAP Jam by clicking the System Admin icon from the top menu bar, expanding the Configuration section in the left sidebar, and click System Configuration. The LMS_ADMIN configuration file is displayed.
146
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Figure 106: SuccessFactors Learning Administration > System Admin > Configuration > System Configuration
4. Search in the LMS_ADMIN configuration file for "jamIntegrationEnabled", ensure that it is set to "true", and click Apply Changes. 5. Gather the OAuth information that will be required for your SAP Jam configuration, which is also available in the System Admin Configuration section by clicking OAuth Token Server. A page of the OAuth Token Server information is displayed.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
147
Figure 107: SuccessFactors Learning Administration > System Admin > Configuration > OAuth Token Server
6. Click the Generate a new client secret button. A new field is displayed underneath the Client ID field, labeled Newly Generate Client Secret.
Note You can generate a new client secret at any time, but it is the last generated client secret that you must copy and paste into your SAP Jam configuration. 7. Copy and save the following information to add to your SAP Jam configuration: ○ Client ID ○ Newly Generated Client Secret Ensure that you fully copy the Client ID and the Newly Generated Client Secret. The text must be copied exactly, without any spaces before or after.
Register SuccessFactors Learning as an External Application in SAP Jam Create an External Application entry to register your external application with SAP Jam. This procedure is the required step in SAP Jam for setting up a secure data connection with your external business application, including integrations via SAP NetWeaver Gateway, via SAP HANA Cloud Platform, with SAP Cloud for Customer, with a Third Party OData Source, or with SuccessFactors Learning.
148
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
1. Access the Admin console [page 11] and select External Applications from the left navigation sidebar. The Admin External Applications page is displayed. This initial page is a catalog of the external applications that have been configured for your organization's SAP Jam instance. 2. Click Add Application. A drop-down menu listing the available external application types is displayed.
Figure 108: Register SuccessFactors Learning in SAP Jam
3. Select the SuccessFactors Learning option. The External Application, add a SuccessFactors Learning application form is displayed.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
149
Figure 109: External Application, add a SuccessFactors Learning application form
4. Type in a meaningful name in the Name text box, such as one that names the external application and/or its dedicated use.
Note This name will appear in the SAP Jam navigation sidebar and in other locations in SAP Jam, so it is important to make it something recognizable. 5. Set the following: 1. OAuth 2.0 Client Id: Enter the value from the OAuth Token Server page's Client ID field. 2. Secret: Enter the value from the OAuth Token Server page's Newly Generated Client Secret field. 3. Service Provider: Enter the fully-qualified domain name of your SuccessFactors Learning service. For example, e0363.scdemo.successfactors.com One way to determine this URL is to log in to SuccessFactors Learning on the web. Using Internet Explorer browser, right click on the page and select "View Properties", and copy the base URL for the page; in Chrome, right click "View frame info" and copy the base URL for the page. The base URL is everything after the protocol https:// and before the next slash, which indicates the path. 4. Service Provider Name: This field is pre-filled and is not editable. SAP Jam establishes a trust relationship with SuccessFactors Learning via OAuth client certificate. SAP Jam authenticates the current user against SuccessFactors Learning so they can view learning data in SAP Jam. 6. Click Save. You are returned to the Jam Admin External Applications page, where the list of external applications that have been added is displayed, now including the external application that you have just registered.
150
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Register the SuccessFactors Learning business record in SAP Jam Once you have completed the required configuration to access your external application from SAP Jam, you need to further configure it by adding the business records that you want to access. For SuccessFactors Learning, only the "Item" business record type is currently supported. To register business records: 1. In the Admin console External Applications section, click on Action beside the OData application for which you want to add objects and select Manage Record Types from the context menu. The Manage Record Types screen is displayed for that application. 2. Click Add Record. The Add Record Type dialog box is displayed.
Figure 110: The Add Record Type dialog box
3. In the Name field, enter a meaningful name for the object that you want to add. 4. Note that the External Type and Annotation fields are pre-filled with static values and are read-only. 5. Add Language: currently, only English (EN) is supported. 6. Select Import External Resources to import the data using the URLs listed above.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
151
Note To ensure a successful import of external resources, you—as the logged in Jam admin—must have a corresponding account in SuccessFactors Learning, and you must also have access to the learning catalog. SAP Jam will attempt to import the indicated resources, and it will display a message indicating the success or failure of the import, and information on the cause of a failure if one occurs and the cause can be determined. 7. Select Can be featured or unfeatured in groups to enable this option. 8. Select Can be primary object in top-level group to enable this option. 9. Select Can be primary object in subgroup to enable this option. 10. Select Filter Feed to enable users to add or remove feed entries of this object type. 11. Select Feed History to see the feed history independently of follows, which means: ○ If disabled, the user will only see the subset of feed items that were routed to their home feed; that is, they will only see items which had a distribution list that included them, or items in which the user was atmentioned. ○ If enabled, and if authorization is successful, the user will see the full feed for the object, including items that would otherwise not be visible to them. 12. Select Show Search to enable keyword searching in the business data browser. When rendering a list of External Objects, SAP Jam may also show a "search" box. If this option is selected, you can also set: ○ In the Hint field, you can enter a display string that tells the user what field the search is performed on. ○ In the Property field, you can enter the actual OData property name that the search is performed on.
Note For SuccessFactors Learning, only "Title" is supported as the property of a search. Internally, Jam will make a [GET] request to the OData collection for the given object type, using an OData $filter expression on the Property specified in the configuration screen. For example: [GET] /ObjectCollection?$filter=startswith('text', Property) 13. Note that the "Can be mentioned in feed posts" option is not currently supported for SuccessFactors Learning integrations.
Note Next: Unlike other business record integrations, a SuccessFactors Learning integration does not allow you to set filtering, as the filtering is already done for you, giving access to SuccessFactors Learning "Instructor-Led", "Online", and "Other Learning" courses. Similarly, setting a sort order in which the external data is arranged in a particular external application data object has no relevance. As you do not set Filters or Sort Fields for your External Application Objects, you should proceed to Configure access to business records in SAP Jam [page 155].
152
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
4.2.6 Configure a business record filter This configuration sets a filter that narrows the range of data that is displayed in a business record. This allows you to configure several instances of the same business record, each displaying a different set of data from that business record and each of which can then be used in different groups. Note that some pre-configured External Application business records include predefined filters. To add an business record filter: 1. As an SAP Jam administrator, in the Jam Admin External Applications page, with the list of external applications displayed, click on Action beside the external application to which you want to add an external object filter, and select Manage Record Types from the context menu. The Manage Record Types page is displayed. 2. Click Filters beside the object type to which you want to add a filter. The Manage () Filters page is displayed. 3. Click New Filter. The Manage () Filters add a new filter page is displayed.
Figure 111: Add a filter to a business record
4. In the Name field, enter a meaningful name for the filter that you want to add. 5. In the Filter field, enter the filter expression that you want to use. 6. Optionally, you can Enable the filter, which will make it immediately available. 7. When you are done, click Submit. You are returned to the Manage () Filters panel. 8. In the Manage () Filters panel, you can do the following: ○ Click true (or false) in the Enabled column to toggle the filter's enabled status. ○ Click Show Filter to view the text of the filter. ○ Click Delete Filter to remove the filter, including from future use. ○ Click Edit Filter or to modify an existing filter.
Note Next:
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
153
You can now, optionally, add an External Application Object Sort Order [page 154] to set the order in which the external data is arranged in a particular external application data object. If you do not want or need to add Sort Fields to your External Application Objects, you can proceed to Configure access to business records in SAP Jam [page 155].
4.2.7 Configure a business record sort order Each business record type contains a set of attributes that can be selected as the criteria by which the rows of data are sorted in SAP Jam. To set a business record sort order: 1. As an SAP Jam administrator, in the Jam Admin External Applications page, with the list of external applications displayed, click on Action beside the external application for which you want to set sort fields, and select Manage Record Types from the context menu. The Manage Record Types page is displayed. 2. Click Sort Fields beside the object type to which you want to set the sort fields. The Edit Record Type dialog box is displayed.
Figure 112: Add a sort order for a business record
3. Click Show Fields Hint to view the list of available fields. A list of the available fields is displayed. 4. Copy and past the fields from the list of those available into the Sort Fields text box in the order in which you want them displayed. 5. When the sort fields are listed in the order in which you want the business records sorted, click Update. You are returned to the Manage Record Types page.
Note Next: You can now proceed to Configure access to business records in SAP Jam [page 155].
154
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
4.2.8 Configure access to business records in SAP Jam Once you have properly registered your external application, created any required annotations files, and registered your business records, your external data will be available for use in SAP Jam. OData-based applications are listed in the Business Records page. You can also configure SAP Jam to access your organization's external content from other locations within SAP Jam. ● To create a group with a business record as its "Primary Object": 1. In your SAP Jam Home page, click Business Records, and click the name of the type of business record. A list of business records of that type is displayed. 2. In the list of business records of that type, hover over the name of the particular business record that you want to set as the primary object of a new group. An information and actions dialog box is displayed for that business record 3. Click Create Group at the bottom of that dialog box. A Create a Group dialog box is displayed. 4. Set the options that you want for the group, including: ○ Select the group template. ○ Enter a group name ○ Optionally, enter a description of the group. ○ Click to select the Group Permissions. ○ Click options beside the group permissions type for additional settings. ○ Ensure that the Activate this group now checkbox is selected if you want to allow immediate use of the group. ○ Click Create to create the group. ● To "feature" a business record in a group: 1. In your SAP Jam Home page, click Business Records, and click the name of the type of business record. A list of business records of that type is displayed. 2. In the list of business records of that type, hover over the name of the particular business record that you want to set as the primary object of a new group. An information and actions dialog box is displayed for that business record. 3. Click Feature in... at the bottom of that dialog box. A Feature in another group dialog box is displayed. 4. Enter the name of the group in which you want to feature the selected business record and click OK. The selected business record is "featured" in the specified group. ● To have a business record appear as being "related" to a "Primary" or "Featured" business record: This is done automatically, but it does require that the UI.LineItem Term has been developed. Your Document Repository access configuration is now complete. Users can access the newly integrated business records from any of the above listed SAP Jam locations that you configured.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
155
4.3
Access and Authorization overview
This section explains the technologies used to establish SAP Jam integration access and authorization. The following access and authorization work flows are described: ● Use SAP Jam's Admin External Applications Trusted Certificate Authorities section to configure access to web-based applications and services within your organization if unrecognized or self-signed certificates are used. ● Use SAP Jam's Admin OAuth Clients by configuring an OAuth Client.
section to allow an external application to access the SAP Jam API
● Use SAP Jam's Admin SAML Trusted IDP section to allow an external application to access SAP Jam user ID and authorization information so that it will display only the material that a user is authorized to view when SAP Jam features are integrated into the external application. ● Use SAP Jam's Admin SAML Local Identity Provider section to allow SAP Jam to access an external application's user ID and authorization information so that it will display only the material that a user is authorized to view when they view pages where integrated external application business records are displayed in SAP Jam. ● Use SAP Jam's Admin identity provider.
SAML Trusted IDP
section to configure an external service as your primary user
4.3.1 Add a Trusted Certificate Authority If your organization's network uses unrecognized or self-signed certificates, then you must perform the following steps for SAP Jam to accept the certificate, which will then allow SAP Jam access to the external application data. Note that this can also be a good way to establish a secure connection to your document repositories via CMIS.
Note Adding a trusted certificate authority disables the use of certificates in the default Certificate Authority store. Therefore, if you add a trusted certificate authority, you must manually add all required Certificate Authorities in this section of the Admin console. 1. To find the certificate to add to SAP Jam, you must open a page of the external application that you are trying to integrate into SAP Jam in your browser and view the certificate. The way that you do this will vary with each browser, so you must refer to your browser's documentation for instructions. 2. Export the certificate into Base-64 encoded X.509 (.cer) format. 3. Open the exported certificate in a text editor and copy the entire certificate, including the "Begin Certificate" and "End Certificate" lines. 4. Access the Admin console [page 11], select External Applications from the left navigation sidebar, and click Trusted Certificate Authorities at the top of the page. The Trusted Certificate Authorities dialog box is displayed. 5. Paste the copied certificate into the Trusted Certificate Authorities text box, and click Submit.
156
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
This registers the unrecognized certificate with SAP Jam, which will enable your connection to your external application.
Figure 113: The add Trusted Certificate Authorities form
Note Next: If you are integrating business records, proceed with one of the following: ● If you will be using the business records displayed in SAP Jam interactively, that is, if you want to be able to make changes to the business data displayed in SAP Jam and have those changes communicated back to the source external business application, then you must enable either OAuth or SAML authorizations by performing one or both of the following procedures: ○ Proceed to Add an OAuth Client [page 158] if the connections from the external application to SAP Jam require OAuth authorization. ○ Proceed to Add SAML Trusted IDPs [page 161] if the connections from the external application to SAP Jam require SAML authorization.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
157
4.3.2 Add an OAuth Client To authorize an external application to access the SAP Jam API, you must register the external application as an OAuth client in the
Jam Admin
OAuth Clients
section of the SAP Jam Admin console.
To manage OAuth Clients, do the following: 1. Access the Admin console [page 11] and select OAuth Clients from the left navigation sidebar. The
Jam Admin
OAuth Clients
section is displayed.
Figure 114: 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 is displayed.
158
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Figure 115: Register a new OAuth Client form
1. In the Name field, enter a meaningful name that will allow SAP Jam admins to recognize what the client is. 2. From the Feed Filtering drop-down menu, select either none or SAP CRM. 3. In the Integrator URL field, enter the URL to the client application's API metadata. 4. In the Callback URL field, enter the callback URL for the client application's API calls. 5. In the Support URL field, enter the support URL for the client application's API. 6. In the X509 Certificate (Base64) text box, enter the Transport Layer Security (TLS; a.k.a. SSL) public key certificate string for the client application's API access. 7. 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. An OAuth Client: page is displayed.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
159
Figure 116: View the OAuth Client page
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: page. The Edit your OAuth Client page is displayed, 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.
Note Next: If you are integrating business records into SAP Jam, you should do one of the following: ● Proceed to Add SAML Trusted IDPs [page 161] you will be using the business records displayed in SAP Jam interactively, that is, if you want to be able to make changes to the business data displayed in SAP Jam and have those changes communicated back to the source external business application, and the external application requires SAML authorization.
160
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
4.3.3 Add SAML Trusted IDPs To allow an external application to access SAP Jam user ID and authorization information so that it will display only the material that a user is authorized to view when SAP Jam features are integrated into the external application, you must register the external application as a SAML trusted Identity Provider (IDP). To manage SAML Trusted IDPs, do the following: 1. Access the Admin console [page 11] and select SAML Trusted IDPs from the left navigation sidebar. The
Admin
SAML Trusted IDPs
section is displayed.
Figure 117: SAML Trusted IDPs catalog
This page presents a catalog of previously configured SAML Trusted IDPs, with UI controls that allow you to View, Edit, or Delete existing SAML Trusted IDPs, or to register a new identity provider (Register your identity provider). 2. To add an identity provider, click Register your identity provider at the upper right corner of the page. The Register a new SAML Trusted Identity Provider page is displayed.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
161
Figure 118: Register a new SAML Trusted Identity Provider form
1. Optionally, in the Metadata File field, enter the path to a downloaded SAML IDP metadata (configuration) file or click Browse and navigate to the location of that file. If you have such a file and perform this step, it will fill the configuration of this page and no further setting changes should be required, so you can proceed to the final step of this procedure. 2. In the IDP ID field, enter the identifier of the external identity provider. 3. In the Single Sign-On URL field, enter the URL used for single sign-on (SSO) with the identity provider (IDP). 4. In the Single Log-Out URL field, enter the URL used for single log-out (SLO) with the identity provider (IDP).
162
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
5. In the Default Name ID Format field, enter what name ID format is to be used in an authentication request. 6. 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. 7. From the Allowed Assertion Scope drop-down menu, select either Disable assertions or Users in my company. 8. In the X509 Certificate (Base64) text box, enter the Transport Layer Security (TLS) public key certificate string for the client application's API access. 9. When all of the above settings are complete, click Save 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 view the information for a SAML Trusted Identity Provider, click View on the row for the SAML Trusted Identity Provider that you want to view. A SAML trusted IDP: page is displayed. You can either modify the information by clicking Edit or return to the SAML Trusted IDPs page by clicking Back. 4. To edit a SAML Trusted IDP record, either click Edit in the SAML Trusted IDPs page or in the SAML trusted IDP: page. The Edit your SAML Trusted Identity Provider page is displayed, 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.
4.3.4 Configure SAP Jam as a SAML Local Identity Provider This procedure configures SAP Jam to allow it to access an external application's user ID and authorization information so that it will display only the material that a user is authorized to view when they view pages where integrated external application business records are displayed in SAP Jam. To configure SAP Jam as a SAML identity provider, do the following: 1. Access the Admin console [page 11] and select SAML Local Identity Provider from the left navigation sidebar. The
Admin
SAP Jam Administrator Guide Integrations
SAML Local Identity Provider
page is displayed.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
163
Figure 119: SAML Local Identity Provider page, blank
The Issuer field contains the URI that shows the issuer's identity, in this case, your company's SAP Jam instance. 2. Click Generate Key Pair to automatically fill the Signing Private Key and X509 Certificate text boxes.
164
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Figure 120: SAML Local Identity Provider page, filled
The two text boxes are automatically filled with the signing private key and the X509 certificate (in base64 format), that are required. 3. Copy the information in these three fields to configure SAP Jam as the SAML identity provider in an external application to provide SAP Jam users with SSO access to the external applications.
4.4
Integrate document repositories
There are three types of integrations that will display the content of document repositories in SAP Jam: ● CMIS: Content Management Interoperability Services (CMIS) is an open standard that allows different content management systems to inter-operate across a network. CMIS-compatible document repositories include: ○ SharePoint 2013 ○ SharePoint 2010 ○ Alfresco One 4.2 ○ SAP Extended ECM by OpenText ○ SAP Mobile Documents CMIS-compatible document repositories can only be accessed by using a common user account for credentials. ● Office 365 SharePoint Online Sites: This is a non-CMIS integration that uses Microsoft Azure's cloud platform.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
165
Office 365 SharePoint Online Site libraries can only by accessed using per-user credentials. ● Box: This is a non-CMIS integration that provides access to your organization's Box account as a document repository. While Box supports sharing files of many types, it is the document files that are the focus of SAP Jam's Box integration.
Note SAP Jam uses a common user account for credentials when accessing a CMIS repository, only read-only scenarios are supported. For example, uploading a document to a CMIS repository from SAP Jam is not supported. You must provide internet access to your CMIS repository for SAP Jam. To ensure that the configuration of this access is secure, SAP strongly advises that you take the following precautions: ● Ensure that you use an HTTPS with TLS connection. ● Ensure that you Add a Trusted Certificate Authority [page 156] required to access the CMIS repository from SAP Jam. ● Configure a reverse proxy to provide SAP Jam with access to your document repository, and to deny access from other clients.
Procedures required to integrate document repositories into SAP Jam The procedures for integrating business records are listed below, and are illustrated in the diagram that follows: 1. Perform any required preparations on the document repository application. This mostly involves establishing trusted data communications with SAP Jam. 2. Add a Trusted Certificate Authority if your organization requires the use of unrecognized or self-signed certificates. This allows your browser to use the HTTPS/TLS connection required to access the document repository's data without obstruction. 3. Register the document repository or library application in SAP Jam. This mostly involves establishing trusted data communications with the external application. 4. Register the individual document repositories or libraries that you want to expose for viewing in SAP Jam. 5. Optionally, federate SAP Jam documents search results into SharePoint searches. Note that this is only available for SharePoint 2010 and 2013 integrations. 6. Add a document repository or library to a SAP Jam group and your group members will be able to view and discuss the external documents in SAP Jam.
166
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Figure 121: Integrating document repositories work flow
Organization and coverage of these procedures in the SAP Jam Administrator Guide Procedure 1 (Perform any required preparations), procedure 3 (Register the external document repository application in SAP Jam), and procedure 4 (Register the individual document repositories) in the above diagram are documented together in per-application integration pages, as these sections involve substantial applicationspecific information, and they are most clearly dealt with by combining these instructions in the following sections: ● Integrate SharePoint 2010 or 2013 [page 171] ● Integrate Alfresco One 4.2 [page 179] ● Integrate SAP Extended ECM by OpenText [page 182] ● Integrate Office 365 SharePoint Sites [page 186] ● Integrate SAP Mobile Documents [page 190] ● Integrate Box [page 195] ● Integrate Google Drive [page 201] The procedure for configuring access, which is procedure 2 (Add a Trusted Certificate Authority) in the above diagram, is documented as a subsection of the preceding section on access and authorization: ● Add a Trusted Certificate Authority [page 156]
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
167
Procedure 5 (Federating SAP Jam search results into SharePoint searches) is documented in the following section and its three subsections: ● Federate SAP Jam search results into SharePoint searches [page 174] ○ Create an OpenSearch client in SAP Jam [page 175] ○ Configure SAP Jam as a federated search source in SharePoint [page 176] ○ Add the SAP Jam security certificate to SharePoint [page 177] Now that all of the configuration steps are done, users can add business records to their groups, procedure 6 (Add the document repository or library to a SAP Jam group), which is described in two sections, as the instructions are slightly different: ● Access document repositories in SAP Jam groups [page 203] ● Access Office 365 Online Sites in SAP Jam groups [page 204]
A preview of the Admin UI screens and the information required to integrate External Applications This section provides a quick preview of the SAP Jam Admin console pages in which the configuration procedures are performed, and the information that is required in those pages, for the integration steps described in the perapplication integration pages listed above (procedures 4 and 6). These SAP Jam Admin console pages and the required information to fill these forms are as follows: ● After the required configuration is done on the external document repository application, that application must be registered in SAP Jam by Accessing the Admin console [page 11] and selecting External Applications from the left navigation sidebar, clicking Add Application, and then selecting the type of application that you want to integrate from the drop-down menu.
168
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Figure 122: Register the document repository application in SAP Jam
The available options for adding a business records application are: ○ SharePoint 2013 ○ SharePoint 2010 ○ Alfresco One 4.2 ○ SAP Extended ECM by OpenText ○ SAP Mobile Documents ○ Microsoft Office 365 ○ Box ○ Google Drive When you select one of the above-listed document repository integration options, a page is displayed showing a form for the fields and options required to establish a trusted data exchange between SAP Jam and either the business application being integrated or the intermediary platform that is hosting the business application. There is some variation in the fields of information that are required for these different options, which are shown in the following diagram.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
169
Figure 123: Add Application form options
● You must also Register each of the business records that you want to expose for use in SAP Jam. This page is accessed by clicking on the Action menu in the row for the application in the External Applications main page that you are integrating, and selecting Manage Record Types from the drop-down menu, and then clicking Add Record Type.
Figure 124: The Add CMIS Repository or Document Library page
The options vary for some applications, which will be covered in the per-application integration instructions.
Note Next: If you are ready to begin to integrate an external application's business records into SAP Jam, proceed to the appropriate instructions: ● Integrate SharePoint 2010 or 2013 [page 171] ● Integrate Alfresco One 4.2 [page 179] ● Integrate SAP Extended ECM by OpenText [page 182] ● Integrate Office 365 SharePoint Sites [page 186] ● Integrate SAP Mobile Documents [page 190] ● Integrate Box [page 195] ● Integrate Google Drive [page 201]
170
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
4.4.1 Integrate SharePoint 2010 or 2013 Using the SAP Jam SharePoint Connector alternative There is an alternate approach to integration to the advised SharePoint CMIS integration described in these pages. The alternative is to install and configure the SAP Jam SharePoint Connector on the SharePoint server. Both approaches require that configuration steps be performed in both SharePoint and SAP Jam, although installation is simpler for the CMIS integration. The CMIS integration is advised because it is more suitable for the common use case of organizations that have elected to use SharePoint as their document repository, but who still want SharePoint documents to be available in SAP Jam to facilitate discussions as an enterprise social networking application. Also, because of the suitability of CMIS integration, the SAP Jam SharePoint Connector is no longer being actively developed. Integration using the SAP Jam SharePoint Connector is still available. If you decide that you would like to try to integrate SharePoint and SAP Jam using the SAP Jam SharePoint Connector, please contact your SAP Customer Support representative and ask for the SAP Jam SharePoint Connector installer and the SAP Jam SharePoint Connector Installation Guide.
Prepare for a SharePoint 2010 or 2013 integration You must provide internet access to your CMIS repository for SAP Jam to be able to access it. The SharePoint document repositories are accessed using Common User authentication. This means that all access from SAP Jam to the external data source is made through an HTTP Basic authentication call using these provided user credentials. This is recommended only if you wish to expose all of the data in the data source to all SAP Jam users in your company. In other words, ensure that all the data exposed through the application can be considered "public" within your company. To ensure that the configuration of this access is secure, SAP strongly advises that you take the following precautions: ● Ensure that you use an HTTPS with TLS connection. ● Ensure that you Add a Trusted Certificate Authority [page 156] required to access the CMIS repository to SAP Jam. ● Configure a reverse proxy to provide SAP Jam with access to your document repository, and to deny access from other clients. Your SharePoint farm administrator must set up at least one generic user account for SAP Jam to provide and control access to SharePoint documents. This common user must be included in the Access Control Lists for SharePoint's document libraries, with read access rights. For SharePoint deployments behind the corporate firewall, your IT department must open a port in your corporate firewall to enable this integration. For SharePoint 2010, a CMIS-based integration with SAP Jam requires that the Microsoft CMIS Connector must be installed. This is included in SharePoint 2013. Details for how to install the Microsoft CMIS Connector in SharePoint 2010 are available at: http://technet.microsoft.com/en-us/library/ff934619(v=office.14).aspx
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
171
Register your SharePoint 2010 or 2013 application in SAP Jam Create an External Application entry to register your SharePoint application with SAP Jam. This procedure establishes a secure data connection between SAP Jam and your SharePoint application. 1. Access the Admin console [page 11] and select External Applications from the left navigation sidebar. The Admin External Applications section is displayed. This initial page is a catalog of the external applications that have been configured for your organization's SAP Jam instance.
Figure 125: Register the document repository application in SAP Jam
2. Click Add Application and select SharePoint 2013 or SharePoint 2010 from the drop-down menu. The form for adding a new external application is displayed. 3. In the Name text box, type in a meaningful name. This name will appear in the SAP Jam navigation sidebar and in other locations in SAP Jam, so it helps to make it something recognizable to your users. 4. In the User name text box, enter the user name of the common user account that will be used to access the service on behalf of all SAP Jam users. 5. In the Password text box, enter the password of the common user account that will be used to access the service on behalf of all SAP Jam users. 6. In the Service Document URL text box, enter the URL for the site, or site collection, that is housing the document library or libraries that are to be integrated into SAP Jam. See the notes below.
172
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
○ For a SharePoint 2013 integration: In SharePoint 2013, you can use the getRepositories call to obtain the unique IDs of repositories for a given SharePoint site, so the Service Document URL must be in a form similar to this: https:///_vti_bin/cmis/rest?getRepositories ○ For a SharePoint 2010 integration: Because SharePoint 2010 doesn't support getRepositories, the repository ID must be embedded in the URL, so the Service Document URL must be in a form similar to this: https:///_vti_bin/cmis/rest/ab3c2eff-af65-4266bf37-3fcfab2f3273?getRepositoryInfo To get the repository GUID for a SharePoint 2010 integration, go to
Site Settings
Site Library and
Lists in SharePoint, click on the repository that you want, and note the GUID in the URL. This GUID must be set in all lower case in the Service Document URL.
Note For a SharePoint 2010 integration, you can click the ellipsis button to open a dialog box that aids in setting the URL in the correct format by presenting a componentized entry form. 7. Click Save. You are returned to the Jam Admin External Applications page, where the list of external applications that have been added is displayed, now including the external application that you have just registered.
Note If your organization uses unrecognized or self-signed certificates for network access, or if you want to ensure a more secure connection to your document repository, you must add a Trusted Certificate Authority [page 156].
Note At this point, if you have any trouble establishing a connection between SAP Jam and your SharePoint server, you should work through the procedure Troubleshoot CMIS Connections [page 203].
Register the SharePoint document libraries Once you have completed the required configuration to access your SharePoint application from SAP Jam, you need to further configure it by adding the specific document libraries that you want to access. 1. Access the Admin console [page 11] and select External Applications from the left navigation sidebar. The
Admin
External Applications
section is displayed.
2. Click on Action beside the SharePoint repository application for which you want to add access to document repositories and select Manage CMIS Repositories from the context menu. The : CMIS Repositories screen is displayed. 3. Click Add Repository and select either Use Custom Setting or Select from List. Depending on the control that you selected, one of the following dialog boxes is displayed: ○ The Add CMIS Repository text entry dialog box ○ The Add CMIS Repository list selection dialog box
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
173
Figure 126: The Add CMIS Repository or Document Library page
4. Set the document repository information by doing one of the following: ○ In the Add CMIS Repository text entry dialog box, enter the Name of the repository and the Repository Id. ○ The Name is the name that will appear in the group navigation pane once group administrators set up access to a given repository, so make this a name that will be recognized by users in your organization. ○ The Repository Id is found by navigating to the document repository, and looking at the browser URL. The unique ID is found within the URL string. CMIS is available on any on-premises SharePoint 2013 site only after the Content Management Interoperability Services (CMIS) Producer feature is activated in the Manage Site Features section of Site Settings. For SharePoint 2010 integrations, navigate to Site Settings Site Library and Lists click on the repository you want, and note the GUID in the URL. Ensure that you use a lowercase version of the GUID for the Repository Id. ○ In the Add CMIS Repository list selection dialog box, click the CMIS repository that you want to add. The listed repositories are retrieved from the CMIS server's base URL. Only the SharePoint 2013 option will display multiple repositories. 5. Click Create. The Add CMIS Repository dialog box will close, and the added repository will appear in the CMIS Repositories page.
Note Next: Once you have completed the registration of the document repositories or libraries that you want to be able to access from within SAP Jam, you can proceed to Federate SAP Jam search results into SharePoint searches [page 174]. If you do not choose to federate your search results, you can proceed to Access document repositories in SAP Jam groups [page 203].
4.4.2 Federate SAP Jam search results into SharePoint searches It is possible to federate SAP Jam Search results into OpenSearch-compliant search results. OpenSearchcompliant document repositories include SharePoint 2010 and SharePoint 2013. This section documents the
174
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
procedures required to federate SAP Jam search results into Microsoft SharePoint. Note that these procedures require administrator privileges on both the SAP Jam and SharePoint systems. For more information on OpenSearch, see the OpenSearch web site
.
Note Authentication of an OpenSearch client with SAP Jam is done through a company-wide, single user username and password; therefore, only the company-wide information available in SAP Jam "public groups" is available in the federated search results. To federate SAP Jam search results into SharePoint searches, perform the following three procedures.
4.4.2.1
Create an OpenSearch client in SAP Jam
The first task in setting up federated search with your Microsoft SharePoint server is to create an OpenSearch Client entry in SAP Jam, which is described in the following procedure: 1. Access the Admin console [page 11] and select OpenSearch Clients from the left navigation sidebar. The Admin OpenSearch Clients Clients, one client per row.
section is displayed, showing a catalog of the existing OpenSearch
2. Click Add Client below the list of existing OpenSearch Clients. A new row is added below the existing OpenSearch Clients. It contains a set of three text boxes.
Figure 127: OpenSearch Clients catalog
3. In the Description text box, enter a descriptive name for the client that you want to add, such as "SharePoint 2010 Documents". 4. In the Password text box, enter the password that you want the SharePoint system to use to access the SAP Jam OpenSearch data. 5. In the Confirm text box, re-enter the password that you entered in the previous step. Record this password for later use.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
175
6. Click Save. The row with the new OpenSearch client information is saved and displayed in the catalog along with any existing OpenSearch clients, a random string is generated for the username, and that username is displayed in the Username column of the OpenSearch Clients table. 7. Record the username string from the newly created OpenSearch client instance, along with the password that you set for use in SharePoint. 8. Click Download .osdx and save the file on your local drive.
Note Next: You should now send the generated username, the password that you set, and the OSDX file that you downloaded to your organization's SharePoint administrator. Your organization's should now Configure SAP Jam as a federated search source in SharePoint [page 176].
4.4.2.2
Configure SAP Jam as a federated search source in SharePoint
To perform this task, you must have received three things from your organization's SAP Jam administrator: ● A generated username to use in the email address for access to the SAP Jam service's OpenSearch data ● The password for that user ● An OSDX file to use in configuring your organization's SAP Jam service as a source for OpenSearch federated searches The next task in setting up federated search with your Microsoft SharePoint server is to configure SAP Jam as a Federated Search source in SharePoint, which is described in the following procedure: 1. On your organization's SharePoint server, as an administrator, open the Application Management
Manage Service Applications
Central Administration
Search Service Application
Federated
Locations page. The SharePoint Federated Locations page is displayed.
Figure 128: SharePoint Central Administration > Search Service Application > Manage Federated Locations
176
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
2. Click Import Location. The SharePoint Import Federated Location page is displayed.
Figure 129: SharePoint Central Administration > Search Service Application > Import Federated Location
3. Click Browse and navigate to where the file is located on your local drive, select it, and import it. The OSDX configuration information populates the fields in the Federated Locations page. 4. In the Common – Basic Authentication section of the same page, enter the username that you received from your organization's SAP Jam administrator in the SAP Jam Common User field, and the password for that user in the Password field. 5. Add SAP Jam as a federated location within the admin UI for setting up SharePoint Search Centers. 6. SharePoint 2010 also requires that you activate the CMIS feature on each document site that you connect to, so on each document site in which you want to implement federated search, navigate to Settings
Features
Home
Site
and click Activate.
Figure 130: SharePoint Central Administration > Search Service > Federated Locations
Note Next: You must now Add the SAP Jam security certificate to SharePoint [page 177].
4.4.2.3
Add the SAP Jam security certificate to SharePoint
In this final step in configuring federated search results from SAP Jam into SharePoint, the SharePoint administrator must import the SAP Jam security certificate into SharePoint using the following procedure: 1. In the browser that you use to access your SAP Jam service, view your certificates, and among the VeriSign certificates, and export the VeriSign Class 3 Secure Server CA -G3 certificate in DER encoded binary X.509 format.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
177
Figure 131: Export SAP Jam's VeriSign server certificate
2. On the SharePoint server, import the exported certificate file using the following SharePoint 2010 PowerShell command: New-SPTrustedRootAuthority -Name "VeriSign" -Certificate For more information on this step, see http://technet.microsoft.com/en-us/library/ff607586.aspx 3. Verify that SharePoint has successfully imported the security certificate by opening
.
Central Administration
Security Manage Trust . The VeriSign certificate should be listed.
Figure 132: Verify the SAP Jam certificate in SharePoint
With this configuration complete, user's searches in SharePoint will now include results from SAP Jam.
178
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
4.4.3 Integrate Alfresco One 4.2 Prepare for an Alfresco One 4.2 integration Note You must provide internet access to your CMIS repository for SAP Jam. To ensure that the configuration of this access is secure, SAP strongly advises that you take the following precautions: ● Ensure that you use an HTTPS with TLS connection. ● Ensure that you Add a Trusted Certificate Authority [page 156] required to access the CMIS repository to SAP Jam. ● Configure a reverse proxy to provide SAP Jam with access to your document repository, and to deny access from other clients. For an Alfresco One 4.2 integration, ensure that you have enabled the change log, which is documented below. This small task is drawn from the Alfresco wiki's CMIS page , which you should refer to if you have any troubles with your integration.
Enabling the Change Log Note Enabling the change log is a deprecated feature. This will be removed in the November, 2015, release. Alfresco's implementation of the CMIS Change Log is an extension of the Auditing capabilities already available in Alfresco. By default, the CMIS Change Log is disabled. You'll see this reflected in the CMIS Repository capabilities where the value of capabilityChanges is none. To enable the CMIS Change Log, the following configuration value must be set, either by setting it in alfrescoglobal.properties or in JMX (if available): audit.cmischangelog.enabled=true Once set, the value of capabilityChanges becomes objectidsonly. This means that the Alfresco Change Log provides information on the objects that have changed (which have been created, updated, deleted, or had their permissions modified), but it does not provide a list of the properties which have changed.
Register the external document repository application in SAP Jam Create an External Application entry to register your external application with SAP Jam. This procedure is the required first step in setting up a secure data connection with your external document repository. 1. Access the Admin console [page 11] and select External Applications from the left navigation sidebar. The
Admin
SAP Jam Administrator Guide Integrations
External Applications
section is displayed.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
179
Figure 133: Register the document repository application in SAP Jam
This initial page is a catalog of the external applications that have been configured for your organization's SAP Jam instance. 2. Click Add Application and select the Alfresco One 4.2. The form for adding a new external application is displayed. 3. In the Name text box, type in a meaningful name, such as one that names the external application and/or its dedicated use. This name will appear in the SAP Jam navigation sidebar and in other locations in SAP Jam, so it is important to make it something recognizable. 4. Enter the User name and Password of the common user. 1. User name: This is the user name of the generic user account that will be used to access the service on behalf of all SAP Jam users. 2. Password: This is the password of the generic user account that will be used to access the service on behalf of all SAP Jam users. With Common User authentication, all access from SAP Jam to the external data source is made through an HTTP Basic authentication call using these provided user credentials. This is recommended only if you wish to expose all of the data in the data source to all SAP Jam users in your company. In other words, ensure that all the data exposed through the application can be considered "public" within your company. 5. Set the Service Document URL. This is the URL for the site or site collection that is housing the document library or libraries that are to be integrated into SAP Jam. See the notes below. The Service Document URL must be in a form similar to this: https:///alfresco/cmisatom
180
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
6. Click Save. You are returned to the Jam Admin External Applications page, where the list of external applications that have been added is displayed, now including the external application that you have just registered.
Note If your organization uses unrecognized or self-signed certificates for network access, or if you want to ensure a more secure connection to your document repository, you must add a Trusted Certificate Authority [page 156].
Note At this point, if you have any trouble establishing a connection between SAP Jam and your SharePoint server, you should work through the procedure Troubleshoot CMIS Connections [page 203].
Register the external document repositories or libraries Once you have completed the required configuration to access your external application from SAP Jam, you need to further configure it by adding the document repositories or document libraries, which are the specific sections of content that you want to access. 1. Access the Admin console [page 11] and select External Applications from the left navigation sidebar. The
Admin
External Applications
section is displayed.
2. Click on Action beside the Alfresco One 4.2 application for which you want to add access to document repositories and select Manage CMIS Repositories from the context menu. The : CMIS Repositories screen is displayed for that application. 3. Click Add Repository and select either Use Custom Setting or Select from List. Depending on the control that you selected, one of the following dialog boxes is displayed: ○ The Add CMIS Repository text entry dialog box ○ The Add CMIS Repository list selection dialog box
Figure 134: The Add CMIS Repository or Document Library page
4. Set the document repository information by doing one of the following: ○ In the Add CMIS Repository text entry dialog box, enter the Name of the repository and the Repository Id. ○ The Name is the name that will appear in the group navigation pane once group administrators set up access to a given repository, so make this a name that will be recognized by users in your organization.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
181
○ The Repository Id is found by navigating to the document repository, and looking at the browser URL. The unique ID is found within the URL string. ○ In the Add CMIS Repository list selection dialog box, click the CMIS repository that you want to add. The listed repositories are retrieved from the CMIS server's base URL. Only the SharePoint 2013 option will display multiple repositories. 5. Click Create. The Add CMIS Repository dialog box will close, and the added repository will appear in the CMIS Repositories page.
Note Next: Once you have completed the registration of the document repositories or libraries that you want to be able to access from within SAP Jam, you can proceed to Access document repositories in SAP Jam groups [page 203].
4.4.4 Integrate SAP Extended ECM by OpenText Prepare for an SAP Extended ECM by OpenText integration Requirements The following software, versions, and components must be installed to integrate SAP Enterprise Content Management document repositories with SAP Jam. ● Must be on a Windows or Linux based server. ● Must have Oracle or SQLServer installed. ● Must be SAP Extended ECM by OpenText 10.5, with the following components installed: ○ Deployment Scenarios ○ Content Server ○ Directory Services ○ Client Software ○ Additional Product Groups ○
Services
Enterprise Library Server
Note You must provide internet access to your CMIS repository for SAP Jam. To ensure that the configuration of this access is secure, SAP strongly advises that you take the following precautions: ● Ensure that you use an HTTPS with TLS connection. ● Ensure that you Add a Trusted Certificate Authority [page 156] required to access the CMIS repository to SAP Jam. ● Configure a reverse proxy to provide SAP Jam with access to your document repository, and to deny access from other clients.
182
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Note Known Issue: Even a correct installation will return an HTTP 500 Status Message unless the required patches are installed. The following procedure will guide you through the steps required to correct this issue. Install the required patches and make the required configuration changes: 1. Download the required patch bundle. Download Update Installer 10.5.0 - 2014.2. Revision 1050.2014.02.37
.
2. Install the patch. Follow the instructions at https://knowledge.opentext.com/knowledge/piroot/ar/v100500/ar-dwg/en/ html/patchupdate-inst.htm , as the patch bundle requires you to change the Content Server connection settings in the Archive Server configuration. 3. Run localhost/OTCS/cs.exe and follow the prompts. 4. Create a database user and database if required. 5. Connect the Content Server to the database. 6. After logging into the Content Server, install the Enterprise Library in
Content Server Administrator
Install
Modules . 7. Change the Member Service WSDL and Authentication Service WSDL in the OpenText Administration Client from "localhost" to the IP address of the server. 8. Open
Directory Services
Resources .
1. Right-click on Content Server and select Edit. 2. Click Next twice, and ensure that the URLs use IP address instead of localhost. 9. Enable SSL for the OTCS endpoint and Tomcat.
Note OpenText's implementation of CMIS has the following restrictions: ● Only exact file name matches are supported in searches. ● Search results may not be up-to-date. Results are only updated when the OpenText search indexing job is run, which is controlled by the OpenText administrator.
Register the external document repository application in SAP Jam Create an External Application entry to register your external application with SAP Jam. This procedure is the required first step in setting up a secure data connection with your external document repository. 1. Access the Admin console [page 11] and select External Applications from the left navigation sidebar. The
Admin
SAP Jam Administrator Guide Integrations
External Applications
section is displayed.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
183
Figure 135: Register the document repository application in SAP Jam
This initial page is a catalog of the external applications that have been configured for your organization's SAP Jam instance. 2. Click Add Application and select SAP Extended ECM by OpenText from the drop-down menu. The form for adding a new external application is displayed. 3. In the Name text box, type in a meaningful name, such as one that names the external application and/or its dedicated use. This name will appear in the SAP Jam navigation sidebar and in other locations in SAP Jam, so it is important to make it something recognizable. 4. Enter the User name and Password of the common user. 1. User name: This is the user name of the generic user account that will be used to access the service on behalf of all SAP Jam users. 2. Password: This is the password of the generic user account that will be used to access the service on behalf of all SAP Jam users. With Common User authentication, all access from SAP Jam to the external data source is made through an HTTP Basic authentication call using these provided user credentials. This is recommended only if you wish to expose all of the data in the data source to all SAP Jam users in your company. In other words, ensure that all the data exposed through the application can be considered "public" within your company. 5. Set the Service Document URL. This is the URL for the site or site collection that is housing the document library or libraries that are to be integrated into SAP Jam. 6. Click Save.
184
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
You are returned to the Jam Admin External Applications page, where the list of external applications that have been added is displayed, now including the external application that you have just registered.
Note If your organization uses unrecognized or self-signed certificates for network access, or if you want to ensure a more secure connection to your document repository, you must add a Trusted Certificate Authority [page 156].
Note At this point, if you have any trouble establishing a connection between SAP Jam and your SharePoint server, you should work through the procedure Troubleshoot CMIS Connections [page 203].
Register the external document repositories or libraries Once you have completed the required configuration to access your external application from SAP Jam, you need to further configure it by adding the document repositories or document libraries, which are the specific sections of content that you want to access. 1. Access the Admin console [page 11] and select External Applications from the left navigation sidebar. The
Admin
External Applications
section is displayed.
2. Click on Action beside the SAP Extended ECM by OpenText application for which you want to add access to document repositories and select Manage CMIS Repositories from the context menu. The : CMIS Repositories screen is displayed. 3. Click Add Repository and select either Use Custom Setting or Select from List. Depending on the control that you selected, one of the following dialog boxes is displayed: ○ The Add CMIS Repository text entry dialog box ○ The Add CMIS Repository list selection dialog box
Figure 136: The Add CMIS Repository or Document Library page
4. Set the document repository or library information by doing one of the following: ○ In the Add CMIS Repository text entry dialog box, enter the Name of the repository and the Repository Id. ○ The Name is the name that will appear in the group navigation pane once group administrators set up access to a given repository, so make this a name that will be recognized by users in your organization.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
185
○ The Repository Id is found by navigating to the document repository, and looking at the browser URL. The unique ID is found within the URL string. CMIS is available on any on-premises SharePoint 2013 site only after the Content Management Interoperability Services (CMIS) Producer feature is activated in the Manage Site Features section of Site Settings. ○ In the Add CMIS Repository list selection dialog box, click the CMIS repository that you want to add. The listed repositories are retrieved from the CMIS server's base URL. Only the SharePoint 2013 option will display multiple repositories. 5. Click Create. The Add CMIS Repository dialog box will close, and the added repository will appear in the CMIS Repositories page.
Note Next: Once you have completed the registration of the document repositories or libraries that you want to be able to access from within SAP Jam, you can proceed to Access document repositories in SAP Jam groups [page 203].
4.4.5 Integrate Office 365 SharePoint Sites Prepare for an Office 365 SharePoint Sites integration This procedure involves configuring access to SAP Jam in Microsoft Azure. 1. As your organization's Microsoft Azure administrator, log in to your Microsoft Azure account. 2. Ensure that your Microsoft Office 365 Tenant is added as a Directory in your Microsoft Azure account. 3. Under the Active Directory tab, click on your linked Microsoft Office 365 directory, click on Applications, and click Add. A dialog box is displayed.
Figure 137: "What do you want to do?" dialog box
4. Click Add an application my organization is developing. The second screen of the dialog box is displayed. 5. Enter the name of your application, select Web Application and/or Web API, and click the right-pointing arrow to continue. The third screen of the dialog box is displayed. 6. In both the Sign-On URL and the APP ID URI fields, enter the URL of your SAP Jam service, and click the check mark in the lower-right corner of the dialog box.
186
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Figure 138: App Properties dialog box
Your client application is created. 7. Click Configure, and in the configuration options set the following values: 1. In the keys section, create a new key and set the desired duration (1 or 2 years). You will be able to update the key at any time.
Figure 139: "keys" configuration
2. In the single sign-on section, enter the APP ID URL, which is the base URL for your SAP Jam server, and enter the REPLY URL, which must be in the form https:/// office365/authorized.
Figure 140: "single sign-on" configuration
3. In the permissions to other applications section, set the following: ○ For Windows Azure Active Directory, select the Enable sign-on and read users' profiles (preview) option in the Delegated Permissions drop-down menu.
Figure 141: "Permissions to other applications" configuration: Delegated Permissions options
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
187
○ In the next row, add Office 365 SharePoint Online as the application, and select the Read items in all site collections (preview) and the Read users' files (preview) options in the Delegated Permissions drop-down menu.
Figure 142: "Permissions to other applications" configuration: more Delegated Permissions options
4. In the bar at the bottom of the screen, click the Save icon. When you save, the key value is displayed in the keys section.
Note This is the ONLY TIME that the authorization key will be displayed, so you must copy it and save it as it will be required later in your SAP Jam configuration. 8. Save the Client ID string, and save the authorization key that is displayed in the keys section of the configuration screen. These strings must be entered in your SAP Jam configuration for access to your Office 365 SharePoint Online Sites.
Register the external document repository application in SAP Jam Create an External Application entry to register your external application with SAP Jam. This procedure is the required first step in setting up a secure data connection with your external document repository. 1. Access the Admin console [page 11] and select External Applications from the left navigation sidebar. The
188
Admin
External Applications
section is displayed.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Figure 143: Register the document repository application in SAP Jam
This initial page is a catalog of the external applications that have been configured for your organization's SAP Jam instance. 2. Click Add Application and select Microsoft Office 365 from the drop-down menu. The form for adding a new external application is displayed. 3. In the Name text box, type in a meaningful name, such as one that names the external application and/or its dedicated use. This name will appear in the SAP Jam navigation sidebar and in other locations in SAP Jam, so it is important to make it something recognizable. 4. Set the following options: ○ Top-Level Site URL This is your organization's SharePoint server's base URL. ○ OAuth 2.0 Client Id This is the string from the Client ID field in your Microsoft Azure configuration. ○ Secret This is the value that was displayed in the keys section when you saved your Microsoft Azure configuration. 5. Click Save. You are returned to the Jam Admin External Applications page, where the list of external applications that have been added is displayed, now including the external application that you have just registered.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
189
Note Next: If your organization uses unrecognized or self-signed certificates for network access, or if you want to ensure a more secure connection to your document repository, you must now add a Trusted Certificate Authority [page 156]. Note that Box integrations do not require you to register document repositories, so you can proceed directory to Access Office 365 Online Sites in SAP Jam groups [page 204].
4.4.6 Integrate SAP Mobile Documents
Prepare for an SAP Mobile Documents integration To integrate SAP Mobile Documents into SAP Jam Collaboration, you must do the following: 1. Configure trust between SAP HANA Cloud Platform (hosting SAP Mobile Documents) and SuccessFactors IDP by performing the procedures described in the SAP HANA Cloud Platform, Extension Package for SuccessFactors Implementation Guide . 2. As an SAP Jam Collaboration administrator, access the Admin console [page 11] and select SAML Local Identity Provider from the left navigation sidebar. The
Admin
SAML Local Identity Provider
page is displayed.
3. If the X509 Certificate field is empty, click Generate Key Pair near the bottom of the page. The key pair is generated. Click Save to store the generated keys for persistent use. 4. Copy the contents of both the Issuer field and the X509 Certificate field to add this information in the HANA Cloud Platform configuration. 5. Log in to the SAP HANA Cloud Platform Cockpit, and select Trust in the left navigation menu. The Trust Management page is displayed.
190
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Figure 144: The SAP HANA Cloud Platform Cockpit, Trust Management page
6. Ensure that the Principal Propagation option is set to Enabled. 7. Click on the Trusted Identity Provider tab. The Manage Trust Relationships and Federation Settings page is displayed.
Figure 145: The SAP HANA Cloud Platform Cockpit, Trust Identity Provider tab
8. Click Add Trusted Identity Provider. The Add Trusted Identity Provider form is displayed.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
191
Figure 146: The 797 HANA Cloud Platform Cockpit, Add Trusted Identity Provider form
9. In this form, do the following: ○ In the Name field, paste in the data that you copied from the Issuer field of the SAP Jam Collaboration SAML Local Identity Provider page. ○ Set the "Assertion Consumer Service" field to "Application Root". ○ In the Single Sign-on URL field, enter the URL of your SAP Jam Collaboration service's SAML service, which should be in the form https://.sapjam.com/saml/saml_acs where is the name of your SAP Jam Collaboration data center. ○ Set the Single Sign-on Binding field to HTTP-POST. ○ Set the Signature Algorithm field to SHA-1. ○ In the Signing Certificate field, paste in the data that you copied from the X509 Certificate field of the SAP Jam Collaboration SAML Local Identity Provider page. ○ Set the User ID Source field to subject. ○ Select the Enabled check box. ○ When you have all the fields set as required, click Save. Do not set this new trusted IDP as the default. The default IDP should be the SuccessFactors Identity Provider (IDP) system which is used for login.
Register the external document repository application in SAP Jam Collaboration Create an External Application entry to register your external application with SAP Jam Collaboration. This procedure is the required first step in setting up a secure data connection with your external document repository.
192
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
1. Access the Admin console [page 11] and select External Applications from the left navigation sidebar. The
Admin
External Applications
section is displayed.
Figure 147: Register the document repository application in SAP Jam Collaboration
This initial page is a catalog of the external applications that have been configured for your organization's SAP Jam Collaboration instance. 2. Click Add Application and select SAP Mobile Documents (cloud version) from the drop-down menu. The form for adding a new external application is displayed. 3. In the Name text box, type in a meaningful name, such as one that names the external application and/or its dedicated use. This name will appear in the SAP Jam Collaboration navigation sidebar and in other locations in SAP Jam Collaboration, so it is important to make it something recognizable. 4. Set the Service Document URL. This is the URL for the site or site collection that is housing the document library or libraries that are to be integrated into SAP Jam Collaboration. 5. Set the SAML Subject NameID source, which must be either SuccessFactors Foundation UserId (if your organization's SAP Jam Collaboration instance is configured to use SuccessFactors IDP) or SAP Cloud Identity User Identifier (if your organization's SAP Jam Collaboration instance is configured to use SAP IDS). Do not use User Email. 6. Click Save. You are returned to the Jam Collaboration Admin External Applications page, where the list of external applications that have been added is displayed, now including the external application that you have just registered.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
193
Note If your organization uses unrecognized or self-signed certificates for network access, or if you want to ensure a more secure connection to your document repository, you must add a Trusted Certificate Authority [page 156].
Note At this point, if you have any trouble establishing a connection between SAP Jam Collaboration and your SharePoint server, you should work through the procedure Troubleshoot CMIS Connections [page 203].
Register the external document repositories or libraries Once you have completed the required configuration to access your external application from SAP Jam Collaboration, you need to further configure it by adding the document repositories or document libraries, which are the specific sections of content that you want to access. 1. Access the Admin console [page 11] and select External Applications from the left navigation sidebar. The
Admin
External Applications
section is displayed.
2. Click on Action beside the SAP Mobile Documents application for which you want to add access to document repositories and select either Manage CMIS Repositories from the context menu. The : CMIS Repositories screen is displayed for that application. 3. Click Add Repository and select either Use Custom Setting or Select from List. Depending on the control that you selected, one of the following dialog boxes is displayed: ○ The Add CMIS Repository text entry dialog box ○ The Add CMIS Repository list selection dialog box
Figure 148: The Add CMIS Repository or Document Library page
4. Set the document repository or library information by doing one of the following: ○ In the Add CMIS Repository text entry dialog box, enter the Name of the repository and the Repository Id. ○ The Name is the name that will appear in the group navigation pane once group administrators set up access to a given repository, so make this a name that will be recognized by users in your organization. ○ The Repository Id is found by navigating to the document repository, and looking at the browser URL. The unique ID is found within the URL string.
194
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
○ In the Add CMIS Repository list selection dialog box, click the CMIS repository that you want to add. The listed repositories are retrieved from the CMIS server's base URL. Only the SharePoint 2013 option will display multiple repositories. 5. Click Create. The Add CMIS Repository dialog box will close, and the added repository will appear in the CMIS Repositories page.
Note Next: Once you have completed the registration of the document repositories or libraries that you want to be able to access from within SAP Jam Collaboration, you can proceed to Access document repositories in SAP Jam groups [page 203].
4.4.7 Integrate Box
Prepare for a Box integration Note Box documents in integrated repositories can be viewed, commented on (with or without highlighting), or downloaded. Other Box features, such as providing a direct link to a document, setting a link expiration, or emailing a link to another user, are not available. To prepare for a Box integration, you must do the following: 1. As an administrator for your organization's Box account, log in to the Box developers site. This may be https://app.box.com/developers/services, or it may show your organization in the URL; for example, https://mycorp.app.box.com/developers/services. The BoxDeveloper home page is displayed.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
195
Figure 149: The Box Developer home page
2. Click My Apps in the top bar. If you have not created any apps before, a Create Your First App on Box page is displayed.
196
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Figure 150: The Box My Applications page
3. Click Get Started to create your first Box application. If you have previously created an application, click Create a Box Application near the top of the right sidebar. The Create a Box Application page is displayed.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
197
Figure 151: The Create a Box Application page
4. Enter a meaningful name in the text box, ensure that the Box Content radio button is selected, and click Create Application. The Box Content Application Created page is displayed.
Figure 152: The Box Content Application Created page
198
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
5. Click Configure your application. The Editing 's Box repository page is displayed. This page contains many configuration options that are important to the functionality of your Box repository; however, the majority of those options are beyond the scope and purpose of this document. The settings that are important to this procedure are as follows: ○ In the General Information section, ensure that the Content API access Only radio button is selected. ○ In the OAuth2 Parameters section, set the redirect_uri in the form "https://jam#.sapjam.com/ box_files/authorized", where "#" is set to your SAP Jam data center number. ○ Also in the OAuth2 Parameters section, copy the following two fields of information to use in your SAP Jam configuration: ○ client_id ○ client_secret
Figure 153: The Editing (your application) page's OAuth2 Parameters section
○ In the Backend Parameters section, again set the redirect_uri in the form "https://jam#.sapjam.com/ box_files/authorized", where "#" is set to your SAP Jam data center number. 6. Click Save Application.
Note To ensure that SAP Jam access to integrated Box repositories works properly with Internet Explorer, you must add two URLs, https://app.box.com and https://jam4.sapjam.com, in the Options
Security
Trusted Sites
Control Panel
Internet
list on your users' computers.
Register the external document repository application in SAP Jam Create an External Application entry to register your external application with SAP Jam. This procedure is the required first step in setting up a secure data connection with your external document repository. 1. Access the Admin console [page 11] and select External Applications from the left navigation sidebar. The
Admin
SAP Jam Administrator Guide Integrations
External Applications
section is displayed.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
199
Figure 154: Register the document repository application in SAP Jam
This initial page is a catalog of the external applications that have been configured for your organization's SAP Jam instance. 2. Click Add Application and select Box from the drop-down menu. The form for adding a new external application is displayed. 3. In the Name text box, type in a meaningful name, such as one that names the external application and/or its dedicated use. This name will appear in the SAP Jam navigation sidebar and in other locations in SAP Jam, so it is important to make it something recognizable. 4. Set the following options: ○ Top-Level Site URL This is the top-level URL that you used to access the Box Developer site in step 1 of the Box preparation procedure. ○ OAuth 2.0 Client Id This is the client_id field that you copied in step 5 of the Box preparation procedure. ○ Secret This is the client_secret field that you copied in step 5 of the Box preparation procedure. 5. Click Save. You are returned to the Jam Admin External Applications page, where the list of external applications that have been added is displayed, now including the external application that you have just registered.
Note If your organization uses unrecognized or self-signed certificates for network access, or if you want to ensure a more secure connection to your document repository, you must add a Trusted Certificate Authority [page 156].
200
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Note that Box integrations do not require you to register document repositories, so you can proceed directory to Access document repositories in SAP Jam groups [page 203].
4.4.8 Integrate Google Drive Prepare for a Google Drive integration
Note Note that only one Google Drive can be added per company. To integrate Google Drive, do the following: 1. Access the Admin console [page 11] and select External Applications from the left navigation sidebar. The
Admin
External Applications
section is displayed.
Figure 155: Register the document repository application in SAP Jam
This initial page is a catalog of the external applications that have been configured for your organization's SAP Jam instance.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
201
2. Click Add Application and select Google Drive from the drop-down menu. The form for integrating access to a Google Drive account displays.
Figure 156: The Google Drive account integration page
3. In the Name text box, type in a meaningful name. This name will appear in the SAP Jam navigation sidebar and in other locations in SAP Jam, so it is important to make it something recognizable. 4. Optionally, select Use custom credential. This option allows you to integrate an existing Google Drive account. If you do not select this option, a new Google Drive account is created and accessed using your organization's own client ID and secret. If you do select this option, you must fill in the following two fields: ○ OAuth 2.0 Client Id: This is the client_id field that you used to create your existing Google Drive account. ○ Secret: This is the client_secret that was provided when you created your existing Google Drive account. 5. Click Save. You are returned to the Jam Admin External Applications page, where the list of external applications that have been added displays, now including the Google Drive account that you just registered.
Note If your organization uses unrecognized or self-signed certificates for network access, or if you want to ensure a more secure connection to your document repository, you must add a Trusted Certificate Authority [page 156]. Note that Box integrations do not require you to register document repositories, so you can proceed directly to Access document repositories in SAP Jam groups [page 203].
202
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
4.4.9 Troubleshoot CMIS Connections The most common problem in establishing a connection between SAP Jam and a CMIS document repository involves Transport Layer Security (TLS, a.k.a. SSL) public key certificates. This procedure describes how to identify this problem, and how to resolve it even if the optimum solution is not possible. 1. Download the open source tool to analyze your connection by going to http://chemistry.apache.org/java/ download.html . Click Download beside OpenCMIS Workbench. 2. Install OpenCMIS Workbench and run it using the Service Document URL, User name, and Password that you set in the previous procedure. Form more information on using Apache's OpenCMIS Workbench, see Connecting to a repository in the Apache site documentation. 3. When the Workbench establishes a connection, click on the repository that you want to view in the Load Repositories area, and click Login. The CMIS Workbench information for the selected repository is displayed, as is shown in the following screencapture.
Figure 157: OpenCMIS Workbench
4. Find the reason that your connection is failing. ○ If the failure is due to NTLM authentication being required, note that SAP Jam only supports BASIC authentication. ○ If the failure is due to an unrecognized TLS public key certificate being used by your document repository application, note that by default SAP Jam only supports certificates from recognized Certificate Authorities. ○ If your organization requires the use of unrecognized, self-signed certificates, then you must Add a Trusted Certificate Authority [page 156].
4.4.10 Access document repositories in SAP Jam groups Once you have properly registered your external application and registered your document repositories or libraries for SharePoint 2013, SharePoint 2010, Alfresco One 4.2, SAP Extended ECM by OpenText, SAP Mobile
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
203
Documents, or Box (Box doesn't require that you registered document repositories) you must configure SAP Jam groups to access that external content from within SAP Jam groups. To configure access to a document repository or library from within an SAP Jam group: 1. As a group administrator, from within the group in which you want to add access to a document library or repository, click Group Admin and select Edit Group from the drop-down menu. The Edit Group page is displayed. 2. In the Edit Group page, select the Setup tab. 3. Scroll down to the section for your SharePoint 2013, SharePoint 2010, Alfresco One 4.2, SAP Extended ECM by OpenText, SAP Mobile Documents, or Box service and click Add External Folder. An Add External Folder dialog box is displayed. 4. In the Add External Folder dialog box, click Select a Repository, and select the document repository or library that you want to add access to from the drop-down menu. A second drop-down menu appears. 5. From the secondary drop-down menu, select the document repository folder that you want to have access to from within your SAP Jam group, and click Add. The Add External Folder dialog box is closed, and you return to the Edit Group page. 6. At the bottom of the Edit Group page, click Save changes. You are returned to the group overview page, and the document repository that you configured access to appears in the left navigation sidebar with the title of SAP Extended ECM by OpenText, SharePoint 2013, SharePoint 2010, or Alfresco One 4.2. Note that the above procedure can be repeated to add access to as many repository folders as you want to have access to. Your Document Repository access configuration is now complete. Users can click on the option in the left navigation sidebar, which will display a list of the available document repositories. While this access is "read-only", user can comment on, annotate, and like the documents. Also, you can easily copy the displayed document repositories to other groups.
4.4.11 Access Office 365 Online Sites in SAP Jam groups To configure access to an Office 365 SharePoint Online Sites document library from within an SAP Jam group, access to Office 365 SharePoint Online Sites document libraries must first have been configured in the External Applications
Admin
page.
1. As a group administrator, from within the group in which you want to add access to an Office 365 SharePoint Online Sites document library, click Group Admin and select Edit from the drop-down menu. The Edit Group page is displayed. 2. In the Edit Group page, select the Setup tab. 3. Scroll down to the section for your Office 365 SharePoint Online Sites service and click Add External Folder. An Add External Folder dialog box is displayed. 4. In the Add External Folder dialog box, click Select a Document Library, and select the document library that you want to add access to in the group from the drop-down menu. A second drop-down menu appears. 5. From the secondary drop-down menu, select the document library folder that you want to have access to in your SAP Jam group, and click Add.
204
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Figure 158: Add External Folder dialog box
The Add External Folder dialog box is closed, and you return to the Edit Group page. 6. At the bottom of the Edit Group page, click Save changes. You are returned to the group overview page, and the document library that you configured access to appears in the left navigation sidebar with the title of Microsoft Office 365. Note that the above procedure can be repeated to add access to as many document library folders as you want to have access to, although each of these must be added separately.
Note Ensure that your Internet Explorer users have added the following sites to their list of Trusted Sites: ● https://login.microsoftonline.com ● https://login.windows.net To do this, have your users follow the Add or remove a site from a security zone instruction in the Security zones part of the page http://windows.microsoft.com/en-CA/internet-explorer/ie-security-privacysettings#ie=ie-11 , in the Trusted sites option in the Security tab. Your Microsoft Office 365 SharePoint Online Sites Document Library access configuration is now complete. Users can click on the Microsoft Office 365 option in the left navigation sidebar, which will display a list of the available Microsoft Office 365 document repositories. While this is "read-only" access, user can comment on, annotate, and like the documents. Also, you can easily copy the displayed document repositories to other groups.
4.5
Add an OpenSocial Gadget
OpenSocial gadgets provide a mechanism to extend SAP Jam's abilities to interact with any software or service. OpenSocial gadgets can be developed by programmers in your team, as is described in the SAP Jam OpenSocial Gadgets section of the SAP Jam Developer Guide, or you can download existing OpenSocial gadgets from the SAP Jam Sample Code GitHub site's OpenSocial Gadgets section.
Note For any OpenSocial gadget, there may be risks involved in the exposure of data to external sources. Any data that is stored for use in the operation of the gadget in an external data store will be available to that external user or organization. For example, marking a location on a Google Map stores the data related to that marker that can be accessed by Google. Similarly, if a third-party survey gadget is added, the organization that provided the gadget will have access to the responses to the survey.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
205
Also, certain personal data can be exposed, such as: ● The user's first and last name ● The user's email address ● The user's thumbnail image or avatar The scope of this personal information depends on the context of the gadget, specifically: ● Content gadgets: can expose data on all members of the group to which they have been added. ● Profile gadgets: can expose data on all members that the user who has added the gadget is following. Please consider the security implications of this data exposure for any OpenSocial gadget that you add to SAP Jam. To add an OpenSocial gadget, do the following: 1. Access the Admin console [page 11] and select OpenSocial Gadgets from the left navigation sidebar. The
Admin
OpenSocial Gadgets
section is displayed.
Figure 159: OpenSocial Gadgets catalog
206
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
This page presents a catalog of previously configured OpenSocial gadgets, with UI controls that allow you to Enable/Disable, View, Edit, or Delete existing OpenSocial gadgets, to add a new OpenSocial Gadget (Add Gadget), or to import the configuration for an OpenSocial Gadget (Import Gadget Configuration). 2. To add an OpenSocial Gadget, click Add Gadget at the upper right corner of the page. The Register OpenSocial Gadget page is displayed.
Figure 160: Register OpenSocial Gadget form
1. In the URL field, enter the URL of the OpenSocial gadget that you want to register. 2. Optionally, select the Enabled checkbox to have the gadget immediately available. The gadget can be enabled at any time, whether from the the
Edit
Edit OpenSocial Gadget
Admin
OpenSocial Gadgets
catalog or
page.
3. From the Context drop-down menu, select either: ○ Content to have the gadget appear as an addable option in the Content area of SAP Jam groups. ○ Profile to have the gadget appear in the Admin > Custom Profile [page 76] page, where you can configure where it will appear in your users' profile pages. 4. Optionally, to configure access to the data stores for personalized data for the gadget, you can enter a list of parameters in the Search Paths field. These parameters allow you to descend into the AppData pool and the public_wave pool JSON data structures. Search parameters can be space- or comma-delimited, and wildcards can be set on the JSON keys. For example: ○ a — This example searches for all data within a keys. ○ a.b — This example searches for all data within b keys that are within a keys. ○ a.b* — This example uses * as a wildcard to search for all data within keys that start with b (using the * wildcard) that are within a keys.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
207
○ a.b* c.d — This example uses a space delimiter to provide two search paths. The first search path (a.b*) searches for all data within keys that start with b that are within a keys. The second search path searches for all data within c keys that are within d keys. ○ a.b*,c.d — This example uses a comma delimiter rather the space delimiter used in the previous example; otherwise, it peforms the same searches as the previous example. 5. Optionally, to enable access to the gadget and its displayed data using OAuth 1.0a, click Add Service Configuration in the OAuth 1.0a Service Configurations section. An Add Service Configuration dialog box will be displayed. Do the following: 1. In the Service Name text box, enter the service name for your OAuth 1.0a service. 2. In the Consumer Key text box, enter the consumer key for your OAuth 1.0a service. 3. In the Consumer Secret text box, enter the consumer secret for your OAuth 1.0a service. 4. From the Signature Method drop-down menu, select the consumer secret for your OAuth 1.0a service. 5. Click OK to save these options, or click Cancel to abandon them. You are returned to the
Admin
OpenSocial Gadgets
catalog.
Figure 161: OAuth Add Service Configuration dialog boxes
6. Optionally, to enable access to the gadget and its displayed data using OAuth 2.0, click Add Service Configuration in the OAuth 2.0 Service Configurations section. An Add Service Configuration dialog box will be displayed. Do the following: 1. In the Service Name text box, enter the service name for your OAuth 2.0 service. 2. In the Client Id text box, enter the client ID for your OAuth 2.0 service. 3. In the Client Secret text box, enter the consumer secret for your OAuth 2.0 service. 4. Click OK to save these options, or click Cancel to abandon them. You are returned to the
Admin
OpenSocial Gadgets
catalog.
7. From the Choose Display Language drop-down menu, select the language that you want displayed in the OpenSocial gadget. 8. At any time after you have entered the URL for the gadget, you can click Refresh beside Gadget Information to view important information about the gadget and to see a preview of the gadget.
208
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Figure 162: OpenSocial Gadget information and preview
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
209
9. When all of the above settings are complete, click Save to register the OpenSocial gadget for use in SAP Jam. You are returned to the OpenSocial Gadgets page, with the gadget that you registered listed in the catalog. 3. Alternatively, you can upload a gadget configuration file, from the Admin OpenSocial Gadgets catalog. Gadget configurations are the files that you get when you click on Export Gadget Configuration in a gadget's administration page. To do this, do the following: 1. Click Import Gadget Configuration near the top of the page. Your browser will open a file upload dialog box. 2. Navigate to the configuration file and upload it. After importing the file, the Register OpenSocial Gadget page is displayed with the file's configuration information displayed in the various text boxes of the form. 3. Change any of the existing settings, or fill in any missing settings, and click Save. You are returned to the OpenSocial Gadgets page, with the gadget that you registered listed in the catalog. 4. In the Admin OpenSocial Gadgets catalog, click View on the row for the OpenSocial gadget to view the information about that gadget. An OpenSocial Gadget: page is displayed. You can either modify the information by clicking Edit or return to the OpenSocial Gadgets page by clicking Back. 5. In the Admin OpenSocial Gadgets catalog, click Edit on the row for the OpenSocial gadget to edit that gadget's configuration. The Edit OpenSocial Gadget page is displayed, which is effectively identical to the Register OpenSocial Gadget page, although you cannot modify the Context once it is set. 1. Make whatever changes are required. 2. Click Save to save your changes. You are returned to the OpenSocial Gadgets page, with the modified OpenSocial Gadget that you just edited listed in the catalog.
4.6
Integrate SAP Jam with gamification vendors
Gamification makes it easy to help guide and reward new hires and existing employees to rapidly integrate SAP Jam into their work processes. SAP Jam provides event hooks that make integration with leading gamification vendors very straightforward. User activity in SAP Jam (including activity interacting with events sent from other applications) can trigger information being sent to the gamification vendor, where it can be analyzed against established goals or challenges. Based on the criteria of these established challenges, SAP Jam users can be rewarded with 'badges' that cumulatively go towards completing 'missions' that exemplify the behavior that is required for employees to be most effective in their jobs. A variety of actions in SAP Jam can be identified as the criteria for earning badges and completing missions.
Note Currently, the only gamification vendor that SAP Jam integrates with is Bunchball.
210
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Table 25: SAP Jam available gamification actions Actions
Metadata
Actions
Metadata
added_discussion
group
edited_document
group, document
added_idea
group
edited_page
group
annotated_document
group, document
external_member_accepted_my_invite
answered_forum_question
group, discussion
followed_member
answered_question_correctly
group, discussion
followed_you
asked_forum_question
group
gave_endorsement
blogged
group
gave_kudo
chatted
invited_external_member
commented_on_document
group, discussion
invited_member_to_group
group
created_document
group, document
joined_group
group
posted_group_wall_comment
group
created_expertise crm_updated_accounts
external
posted_member_wall_comment
crm_updated_campaigns
external
received_endorsement
crm_updated_knowledge_articles
external
received_kudo
crm_updated_marketing_plans
external
updated_member_status
crm_updated_opportunities
external
viewed_blog *
group, blog_entry
crm_updated_sales_orders
external
viewed_document *
group, document
crm_updated_service_orders
external
viewed_your_blog *
group, blog_entry
crm_updated_service_requests
external
viewed_your_document *
group, document
crm_updated_tasks
external
voted_for_idea
group, discussion
Note * No action is sent if the person viewing the content is also the creator of that content. This is done to prevent inappropriately high counts on these items. To enable gamification integration with your SAP Jam service, do the following: 1. Access the Admin console [page 11] and select Features from the left navigation sidebar. The
Admin
Features
section is displayed.
2. Near the bottom of the page, select the Enable Gamification checkbox and click Save changes. 3. In your gamification vendor's Administration page, define the challenges that you want to be supported in SAP Jam. For example, when a member joins a group, a joined_group action is sent to the vendor along with metadata representing the group identifier. When setting the rules for a challenge, that metadata can be matched.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
211
Figure 163: Using gamification metadata
4. From the SAP Jam Admin sidebar menu, select Gamification. The
Admin
Gamification
page is displayed.
Figure 164: Gamification configuration
5. In the Gamification page, enter the parameters provided by your gamification vendor. These include: ○ Bunchball Hostname ○ Bunchball Key ○ Bunchball Secret
212
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
Note The Magic Number is automatically generated when the Gamification configuration is initially saved. 6. Select Gamification Types that you want to enable. ○ Enable In-context Gamification Notifications—Select this option to enable Gamification Notifications. ○ Enable Badges and Missions—Select this option to enable badges and missions. ○ Enable Leaderboard—Select this option to enable the Leaderboard. 7. Select the Gamification Feed Options that you want to enable. These options refer to the data that is returned from Bunchball about the gamification data. ○ Enable Display Challenge Name in Feed—Enable this option to have the name of the challange included in the feed from Bunchball. ○ Enable Display Challenge Description in Feed—Enable this option to have the description of the challange included in the feed from Bunchball. ○ Enable Display Challenge Custom Data in Feed—Enable this option to have the custom data for the challange included in the feed from Bunchball. 8. Click Save to enable your gamification settings.
4.7
Add Extensions
The SAP Jam Admin console provides access to the extensions available for SAP Jam from the SAP HANA App Center. To access these extensions, do the following: 1. Access the Admin console [page 11] and select Extensions Catalog from the left navigation sidebar. The
Admin
SAP Jam Administrator Guide Integrations
Extensions Catalog
page is displayed.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
213
Figure 165: The Extensions Catalog page
2. Click on Learn More beside any extension that is of interest to view the SAP HANA App Center page for that extension. Details on the extension are shown in that page, as well as acquisition information and installation instructions, or information on how to access such instructions.
Note Extensions from the SAP HANA App Center are not currently available in translation. Please ensure that you and your users are prepared to use the extension in its available language, or languages, prior to acquiring and installing one.
214
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
4.8
Use the Widget Builders
The SAP Jam Admin console provides a tool for building three common types of widgets, which are complex HTML5 components that use a preset structure to present some common types of SAP Jam content. The Widget Builder page currently provides the following widget builders: ● The Feed Widget Builder—Creates a highly customizable feed widget that can be used to embed one of five different types of SAP Jam feed in an external web page. ● The Recommendation Widget Builder—Creates a customizable recommendation widget that can be used to embed SAP Jam content, people, or groups recommendations in an external web page. ● The Share Widget Builder—Creates a share widget that can be embedded in any external web page to add a "share link" (like other social network share buttons), and which will post the containing page to either SAP Jam group or member feeds when clicked in the external web page.
4.8.1 Use the Feed Widget Builder The Feed Widget Builder provides the easy creation of a highly customizable feed widget that can display any of five different types of SAP Jam feed in an HTML page, with no requirement for knowing the JavaScript in which they are written. To create a feed widget with your specifications, do the following: 1. Access the Admin console [page 11] and select Widget Builders from the left navigation sidebar. The
Admin
Widget Builders
section is displayed.
2. Click the Feed Widget Builder tab. The Feed Widget Builder tab content is displayed.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
215
Figure 166: The Feed Widget Builder
3. In the Widget div ID field, enter a unique and meaningful name for the HTML div tag that will encapsulate your feed widget. This div ID is used in the widget JavaScript that you generate using this form, and it must match the div ID in the HTML page that you use as the container for this widget. Accept the default ID of myDiv unless there are other divs in the same page with the same ID, as the div ID must be unique within the page in which you add the widget. 4. From the Authentication Type drop-down menu, select the type of authentication that you want to use.
216
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
The options are: ○ SuccessFactors Identity Provider: uses an existing SAP Jam session, or an existing SuccessFactors session, or it presents a SuccessFactors sign-on page and then redirects to the requested feed widget after the user signs in. [Recommended] ○ Pre-existing Jam session: uses an existing SAP Jam session, or it displays an error message if one is not found. [Not recommended: included for legacy support] ○ Jam session with Sign In: uses an existing SAP Jam session, or it presents a SAP Jam sign-on page and then redirects to the requested feed widget after the user signs in. [Not recommended: included for legacy support] ○ Jam session with Sign In pop-up: uses an existing SAP Jam session, or it presents a SAP Jam sign-on page in a new page or tab, and—upon successful sign-on—the new page closes, and the original requesting page redirects to the requested feed widget. [Not recommended: included for legacy support] ○ Single-use Token: uses a single-use token provided by the Jam API. [Recommended] For further information generating a single-use token, see the Auth API section of the SAP Jam API Documentation, particularly the documentation of [POST] /v1/single_use_tokens. After obtaining a single-use token, it needs to be included in the parameters passed into the sapjam.feedWidget.create function call in the widget initialization script. For example: sapjam.feedWidget.init( "https://.sapjam.com/widget/v1/feed", "single_use_token"); var w = sapjam.feedWidget.create("myDiv",{ type: "follows", avatar: false, post_mode: "inline", reply_mode: "inline" single_use_token: '883a5486-62af-407a-a5ca-cec6dcf259dc' }); 5. From the Feed type drop-down menu, select the type of feed that you want to display. Several of these options require that you supply additional information about what objects the feed is based on. The options are: ○ Company Feed: will display the same feed that you would see under the Company tab in SAP Jam. ○ My Follows Feed: will display the same feed that you would see under your Home tab in SAP Jam. ○ Group Feed: will display the same feed, or feeds, for one or more Jam groups. If you select this option, the following field displays: ○ Group IDs: Enter one or more comma-separated Group IDs to have this widget show the feeds from this group or these groups. If only one group ID is entered, the widget displays the same feed displayed on the Feed Updates tab for that particular group. If multiple group IDs are provided, then the widget displays a drop-down menu from which you can select a specific group or "All groups". Selecting a group displays the feed for that group, and any posts made while viewing that feed are posted to the selected group's wall. If "All groups" is selected, the widget displays the combined feed for all groups. Posting is disabled while viewing the "All groups" feed. ○ External Object Feed: will display the feed for an external object or business record. If you select this option, the following fields display: ○ External ID: To set this value, copy the value of the Exid property returned by the OData API’s ExternalObjects endpoint. This value is typically the external OData URL for the object. ○ External type: To set this value, copy the value of the ObjectType property returned by the OData API’s ExternalObjects endpoint. This value is the External Type value for the object.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
217
The feed will behave differently depending on whether the logged-in user is able to view the full feed history for that particular external object type: ○ Default behavior: If feed history is not enabled, or the user is not authorized to view the full feed history for the object, they only see the feed updates that are explicitly routed to them, such as via a distribution list. ○ Feed History: To enable feed history for an external object, a company administrator must configure the necessary authentication settings and external object types in the External Applications tab of the Jam Admin page. From this page, administrators can enable the feed history for specific external object types. Once feed history is enabled, any time a user views an external object feed, the Feed Widget calls back to the external application to determine whether the user has permission to view that object. If authorization succeeds, the Feed Widget displays the entire feed history for the external object. If authorization fails, the widget reverts back to the default behavior described above. For more on External Objects, see Integrate business records [page 116]. ○ External Wall Feed: will create the JavaScript code to display a SAP Jam feed in an external web site. If you select this option, the following fields display: ○ External ID: This can be any string that you want to use to uniquely identify the topic. ○ Name: This should be a user-friendly name for the topic. This is the name that will show up in the feed when you comment on the topic, which will appear in the form "John Doe commented on ". ○ External URL: [Optional] This can be any fully-qualified external URL. If this property is provided, then the topic name will be rendered in the feed as a link that opens this URL in a new tab when a user clicks on it. ○ Mentions Feed: will display a feed of messages in which the user was mentioned. This will include all @@notify mentions. This will be the same as the feed that is displayed when a user clicks on the "@" option on their home page. ○ Content Item Feed: will display a feed of comments made on the selected content item identified in this configuration. This will be the same as viewing the messages posted in that content item's page. If you select this option, the following fields display: ○ Content type: Select the appropriate content type from the drop-down menu. ○ Content item ID: This must be the unique ID as set by SAP Jam for the content item for which you want the feed widget to show all comments. This will be the same as the ID segment of the URL for the page that displays the content item. 6. From the Style drop-down menu, select the styling that you want to apply to your widget. The options are: ○ Jam ○ SAP Cloud for Customer 7. Set the following check box toggles as desired: ○ Show Profile Photos in Feed: shows thumbnails of the creators of each post in the feed. ○ Show User Profile Photo: shows a thumbnail of the requesting user at that top of the feed. ○ Live Feed Updates: sets whether updates are automatic or by notification message. ○ Mobile Mode: presents only mobile-capable features in the feed. ○ Filter by the Following Hash Tags: allows you to set some filtering on the feed based on the hashtags entered in the text box below this toggle. 8. From the Post Mode drop-down menu, select the option that you want for users' posts. The "Post Mode" refers to the text entry box at the top of the feed in which you can post a comment. The options for this are: ○ Inline: A text entry box is displayed at the top of the Feed Widget. ○ Link to Jam: A link to the SAP Jam feed is displayed at the top of the Feed Widget.
218
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
○ Hidden: There is no option for posting displayed at the top of the Feed Widget. 9. From the Reply Mode drop-down menu, select the option that you want for users' replies. The "Reply Mode" refers to the options to reply to other peoples' comments. The options are: ○ Inline: A control, labeled "Reply" is displayed below a user's comment, which opens a Reply text box if clicked. ○ Link to Jam: A link to the SAP Jam feed is displayed below a user's comment. ○ Hidden: There is no option for replying displayed below a user's comment. 10. Set the following checkbox toggles as desired: ○ Hide Like Links: this toggle shows or hides users' likes as a post in the feed as replies. ○ Hide Bookmark Links: this toggle shows or hides users' bookmarks in the feed as replies. ○ Limit feed items to a maximum of: allows you to set the maximum number of feed items. 11. At any point in configuring your feed widget, you can click Preview to see both a rendered example of the current settings and an example of the script that is set by the current options. 12. When you are satisfied with the configuration of your widget, copy the JavaScript from the bottom text box of the Preview area and paste it into your web page within script tags. Ensure that you click Preview immediately before you copy the script to be certain that your most recently selected options are reflected in the script. Also, ensure that you have the div with the ID from step 4 in your HTML page, which calls the script and displays the widget within that div. The result should look something like the following example: SAP Jam Div-Based Widget sapjam.feedWidget.init( "https://.sapjam.com/widget/v1/feed", "single_use_token"); var w = sapjam.feedWidget.create("myDiv", { type: "follows", avatar: false, post_mode: "inline", reply_mode: "inline" single_use_token: '883a5486-62af-407a-a5ca-cec6dcf259dc' }); 13. Add a div tag above the JavaScript that you pasted into the HTML body in the previous step. This div tag must: ○ Be placed before the JavaScript, or you must use something like the jQuery .ready() function, so that the order of script elements in the page does not matter. ○ Use the same "id" as you set or accepted in the Widget div ID field of the Widgets Builder form. ○ Include style statements that set the width and height of the widget, otherwise it will inherit the dimensions of its container element. The result should look something like this: SAP Jam Div-Based Widget
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
219
sapjam.feedWidget.init( "https://.sapjam.com/widget/v1/feed", "single_use_token"); var w = sapjam.feedWidget.create("myDiv", { type: "follows", avatar: false, post_mode: "inline", reply_mode: "inline" single_use_token: '883a5486-62af-407a-a5ca-cec6dcf259dc' });
4.8.2 Use the Recommendations Widget Builder The Recommendations Widget Builder provides the easy creation of a customizable recommendations widgets for SAP Jam content, people, or groups recommendations that can be placed into any HTML page, with no requirement for knowing the JavaScript in which they are written. To create a recommendations widget with your specifications, do the following: 1. Access the Admin console [page 11] and select Widget Builders from the left navigation sidebar. The
Admin
Widget Builders
section is displayed.
2. Click the Recommendations Widget Builder tab. The Recommendations Widget Builder tab content is displayed.
Figure 167: The Recommendations Widget Builder
3. In the Widget div ID field, enter a unique and meaningful name for the HTML div tag that will encapsulate your recommendations widget.
220
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
This div ID is used in the widget JavaScript that you generate using this form, and it must match the div ID in the HTML page that you use as the container for this widget. Accept the default ID of myDiv unless there are other divs in the same page with the same ID, as the div ID must be unique within the page in which you add the widget. 4. From the Authentication Type drop-down menu, select the type of authentication that you want to use. The options are: ○ SuccessFactors Identity Provider: uses an existing SAP Jam session, or an existing SuccessFactors session, or it presents a SuccessFactors sign-on page and then redirects to the requested recommendations widget after the user signs in. [Recommended] ○ Pre-existing Jam session: uses an existing SAP Jam session, or it displays an error message if one is not found. [Not recommended: included for legacy support] ○ Jam session with Sign In: uses an existing SAP Jam session, or it presents a SAP Jam sign-on page and then redirects to the requested recommendations widget after the user signs in. [Not recommended: included for legacy support] ○ Jam session with Sign In pop-up: uses an existing SAP Jam session, or it presents a SAP Jam sign-on page in a new page or tab, and—upon successful sign-on—the new page closes, and the original requesting page redirects to the requested recommendations widget. [Not recommended: included for legacy support] ○ Single-use Token: uses a single-use token provided by the Jam API. [Recommended] For further information generating a single-use token, see the Auth API section of the SAP Jam API Documentation, particularly the documentation of [POST] /v1/single_use_tokens. After obtaining a single-use token, it needs to be included in the parameters passed into the sapjam.recommendationsWidget.create function call in the widget initialization script. For example: sapjam.recommendationsWidget.init( "https://.sapjam.com/widget/v1/recommendation", "single_use_token"); var w = sapjam.recommendationsWidget.create("myDiv",{ style: "link", type: "people", max: "5", single_use_token: '883a5486-62af-407a-a5ca-cec6dcf259dc' }); 5. From the Type drop-down menu, select the layout of the recommendations that you want to use. The options are: ○ Grid ○ List 6. From the # of Recommendations drop-down menu, select the number of recommendations that you want displayed. The options are: ○ 3 ○ 5 ○ 10 7. From the Recommendation Type options, select the radio button for the type of recommendations that you want to display. The options are: ○ Content ○ People ○ Groups
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
221
8. At any point in configuring your feed widget, you can click Preview to see both a rendered example of the current settings and an example of the script that is set by the current options. 9. When you are satisfied with the configuration of your widget, copy the JavaScript from the bottom text box of the Preview area and paste it into your web page within script tags. Ensure that you click Preview immediately before you copy the script to be certain that your most recently selected options are reflected in the script. Also, ensure that you have the div with the ID from step 4 in your HTML page, which calls the script and displays the widget within that div. The result should look something like the following example: SAP Jam Div-Based Widget sapjam.recommendationsWidget.init( "https://.sapjam.com/widget/v1/recommendation", "single_use_token"); var w = sapjam.recommendationsWidget.create("myDiv", { style: "link", type: "people", max: "5", single_use_token: '883a5486-62af-407a-a5ca-cec6dcf259dc' }); 10. Add a div tag above the JavaScript that you pasted into the HTML body in the previous step. This div tag must: ○ Be placed before the JavaScript, or you must use something like the jQuery .ready() function, so that the order of script elements in the page does not matter. ○ Use the same "id" as you set or accepted in the Widget div ID field of the Widgets Builder form. ○ Include style statements that set the width and height of the widget, otherwise it will inherit the dimensions of its container element. The result should look something like this: SAP Jam Div-Based Widget sapjam.recommendationsWidget.init( "https://.sapjam.com/widget/v1/recommendation", "single_use_token"); var w = sapjam.recommendationsWidget.create("myDiv", { style: "link", type: "people", max: "5", single_use_token: '883a5486-62af-407a-a5ca-cec6dcf259dc' });
222
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
4.8.3 Use the Share Widget Builder The Share Widget Builder creates a share widget that can be embedded in any external web page to add a "share link" (like other social network share buttons) that will post an entry about the containing page to either SAP Jam member or group feeds. Creating the share widget has no requirement for knowing how to write JavaScript code. To create a share widget with your specifications, do the following: 1. Access the Admin console [page 11] and select Widget Builders from the left navigation sidebar. The
Admin
Widget Builders
page is displayed.
2. Click the Share Widget Builder tab. The Share Widget Builder tab content is displayed.
Figure 168: The Share Widget Builder
3. In the Widget element ID field, enter a unique and meaningful name for the HTML div tag that will encapsulate your Share widget. This div ID is used in the widget JavaScript that you generate using this form, and it must match the div ID in the HTML page that you use as the container for this widget. Accept the default ID of myDiv unless there are other divs in the same page with the same ID, as the div ID must be unique within the page in which you add the widget. 4. Select the Create default widget button to have a widget button included in the embedded widget.
Note If you deselect this option, you must add the text or icon to be displayed in the div tag from which the widget is displayed.
SAP Jam Administrator Guide Integrations
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
223
5. In the Page URL text box, enter the URL of the external web page in which the widget it embedded. It is the initial content of this page that will be displayed in the SAP Jam feed. 6. Optionally, in the Group ID (optional) text box, enter the ID for the group in which you want the external page to have an entry added to that group's feed (group wall). You can get this ID from the last segment of the group's URL. For example, in the group URL, https:// .sapjam.com/groups/about_page/6jAzl7p5W9gtIyEv6O7TAQ, you would use "6jAzl7p5W9gtIyEv6O7TAQ".
Note If you leave this field blank, the widget will add the shares to your company's members' walls. 7. To include your company logo in the shared content, select the Use custom branding option. This is the logo configured in your SAP Jam's
Admin
Branding and Support options .
8. At any point in configuring your share widget, you can click Preview to see both a rendered example of the current settings and an example of the script that is set by the current options. 9. When you are satisfied with the configuration of your widget, copy the JavaScript from the bottom text box of the Preview area and paste it into your web page. Your script should look something like this: SAP Jam Div-Based Widget var w = sap.jam.shareWidget.create( "https://.sapjam.com/c/sfcubetree01.com/widget/v1/share", "myDiv", { url: "http://www.example.com/some-page.html", create_button: true, branding: true }); Also, ensure that you have the div with the ID from step 3 in your HTML page, and that you call the script from within that div. For example, you could paste the following into the body of an external web page: Some Page var w = sap.jam.shareWidget.create( "https://.sapjam.com/c/sfcubetree01.com/widget/v1/share", "myDiv", { url: "http://www.example.com/some-page.html", create_button: true, branding: true });
224
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Integrations
4.9
Use the SAP Jam API
SAP Jam provides APIs that allow you to integrate SAP Jam features into your business critical applications, and data from your business critical applications into SAP Jam. The majority of these API calls are OData APIs. There are a very few of old REST API calls that have not yet been migrated to OData, but these will soon be migrated to OData API calls. New features will only be developed in the OData API. The SAP Jam API is available to all Enterprise customers (see SAP Jam editions in About SAP Jam [page 5]). Sites of interest are: ● SAP Jam API Documentation: The full SAP Jam API Reference and related documentation. ● SAP Jam Developer Community
SAP Jam Administrator Guide Integrations
: The online support community of and for SAP Jam developers.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
225
5
Get support
5.1
Request Support
To file a SAP Jam Support request, please see: https://csauthfs.successfactors.com/adfs/ls/
.
This is the same portal used to request support for all SuccessFactors modules, including SAP Jam. SAP Jam adheres to the same Service Level Agreements and Case Priorities as all SuccessFactors modules. The case priorities for SAP Jam product defects are: ● P1 — No Users Can Access the SAP Jam Instance ● P2 — Some users Cannot Access the SAP Jam Instance ● P3 — Product Defect / Integration Request ● P4 — How-To Question
226
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP Jam Administrator Guide Get support
Important Disclaimers and Legal Information
Coding Samples Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, unless damages were caused by SAP intentionally or by SAP's gross negligence.
Accessibility The information contained in the SAP documentation represents SAP's current view of accessibility criteria as of the date of publication; it is in no way intended to be a binding guideline on how to ensure accessibility of software products. SAP in particular disclaims any liability in relation to this document. This disclaimer, however, does not apply in cases of wilful misconduct or gross negligence of SAP. Furthermore, this document does not result in any direct or indirect contractual obligations of SAP.
Gender-Neutral Language As far as possible, SAP documentation is gender neutral. Depending on the context, the reader is addressed directly with "you", or a gender-neutral noun (such as "sales person" or "working days") is used. If when referring to members of both sexes, however, the third-person singular cannot be avoided or a gender-neutral noun does not exist, SAP reserves the right to use the masculine form of the noun and pronoun. This is to ensure that the documentation remains comprehensible.
Internet Hyperlinks The SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a hint about where to find related information. SAP does not warrant the availability and correctness of this related information or the ability of this information to serve a particular purpose. SAP shall not be liable for any damages caused by the use of related information unless damages have been caused by SAP's gross negligence or willful misconduct. All links are categorized for transparency (see: http://help.sap.com/disclaimer).
SAP Jam Administrator Guide Important Disclaimers and Legal Information
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
227
www.sap.com/contactsap
© 2015 SAP SE or an SAP affiliate company. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP SE or an SAP affiliate company. 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 http://www.sap.com/corporate-en/legal/copyright/ index.epx for additional trademark information and notices.
View more...
Comments