ibm domino 9.0 social edition opensocial component deployment

IBM Domino 9.0 Social Edition OpenSocial Component Deployment

@rahulgsj
http://www.linkedin.com/in/rgarg

Please note:

IBMs statements regarding its plans, directions, and intent are subject to change or withdrawal without notice at IBMs sole discretion. Information regarding potential future products is intended to outline our general product direction and it should not be relied on in making a purchasing decision. The information mentioned regarding potential future products is not a commitment, promise, or legal obligation to deliver any material, code or functionality. Information about potential future products may not be incorporated into any contract. The development, release, and timing of any future features or functionality described for our products remains at our sole discretion.

Performance is based on measurements and projections using standard IBM benchmarks in a controlled environment. The actual throughput or performance that any user will experience will vary depending upon many factors, including considerations such as the amount of multiprogramming in the user's job stream, the I/O configuration, the storage configuration, and the workload processed. Therefore, no assurance can be given that an individual user will achieve results similar to those stated here.

Agenda

Terminology

Deployment Overview

High-Level Deployment View

Detailed Deployment View

Setup and Configuration

Pre-requisitesNotes pre-requisites

Domino pre-requisites

Installing the OpenSocial Component on Domino

Detailed StepsDatabase creation and configuration

Creating a Managed Account

Policy Settings

Configuration Settings

Verification

IBM Connections 4/4.5 Integration

Terminology

OpenSocial

OpenSocial is an open standard which defines APIs that can be used to build social applications using HTML, JavaScript, and CSS. The specification includes both JavaScript and REST APIs. OpenSocial leverages many other standards, such as Activity Streams and OAuth.

See: http://opensocial.org/

Embedded Experiences

Embedded experiences is a method of embedding the experience or functionality from one application into a different, host application. The end user experiences the 3rd party application in their host application environment as if they were using it directly from the 3rd party provider.

Activity Streams

Activity Streams is an open standard which defines a data model to represent a stream or list of actions performed by users and applications. This specification DOES NOT define any APIs, it simply defines the data model.

See: http://activitystrea.ms/

Terminology

Apache Shindig

Apache Shindig is an OpenSocial container and helps to start hosting OpenSocial apps quickly by providing the code to render gadgets, proxy requests, and handle REST and RPC requests. Shindig is the reference implementation for the OpenSocial specification.

See: http://shindig.apache.org/

Domino Server with Shindig

A Domino Server with the OpenSocial Component installed. This server runs portions of the Apache Shindig project as a web application based on OSGi. This server is responsible for rendering OpenSocial gadgets.

DOTS

An acronym for Domino OSGi Tasklet Service, it is a server task that allows OSGi plugins to contribute scheduled tasklets that perform some amount of work on the server. The Widgets framework in iNotes contributes a DOTS tasklet to push Widgets to iNotes users by policy.

Terminology

Widget Catalog

A database that is used to store metadata (i.e. a widget) about services for use within Notes and iNotes. In the case of OpenSocial Component, the focus is on OpenSocial gadgets for which widgets are created and stored in the Widget Catalog.

Credential Store

A secure database that is used to store proxy rules, gadget capabilities, and OAuth information on the Domino Server with Shindig.

Agenda

Terminology

Deployment Overview









Policy Settings


Verification



The OpenSocial Component is deployed and configured as two server components

A Domino mail serverSupports iNotes and hosts the widgets catalog

A Domino server running ShindigHosts the credential store application

Renders OpenSocial Gadgets

Run the OpenSocial Component installer once per server, configure to differentiate


Single server

Simplest; useful for development and testing


Single mail server and single Shindig server

Useful for trying out Social Edition with an existing mail server


Clustered mail servers and single Shindig server

Useful for trying out Social Edition with an existing mail server cluster

Likely what small deployments would look like


During the course of this session, this is the type of environment that will be configured

Agenda

Terminology

Deployment Overview









Policy Settings


Verification



Server-side

Install Domino 9.0Includes toolbox.ntf and websecuritystore.ntf needed for the Widget Catalog and Credential Store, respectively

Install the OpenSocial Component on each Domino 9.0 ServerIncludes OSGi bundlesShindig libraries are included as a bundle

Client-side

NotesInstall Notes Social Edition 9.0 with the OpenSocial Component included

iNotesSet a few notes.ini settings on the server to enable functionality in the iNotes Forms9 file.


A single server deployment

The OpenSocial Component is installed on both Notes and Domino

