Creating Open Social Widgets
This topic contains more advanced material about creating OpenSocial widgets for use in IBM® Notes®.
OpenSocial Widget type
About this task
The OpenSocial widget type supports creating widgets based
on existing OpenSocial gadgets. A widget developer can create an OpenSocial
widget by using the new OpenSocial widget wizard. OpenSocial widgets
can be used like other widget types in that you can perform these
tasks:
- Open them in a tab, new window, floating window, or in a sidebar panel
- Wire live text to widget actions
An OpenSocial gadget can also provide advanced features (such as using APIs, OAuth, and rendering in an embedded experience), as detailed in the Social Gadget Specification. Due to the use of advanced features, OpenSocial widgets need to be approved by an administrator before they are made available for client use. When a widget developer creates a widget, the developer needs to publish their widget to a corporate widget catalog. The widget catalog administrator then needs to approve the widget. Once approved, Notes® users can install the widget from the catalog, and render the widget in their clients.
Widget developers can create OpenSocial widgets
using:
- The Getting Started with Widgets toolbar action, or the menu command
- The My Widgets sidebar panel menu command
- The Configure a widget from the current context toolbar action when an OpenSocial Gadget is open in the Notes® embedded browser
Note: If
there is at least one Required feature that is not supported by the
client, the widget developer is not allowed to create the widget.
Enabling a URL for an embedded experience
About this task
Notes® includes
a page in the web widget
creation wizard to enable a URL for use as an embedded experience
in an email. In the wizard page, the widget developer can select a
check box and enter a URL that they want to be embedded into an email.
After the widget is published to the corporate widget catalog, and
approved by the widget catalog administrator, users can install the
widget and then have the ability to render the URL embedded in an
email.
The URL field can contain a wild card, so that many URLs from the same site can be trusted to be embedded in an email. Examples of URLs include:
The URL field can contain a wild card, so that many URLs from the same site can be trusted to be embedded in an email. Examples of URLs include:
- http://my.server.com/
- http://my.server.com/*
- http://my.server.com/directory
- http://my.server.com/directory/*
- http://my.server.com/directory/file.html
Note: Host names cannot contain a wild card.
To
use Microsoft™ Internet
Explorer (IE) for a given URL embedded experience, follow the web widget creation wizard,
except in the Select a web page dialog, choose IE under
the Open with - Embedded browser: option. This
tells the embedded experience code to use IE instead of XULRunner.
Note: This option is only supported
for Microsoft™ Windows™ operating systems.