Overview

This cookbook attempts to gather all of the information an administrator needs to setup and configure the OpenSocial Component for IBM Domino, IBM Notes, and IBM iNotes release 9.0 and above. This cookbook is for administrators who wish to enable Notes and iNotes clients to render OpenSocial gadgets and Embedded Experiences. Also the slides from this years Connect2014 JumpStart session on deploying the OpenSocial Component are available HERE

If one only wishes to support Widgets in iNotes and does not wish to support OpenSocial gadgets or Embedded Experiences in Notes or iNotes, then please refer to the following documentation that outlines the necessary steps for supporting Widgets in iNotes 9.0 and above:
For 9.0: Widgets, Live Text, and OpenSocial Admin Documentation Updates for IBM iNotes 9.0
For 9.0.1: Configuring the Domino Open Social component for iNotes clients

IMPORTANT: The OpenSocial Component is only supported on IBM Domino servers version 9.0 and above. IBM XWork servers are not supported.

This cookbook is a work in progress. Certain sections are marked as Coming soon... and will be completed in the coming days and weeks.

Note: If you are a developer and only wish to setup an environment to develop applications that use OpenSocial gadgets and Embedded Experiences, you should check out this article on the IBM Social Business Toolkit website: Enabling OpenSocial & Embedded Experiences Support on IBM Notes & Domino 9.0 Social Edition

Understanding the Concepts

Terminology
Learning the terminology involved with the new OpenSocial Component functionality is crucial to understanding the deployment and configuration process. This article defines the key terms.

Deployment Architecture
The OpenSocial Component introduces new components to the traditional Domino deployment model. This article shows the deployment architecture and where the components fit.

Gadget rendering process
OpenSocial Widgets and Embedded Experiences render in the Notes and iNotes clients via the gadget rendering process which relies on the setup and configuration in this cookbook. This article highlights this process for the purpose of educating administrators so that they may understand and troubleshoot the process.

Widget approval process
OpenSocial Component functionality in Notes and iNotes, including Embedded Experiences, relies on a trust mechanism that is established via the My Widgets framework. This article outlines how Widgets are created and approved to establish this trust.

Gadget data flow
OpenSocial Component functionality in Notes and iNotes relies on several different pieces of data, including proxy rules, OAuth consumer information, and gadget capability information. This article outlines how this data is used and how its use can be customized.

Installation and Configuration

Before you begin
Before an administrator begins deploying and configuring the OpenSocial Component, there are some pre-requisites that need to be met. This article outlines the pre-requisites for an administrator.

Installation
This article outlines the installation steps that need to be taken for Domino, Notes, and iNotes to enable the OpenSocial Component functionality.

Database creation and configuration
The OpenSocial Component relies on two databases: a Widget Catalog and the Credential Store. This article outlines how those databases are created and configured.

User-centric settings
OpenSocial Component functionality must be enabled for end users via policy. This article outlines policy and other user-centric settings that must be enabled.

Server-centric settings
OpenSocial Component functionality must be enabled for the servers involved via configuration settings. This article outlines the configuration settings that must be enabled.

Production Deployment: Clustering and SSL Considerations
Production deployments require SSL for security and Clustering for scalability. This article shows how to turn a pilot deployment into a production deployment.

Verification and Integration

Verification
Once the OpenSocial Component is installed and configured, administrators need to verify that their environment is working properly. This article outlines how an administrator can do such verification.

Integration with IBM Connections
The OpenSocial Component enables Notes and iNotes clients to integrate with IBM Connections 4.0 via Embedded Experiences and Activity Streams. This article outlines how an administrator performs such integration.

Integration with XPage Embedded Experiences
XPages can be leveraged as embedded experiences in Notes and iNotes. This article outlines the considerations one should make to enable this functionality.

Troubleshooting

Collecting Support Data
In the event that verification of the OpenSocial Component fails, an administrator will need to collect support data. This article outlines how an administrator can collect support data for Notes, iNotes, and Domino.

Troubleshooting
In the event that verification of the OpenSocial Component fails, an administrator may need to troubleshoot his or her environment. This article outlines how an administrator can do such troubleshooting.

Technotes for the OpenSocial Component
Various Technical Notes have been created for the OpenSocial Component. This article lists the Technotes that have been created.