The Widget Catalog replicates to the Notes client

Agenda

Terminology

Deployment Overview









Policy Settings


Verification


Notes Pre-requisites

IBM Notes 9 Social Edition

New OpenSocial Component on the Custom Setup page of the installer

Add ENABLE_EE=1 and $ENABLE_EE=1 in Notes.ini

Agenda

Terminology

Deployment Overview









Policy Settings


Verification


Domino Pre-requisites

IBM Domino 9.0 with OpenSocial Component

OpenSocial Component is a separate add-on installer

Agenda

Terminology

Deployment Overview









Policy Settings


Verification



Pick a place to save install resources


Welcome to the installer!


Accept the license agreement


Domino program directory will be auto-completed based on the Domino install


Domino data directory will be auto-completed based on the Domino install


Review the location of program and data files before continuing


The installer will run and when finished will land you on this success page

Agenda

Terminology

Deployment Overview









Policy Settings


Verification


Creating the Credential Store

Issue the command keymgmt create nek

Replace with your own value

Verify the NEK is created successfully


Issue the command keymgmt create credstore

The is same as previous step

Verify credstore.nsf is created under data\IBM_CredStore


For more information on the credential store, see the Using a credential store to share credentials section of the IBM Notes and Domino 9.0 Social Edition Public Beta new features and release notes documentation

http://bit.ly/PublicBetaReleaseNotes

Configuring the Credential Store

Go to the Access Control List for the credential store database


Add WidgetCatalogAdmins to the ACL list


Assign Manager Access and Admins role for Widget Catalog Admins

LocalDomainServers have Manager access and the Admins role by default


Open the OAuth Token Store database (credstore.nsf)

Open the Configuration view

Click Create Encryption Key button

Click Create new encryption key in the pop up dialog

Verify the encryption key is created successfully

Click OK to close all the dialogs

The configuration of Credential Store is complete !

Creating the Widget Catalog

Create a Widget Catalog database

Configuring the Widget Catalog

Go to the Access Control List for the widget catalog database


Add WidgetCatalogAdmins to the ACL list


Assign Manager Access and Admins role for WidgetCatalogAdmins


Open the Widget Catalog database

Go to View Agents

Enable the PushToCredStore agent

More information about Roles & Agents can be found on :

http://www-01.ibm.com/support/docview.wss?rs=899&uid=swg21459846


Open the Configuration view of catalog

Click Configure Credential Store button


Click Browse in the pop up dialog

Select the credstore.nsf created in previous steps and click Open


Verify the information and click OK

The configuration of the Widget Catalog is complete!

Agenda

Terminology

Deployment Overview









Policy Settings


Verification



Open the Accounts view

Click the Add Account button in the action bar


Fill the Basics tab as below

Account server name: http://ics-snt-2013.renovations.com/fiesta/container

Domino single sign-on server: ics-snt-2013.renovations.com


Fill the Advanced tab as below

Click the Edit list... button


Add the following parameter

Item: PreferredUsernameField

Value: fullname


Verify the information in the properties list

Click Save & Close to close the new account


For more information on Managed Accounts, see http://bit.ly/ManagedAccounts

Agenda

Terminology

Deployment Overview









Policy Settings


Verification


Policy Settings

Augment an existing policy with new configuration

Desktop settings

Security settings

Mail settings

Policy Settings Desktop Settings

Open the IBMConnect2013DesktopSettings document in edit mode

Go to the Widgets tab


Widget catalog server

ICS-SNT-2013/IBMConnect2013

Widget catalog application name

toolbox.nsf

Widget catalog categories to install

WidgetsForAll

Gadget Server URL

http://ics-snt-2013.renovations.com/fiesta

For more information on configuring Widget policy, see: http://bit.ly/WidgetsPolicy


Add the Managed Account

On the Accounts tab click Update Links

On the resulting dialog click Selected supported

Click OK


Select the Security Token Account

Click OK

The Security Token Account now appears in the Account Links section


Go to the Custom Settings tab

Click Edit list... in the Notes.ini tab


Add ENABLE_EE and $ENABLE_EE items with values of 1

Set the Item and Value fields

Click Add/Modify Value >>

Click OK


Verify the Notes.ini values

For more information on Custom Settings, see http://bit.ly/CustomSettings


Click Save & Close to save the Desktop Settings document

Policy Settings Security Settings

Open the IBMConnect2013SecuritySettings document in edit mode

Push an ECL setting to Notes users

