Show110 - Make your business Open and Social using IBM Notes Social Edition 9.0

© 2013 IBM Corporation

SHOW110 Make your business Open and Social using IBM Notes Social Edition 9.0Yun Zhi Lin | Advisory Software Engineer | IBM

Stanton Sievers | Staff Software Engineer | IBM

2 © 2013 IBM Corporation

Please note:

IBM’s statements regarding its plans, directions, and intent are subject to change or withdrawal without notice at IBM’s 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.


Giving Credit

This presentation mentions the following Copyrights and Trademarks─ IBM® Notes®─ IBM® iNotes®─ IBM® Domino® Administrator─ IBM® Domino®─ IBM® Connections®─ IBM® Notes® Social Edition─ IBM® iNotes® Social Edition─ Apache Shindig ™


About Us

Yun Zhi has been working at IBM for the past 6 years. He is the lead template developer for Widget Catalog and OAuth Credential Store. He has in depth of knowledge in many technical areas, including XPages and Eclipse plugin development. Over the past year, his major focus is OpenSocial. He reaches out to help business partners and other product teams to integrate their applications with OpenSocial.

Stanton has been working at IBM for 3.5 years. He has worked on the Java UI APIs for the Notes client and Eclipse plugin development for the Notes client in general. Most recently Stanton has been involved in the integration of OpenSocial into enterprise applications such as Notes and iNotes, and as part of that role manages IBM internal deployments of Notes and iNotes Social Edition. Stanton is also involved in the OpenSocial community via the Apache Shindig project, to which he is a regular contributor.


Agenda

Terminology Deployment Overview

─ High-Level Deployment View─ Detailed Deployment View

Setup and Configuration─ Pre-requisites

– Notes pre-requisites– Domino pre-requisites– Installing the OpenSocial Component on Domino

─ Detailed Steps– Database creation and configuration– Creating a Managed Account– Policy Settings– Configuration Settings– Verification

IBM Connections 4 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/

http://opensocial.org/

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.

http://shindig.apache.org/


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








High-Level Deployment View

The OpenSocial Component is deployed and configured as two server components

─ A Domino mail server– Supports iNotes and hosts the widgets catalog

─ A Domino server running Shindig– Hosts 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 (and Show and Tell sessions)



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








Detailed Deployment View Server-side

─ Install Domino 9.0– Includes toolbox.ntf and websecuritystore.ntf needed for the Widget Catalog and Credential

Store, respectively─ Install the OpenSocial Component on each Domino 9.0 Server

– Includes OSGi bundles• Shindig libraries are included as a bundle

Client-side─ Notes

– Install Notes Social Edition 9.0 with the OpenSocial Component included─ iNotes

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


Detailed Deployment View

A single server deployment The OpenSocial Component is installed on both Notes and Domino The Widget Catalog replicates to the Notes client


Agenda








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








Domino Pre-requisites

IBM Domino 9.0 with OpenSocial Component OpenSocial Component is a separate “add-on installer”


Agenda








Installing the OpenSocial Component on Domino

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








Creating the Credential Store

Issue the command keymgmt create nek <nekname>─ Replace <nekname> with your own value

Verify the NEK is created successfully



Issue the command keymgmt create credstore <nekname>─ The <nekname> 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

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


Configuring the Credential Store 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”


Configuring the Widget Catalog 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

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








Creating a Managed Account

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

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



Fill the Advanced tab as below Click the Edit list... button


Creating a Managed Account 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

http://bit.ly/ManagedAccounts


Agenda








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


Policy Settings – Desktop Settings 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

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

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

http://bit.ly/WidgetsPolicy


Policy Settings – Desktop Settings Add the Managed Account

─ On the Accounts tab click Update Links

─ On the resulting dialog click Selected supported

─ Click OK


Policy Settings – Desktop Settings 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

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


Policy Settings – Security Settings 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...


Policy Settings – Security Settings 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

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


Policy Settings – Security Settings 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 technote

– http://www-01.ibm.com/support/docview.wss?uid=swg21384073– Reference # 1384073

http://www-01.ibm.com/support/docview.wss?uid=swg21384073


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








Configuration Settings

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

Item ValueENABLE_EE 1iNotes_WA_EnableEE 1iNotes_WA_LiveText 1iNotes_WA_Widgets 1iNotes_WA_OpenSocial 1iNotes_WA_Widgets_AutoUpdate_Group iNotesUsersiNotes_WA_Widgets_AutoUpdate_Day 1


Configuration Settings Enter each Item-Value

pair

Once all values are entered click OK



Verify the NOTES.INI Settings


Configuration 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








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., <gadget name>.extension.xml─ A file for the proxy rules, e.g., <gadget name>.proxy.xml─ A file for the OAuth information, e.g., <gadget name>.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


Importing a Widget into the Widget Catalog 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


Unit Test Verification in iNotes 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


Unit Test Verification in iNotes

Double-click on the widget to render it in a new Tab Verify that the “Success” message appears in the gadget


Agenda









IBM Connections 4 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

http://bit.ly/IC4OAuthRegistration






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



The newly created widget document will open automatically 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






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



The newly created widget document will open automatically 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 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!


Thank you!Questions?


Related Sessions

JMP102 : Extending Your App Arsenal With OpenSocial AD103 : Social Standards Across IBM Connections, IBM Notes, IBM iNotes and

IBM Domino ID100 : What's New in IBM Notes 9.0 Social Edition ID101 : What's New in IBM iNotes 9.0 Social Edition ID301 : What's New and Coming in IBM Connections AD212 : Whats New in IBM Lotus Notes Widgets and LiveText: Linking Your

Data to the World!


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

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/

132 © 2013 IBM Corporation

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 IBM’s 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 IBM’s 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.

All references to Renovations refer to a fictitious company and are used for illustration purposes only.

Technology

Show110 - Make your business Open and Social using IBM Notes Social Edition 9.0