SAP Knowledge Base Article - Public

2312951 - What is an Open Social Gadget?

Symptom

What is an Open Social Gadget?

Environment

SAP Jam

SAP Jam Enterprise Edition

Resolution

Please open the Admin guide for additional screeshots:

SAP Jam Admin & User Guides: http://help.sap.com/sapjam

 

5.5 OpenSocial Gadgets

OpenSocial gadgets provide a mechanism to extend SAP Jam's abilities to interact with any software or service.

SAP Jam provides access to pre-built, third-party OpenSocial gadgets that are ready to use by simply enabling them. You can also download some existing OpenSocial gadgets from the SAP Jam Sample Code GitHub site's OpenSocial Gadgets section. There is also support for your organization to develop your own OpenSocial gadgets, and to make those available to your SAP Jam users. If you choose to develop your own OpenSocial gadget, please see the SAP Jam OpenSocial Gadgets section of the SAP Jam Developer Guide for information on developing an OpenSocial gadget. For information on how to add, enable, and manage OpenSocial gadgets, please see the following:

  • ●  To import an OpenSocial gadget configuration [page 151] explains how to upload a gadget configuration file.

  • ●  To add an OpenSocial gadget [page 152] explains how to register a gadget that does not have a configuration

    file.

  • ●  To enable an OpenSocial gadget [page 156] explains the various ways in which you can enable a gadget and it

    provides an explanation of the warning that is displayed when you first enable a particular OpenSocial gadget

    [page 156].

  • ●  To manage OpenSocial gadgets [page 156] explains how to view, edit, or delete an OpenSocial gadget.

    To import an OpenSocial gadget configuration

    You can upload a gadget configuration file for any OpenSocial gadget that you download from the SAP Jam Sample Code GitHub site's OpenSocial Gadgets section. Gadget configuration files are the files that you get when you click on Export Gadget Configuration in a gadget's administration page. To import an OpenSocial gadget's configuration file, do the following:

  1. From the Integrations OpenSocial Gadgets page, 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 on your device and upload it.

    After importing the file, the Register OpenSocial Gadget page displays with the file's configuration information shown in the form.

SAP Jam Administrator Guide
Integrations © 2016 SAP SE or an SAP affiliate company. All rights reserved. 151

3. Change the existing settings or fill in any missing settings as required and click Save.
You are returned to the
OpenSocial Gadgets page, with the gadget that you registered listed in the catalog.

To add an OpenSocial gadget

For OpenSocial gadgets that you have developed within your own organization, you must fill in the Register OpenSocial Gadget form, as described in the following:

1.

Access the Admin console [page 11] and select Integrations OpenSocial Gadgets from the left navigation sidebar.
The
OpenSocial Gadgets page displays.

2.

Figure 103: OpenSocial Gadgets catalog Click Add Gadget at the upper right corner of the page.

The Register OpenSocial Gadget page displays.

152

© 2016 SAP SE or an SAP affiliate company. All rights reserved.

SAP Jam Administrator Guide Integrations

Figure 104: The 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, but be certain that you are aware of implications of doing so before you enable it. This information is shown in the note in the procedure To enable an OpenSocial gadget [page 156].

  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 Product Setup > Custom Profile [page 186] 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.

    • ○  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 displays.

SAP Jam Administrator Guide
Integrations © 2016 SAP SE or an SAP affiliate company. All rights reserved. 153

8.

Table 24: The OAuth 1.0a Add Service Configuration dialog box

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 OpenSocial Gadgets page.

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 displays.

154

SAP Jam Administrator Guide © 2016 SAP SE or an SAP affiliate company. All rights reserved. Integrations

Table 25: The OAuth 2.0 Add Service Configuration dialog box

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 serv­

    ice.

  3. In the Client Secret text box, enter the consumer secret for your

    OAuth 2.0 service.

  4. Select the authorization Grant Type that you want to use.

  5. If you chose the SAML 2.0 Bearer Assertion, then you must also se­

    lect the SAML 2.0 Assertion Audience.

  6. Click OK to save these options, or click Cancel to abandon them.

    You are returned to the OpenSocial Gadgets page.

  1. From the Administrative Area drop-down menu, select the administrative area in which you want this gadget to be available. If you choose a specific area, the gadget will only be available for use in the groups in that area. If you choose "Company", the gadget will be available for use in all of the groups in your organization.

  2. From the Choose Display Language drop-down menu, select the language that you want used in the OpenSocial gadget.

  3. 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.

  4. When all of the above settings are complete and to your satisfaction, 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 Custom Gadgets tab's catalog.