In the Execution Control List tab, click Edit


In the resulting dialog, click Add...


In the Add User dialog enter WidgetCatalogAdmins or search the directory for it

Select WidgetCatalogAdmins and check the Ability to configure Widget capabilities checkbox

Click OK


Whitelist the server requests

In the Proxies tab, click Edit list...


Add a proxy rule

Context: /xsp/proxy/BasicProxy

URL: http://ics-snt-2013.renovations.com

Actions: GET,POST

Cookies: DomAuthSessId,LtpaToken,LtpaToken2

Mime-types: *

Headers: *

Click Add/Modify Value >>

Click OK


Verify the proxy rule

Click Save & Close to save the Security Settings document

Policy Settings Mail Settings

No specific Mail policy settings need to be set

My Widgets specific Mail settings have been deprecated in favor of desktop settings in Domino 9

For Desktop policy settings to apply to iNotes users, a Mail policy is required

See this technotehttp://www-01.ibm.com/support/docview.wss?uid=swg21384073

Reference # 1384073

Policy Settings

To ensure iNotes users receive the policies applied to them the Admin Process much process mail policies

Default interval is 12 hours

Execute manually via tell adminp process mailpolicy in the server console

Policy Settings

Verify that the Admin Process was successful

Agenda

Terminology

Deployment Overview









Policy Settings


Verification



Configuration Settings are used to configure the OpenSocial component on the Domino Server

Go to the Configuration tab

Select the Server Configurations view

Select the configuration document for the server and select Edit Configuration


Go to the NOTES.INI Settings tab

Click Set/Modify Parameters


Add the following parameters by entering each Item and Value pair into the corresponding fields and clicking Add/Update

ItemValue

ENABLE_EE1

iNotes_WA_EnableEE1

iNotes_WA_LiveText1

iNotes_WA_Widgets1

iNotes_WA_OpenSocial1

iNotes_WA_Widgets_AutoUpdate_GroupiNotesUsers

iNotes_WA_Widgets_AutoUpdate_Day1


Enter each Item-Value pair

Once all values are entered click OK


Verify the NOTES.INI Settings


Go to the Social Edition tab

On the Basics tab fill out the following fields

Locked domain suffix: -locked.renovations-gadgets.com

Domain name for unlocked gadgets and content fetching: unlocked.renovations-gadgets.com

Shindig server(s) host name: ics-snt-2013.renovations.com

The remaining fields can be left blank to accept the defaults which is acceptable for the purpose of this session.

No Advanced settings need to be filled out by default


Click Save & Close to save the Configuration Settings document

The server needs to be restarted for all changes to take affect

Agenda

Terminology

Deployment Overview









Policy Settings


Verification


Verify Policy in Notes

In Notes, go to File Preferences

In the Accounts section, verify the Security Token Account configured earlier is listed

Verify Policy in Notes

In the Widgets section, verify the Catalog server and Catalog name fields are populated

Note: The Categories to install field will be populated once some Widgets are added to the catalog

Verify Policy in iNotes

In iNotes, verify that the My Widgets sidebar panel appears

In the My Widgets sidebar menu, verify that Browse Widgets Catalog... appears

Note: The catalog can be opened, but no Widgets have been populated yet

Importing a Widget into the Widget Catalog

A Widget can be imported into the Widget Catalog as a series of files

A file for the Widget definition, e.g., .extension.xml

A file for the proxy rules, e.g., .proxy.xml

A file for the OAuth information, e.g., .oauth.xml

Only the Widget definition file is required

Selecting the Widget definition file for import will automatically locate the other files in the same directory


Open the Widget Catalog in Domino Administrator

Click Import


Browse to the widget's extension.xml file in the dialog

Click Open

Note: There are no proxy.xml or oauth.xml files because the gadget doesn't use OAuth and the default proxy rules are acceptable


The newly created widget document will open automatically

Click Edit


Assign this widget to the Unit Test and WidgetsForAll category

Reminder: WidgetsForAll is the category that is setup to be pushed by policy


Click the Approve button


Click OK to close the proxy dialog


The Widget is approved !

We are ready to test it !

Unit Test Verification in Notes

Open the Notes client

Replicate the Widget Catalog (Note: this will happen automatically during the normal replication schedule, but is done manually here for expediency)


You will see the widget is installed in Notes.


Double click the widget to render it in a new window

Verify that the Success message appears in the gadget

Unit Test Verification in iNotes

In the server console, execute tell dots run UpdateWidgetsTask to push Widgets to iNotes users by policy

Note: This would normally happen on a daily basis based on the iNotes_WA_Widgets_AutoUpdate_Day value set in configuration settings


In iNotes, in the My Widgets sidebar, the widget should be installed

The asterisk next to the widget indicates it was pushed by policy and cannot be removed


Double-click on the widget to render it in a new Tab

Verify that the Success message appears in the gadget

Agenda

Terminology

Deployment Overview









Policy Settings


Verification



IBM Connections 4/4.5 provides two OpenSocial Gadgets for use within IBM Notes, IBM iNotes, and elsewhere

An Embedded Experiences gadget transforms Connections notifications into rich, interactive experiences

An Updates gadget brings the activity stream experience from the Connections homepage into your Notes client


Export the IC4 widget configuration

Launch a WSAdmin console

Load the gadgetAdmin.py file


Execute the NotesRegistrar.registerGadgets command with these arguments

appId the ID of the OAuth2 application to register for the gadgets

appLabel the label for the OAuth2 application to be registered

callbackURL the OAuth2 callback URL for the Domino environment

outputDir the directory in which the Widget configuration files will be created

For more information related to IBM Connections 4 OAuth Registration, see: http://bit.ly/IC4OAuthRegistration


Click Import



Select the AS.Gadget.extension.xml file

Reminder: selecting the extension.xml file will automatically find the co-located oauth.xml and proxy.xml files for the same prefix, i.e., AS.Gadget

Click Open


When prompted to replace existing documents, if they exist, click Yes

Click OK



Click Edit


Assign this widget to the WidgetsForAll category

Reminder: WidgetsForAll is the category that is setup to be pushed by policy





Click OK to close the OAuth dialog

Note: the Consumer Key and Consumer Secret will not appear in the UI


The Updates Widget is now approved


Click Import



Select the EE.Gadget.extension.xml file

Reminder: selecting the extension.xml file will automatically find the co-located oauth.xml and proxy.xml files for the same prefix, i.e., EE.Gadget

Click Open


When prompted to replace existing documents, if they exist, click Yes

Click OK



Click Edit


Assign this widget to the WidgetsForAll category

Remifnder: WidgetsForAll is the category that is setup to be pushed by policy





Click OK to close the OAuth dialog

Note: the Consumer Key and Consumer Secret will not appear in the UI


The Connections EE Gadget Widget is now approved


Force a reload of all of the OAuth and proxy data (default 1 hour refresh interval)

In the server console, execute tell http osgi social refresh all


In the server console, execute tell dots run UpdateWidgetsTask to push Widgets to iNotes users by policy

Note: This would normally happen on a daily basis based on the iNotes_WA_Widgets_AutoUpdate_Day value set in configuration settings


Open IBM Notes Social Edition as Samantha Daryn

The two IBM Connections 4 Widgets appear in the My Widgets sidebar


Launch Mail for Samantha

Open a notification from IBM Connections 4

When prompted, authorize the gadget this is the OAuth Dance



The Connections 4 notification now renders as an Embedded Experience!


There is a new Shortcut icon for Updates

There is also an entry in the Open list for Updates


Opening Updates via the Shortcut icon or the Open list will open Updates in a new tab

Note: You don't have to do the OAuth Dance again, because the OAuth tokens are shared between Embedded Experiences and Updates


Clicking on individual entries will open an Embedded Experience, just like the IBM Connections 4 homepage and the notitification in mail


Open IBM iNotes Social Edition as Samantha Daryn

The IBM Connections 4 EE Widget appears in the My Widgets sidebar

Reminder: the Updates Widget is for Notes only, and it not installed in iNotes per the Platform field in the Widget document


Open a notification from IBM Connections 4

It is now renders as an Embedded Experience!

Get Social. Do Business.

ibm in 3 shades of blueThanks!

QuestionsEmail: [email protected]: @RahulGSJLinkedIn: linkedin.com/in/rgarg

Resources

Useful Links

http://bit.ly/PublicBetaForum

http://bit.ly/PublicBetaReleaseNotes

http://bit.ly/PublicBetaAdminGuide

http://bit.ly/WidgetsPolicy

http://bit.ly/CustomSettings

http://bit.ly/ManagedAccounts

http://bit.ly/IC4OAuthRegistration

http://opensocial.org

http://opensocial2.org:8080

Legal disclaimer