SAP Jam Administrator Guide
Integrations © 2016 SAP SE or an SAP affiliate company. All rights reserved. 155

To enable an OpenSocial gadget

You can enable an OpenSocial gadget for use by the members of your organization's SAP Jam instance in several ways:

Table 26: The OAuth 2.0 Add Service Configuration dialog box

  • ●  Turn on the Enabled switch in the row for the gadget in the Third Party Gadgets tab.

  • ●  Turn on the Enabled switch in the row for the gadget in the Custom Gadgets tab.

  • ●  Select the Enabled option in the Register OpenSocial Gadget page.

  • ●  Turn on the Enabled switch in the View gadget page.

    The first time that you enable a particular OpenSocial gadget in your SAP Jam instance, the confirmation dialog box shown above will display. See the note below for an explanation of the warning about the profile data that will be made available to the gadget vendor.

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.

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 manage OpenSocial gadgets

To view the configuration of a gadget

SAP Jam Administrator Guide 156 © 2016 SAP SE or an SAP affiliate company. All rights reserved. Integrations

You can view the configuration of either a "Third Party Gadget" or a "Custom Gadget" by doing the following:

1. In either tab of the OpenSocial Gadgets page, click View on the row for the OpenSocial gadget whose configuration information you want to see.
An
OpenSocial Gadget: <gadget_name> page displays.

Figure 105: An OpenSocial Gadget view page

Note that the gadget information and preview sections are not shown.

  1. Optionally, to edit the gadget's configuration, click Edit near the top of the page.

  2. Optionally, to exit the View page, click OpenSocial Gadgets near the top of the page.

    You are returned to the OpenSocial Gadgets page.

  3. Note that you can Enable the gadget from this page. If you chose to do so, be certain that you are aware of

    implications of doing so [page 156] before you do.

To modify the configuration of a gadget
Note that you cannot modify Third Party Gadgets.
You can edit a "Custom Gadget" by doing the following:

1. In the Integrations OpenSocial Gadgets page, click on the Custom Gadgets tab. The OpenSocial Gadgets Custom Gadgets tab displays.

SAP Jam Administrator Guide
Integrations © 2016 SAP SE or an SAP affiliate company. All rights reserved. 157

2.

Figure 106: The OpenSocial Gadgets Custom Gadgets tab

Note that the gadget information and preview sections are not shown.
Find the custom gadget that you want to modify and click
Edit on the row for that gadget to modify its

configuration.
The
Edit OpenSocial Gadget page displays.

158

SAP Jam Administrator Guide © 2016 SAP SE or an SAP affiliate company. All rights reserved. Integrations

Figure 107: Edit an OpenSocial Gadget configuration

The Edit page is effectively identical to the Register OpenSocial Gadget page (so you can perform most of the

steps in To add an OpenSocial gadget [page 152]), 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.

To delete a Custom Gadget
Note that you cannot delete Third Party Gadgets.
You can delete a "Custom Gadget" by doing the following:

  1. In the Integrations OpenSocial Gadgets page, click on the Custom Gadgets tab. The OpenSocial Gadgets Custom Gadgets tab displays.

  2. Find the custom gadget that you want to modify and click Delete on the row for that gadget to modify its configuration.
    A delete confirmation dialog box displays.

Figure 108: Confirmation to delete an OpenSocial Gadget
You are returned to the
Custom Gadgets tab, where the selected gadget has been removed from the catalog.

SAP Jam Administrator Guide
Integrations © 2016 SAP SE or an SAP affiliate company. All rights reserved. 159

3. Click Delete.

You are returned to the Custom Gadgets tab, where the selected gadget has been removed from the catalog.

 

Keywords

SAP Jam SAP Jam Enterprise Open Social Gadgets   , KBA , LOD-SF-JAM , SAP Jam , How To

Product

SAP Jam 1207 ; SAP Jam 1210 ; SAP Jam 1302 ; SAP Jam 1305 ; SAP Jam 1308 ; SAP Jam 1311 ; SAP Jam 1405 ; SAP Jam 1408 ; SAP Jam 1508 ; SAP Jam 1511 ; SAP Jam 1602 ; SAP Jam 1605