IBM Corporation 2013. All Rights Reserved.The information contained in this publication is provided for informational purposes only. While efforts were made to verify the completeness and accuracy of the information contained in this publication, it is provided AS IS without warranty of any kind, express or implied. In addition, this information is based on IBMs current product plans and strategy, which are subject to change by IBM without notice. IBM shall not be responsible for any damages arising out of the use of, or otherwise related to, this publication or any other materials. Nothing contained in this publication is intended to, nor shall have the effect of, creating any warranties or representations from IBM or its suppliers or licensors, or altering the terms and conditions of the applicable license agreement governing the use of IBM software.References in this presentation to IBM products, programs, or services do not imply that they will be available in all countries in which IBM operates. Product release dates and/or capabilities referenced in this presentation may change at any time at IBMs sole discretion based on market opportunities or other factors, and are not intended to be a commitment to future product or feature availability in any way. Nothing contained in these materials is intended to, nor shall have the effect of, stating or implying that any activities undertaken by you will result in any specific sales, revenue growth or other results.If the text contains performance statistics or references to benchmarks, insert the following language; otherwise delete: Performance is based on measurements and projections using standard IBM benchmarks in a controlled environment. The actual throughput or performance that any user will experience will vary depending upon many factors, including considerations such as the amount of multiprogramming in the user's job stream, the I/O configuration, the storage configuration, and the workload processed. Therefore, no assurance can be given that an individual user will achieve results similar to those stated here.If the text includes any customer examples, please confirm we have prior written approval from such customer and insert the following language; otherwise delete: All customer examples described are presented as illustrations of how those customers have used IBM products and the results they may have achieved. Actual environmental costs and performance characteristics may vary by customer.Please review text for proper trademark attribution of IBM products. At first use, each product name must be the full name and include appropriate trademark symbols (e.g., IBM Lotus Sametime Unyte). Subsequent references can drop IBM but should include the proper branding (e.g., Lotus Sametime Gateway, or WebSphere Application Server). Please refer to http://www.ibm.com/legal/copytrade.shtml for guidance on which trademarks require the or symbol. Do not use abbreviations for IBM product names in your presentation. All product names must be used as adjectives rather than nouns. Please list all of the trademarks that you use in your presentation as follows; delete any not included in your presentation.Please review text for proper trademark attribution of IBM products. At first use, each product name must be the full name and include appropriate trademark symbols (e.g., IBM Lotus Sametime Unyte). Subsequent references can drop IBM but should include the proper branding (e.g., Lotus Sametime Gateway, or WebSphere Application Server). Please refer to http://www.ibm.com/legal/copytrade.shtml for guidance on which trademarks require the or symbol. Do not use abbreviations for IBM product names in your presentation. All product names must be used as adjectives rather than nouns. Please list all of the trademarks that you use in your presentation as follows; delete any not included in your presentation.If you reference Adobe in the text, please mark the first use and include the following; otherwise delete: Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, and/or other countries.If you reference Java in the text, please mark the first use and include the following; otherwise delete: Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.If you reference Microsoft and/or Windows in the text, please mark the first use and include the following, as applicable; otherwise delete: Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both.If you reference Intel and/or any of the following Intel products in the text, please mark the first use and include those that you use as follows; otherwise delete: Intel, Intel Centrino, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries.If you reference UNIX in the text, please mark the first use and include the following; otherwise delete: UNIX is a registered trademark of The Open Group in the United States and other countries.If you reference Linux in your presentation, please mark the first use and include the following; otherwise delete: Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both. Other company, product, or service names may be trademarks or service marks of others.If the text/graphics include screenshots, no actual IBM employee names may be used (even your own), if your screenshots include fictitious company names (e.g., Renovations, Zeta Bank, Acme) please update and insert the following; otherwise delete: All references to [insert fictitious company name] refer to a fictitious company and are used for illustration purposes only.

2013 IBM Corporation

IBM Confidential

Click to edit the outline text format

Second Outline LevelThird Outline LevelFourth Outline LevelFifth Outline Level

Sixth Outline Level

Seventh Outline Level

Eighth Outline Level

Ninth Outline Level


IBM Confidential

Click to edit the outline text formatSecond Outline LevelThird Outline LevelFourth Outline LevelFifth Outline LevelSixth Outline Level


Click to edit the outline text formatSecond Outline LevelThird Outline LevelFourth Outline LevelFifth Outline LevelSixth Outline Level


ibm domino 9.0 social edition opensocial component deployment

Technology