This is a set of instructions on how to install the IBM Social SDK on on a IBM Domino server. It will cover two methods of install and deployment of the SDK. Firstly, there is the manual approach, and secondly, there is to use the Domino server's Eclipse Update Site NSF. Both approaches are valid though you may find that using the Update Site NSF is easier to manage.
You must have one of the following server configurations:
- Domino 9
- Domino 8.5.3 Upgrade Pack 1
- Domino 8.5.3 with the XPages Extension Library
Download and Extract the Update Site
From the IBM Social SDK OpenNTF project http://ibmsbt.openntf.org
download the desired sbtsdk-1.0.0.xx.zip
to a temporary location on your local hard disk.
Then from this zip file, extract the file "com.ibm.sbt.domino.updatesite.zip
" from "\\sbtsdk\redist\domino"
The Update Site NSF Approach for Domino and Domino Designer
Those familiar with deploying the XPages Extension Library's update site will also be able to deploy the IBM Social SDK update site with ease. And like the XPages Extension Library deployments, it is advisable that administrators and developers deploy the same version of the IBM Social SDK to the IBM Domino Server and IBM Domino Designer environments so that the design-time and the server runtimes are perfectly in sync. This method is described here in a dedicated article entitled “XPages Extension Library Deployment in Domino 8.5.3 and IBM XWork Server”, available on the web at this URL:
It should be noted here with this deployment method with the Update Site NSF that the plugins once deployed are not physically installed in the Domino server's file system. Once the http task is shutdown, they are not persisted anywhere in the server. If there are more than one version of same feature, the Domino OSGi launcher will use the latest version. It will only compare the major, minor and service part of the version. If two features have the same major, minor and service, then the Domino OSGi launcher will rely on the last modified date of the feature document. When the http task is restarted on the server, the OSGi launcher will introspect the Update Site application or aplications, automatically detect the features and dynamically load the associated plugins in the OSGi runtime. Internally, the OSGi launcher references each plugin using a url with a proprietary protocol that knows how to access the attachment plugin.
Also, this approach is only available on Domino 8.5.3, Domino 9.0 and above.
These steps follow the same lines as the instruction for the XPages Extension Library though written specific for the IBM Social SDK.
Update Site NSF
Verify that the Domino server has a Update Site NSF - that is a Domino server application created by the administrator from the Eclipse Update Site NSF. See the following, Create an Update Site App
Notes INI variable OSGI_HTTP_DYNAMIC_BUNDLES
The administrator will need also to verify that the “OSGI_HTTP_DYNAMIC_BUNDLES” variable in the server's notes.ini file. This value should be set to the Update Site NSF, for example, “OSGI_HTTP_DYNAMIC_BUNDLES=UpdateSite1.nsf”.
Import Update Site XML
Launch this app in the IBM Notes client and select the “Import Local Update Site...” button and then browse to the site.xml of the extracted “com.ibm.sbt.domino.updatesite.zip” file.
Once the import process is complete the IBM Social SDK will now appear as a document in the Update Site NSF.
Opening this document in the Update Site NSF details the plugins to be deployed the Domino server.
Restart the Domino server's HTTP Task
At this stage the HTTP task on the Domino server has to be restarted. Use the command “restart task http” at the Domino console to make this happen without resorting to restarting the server itself.
Once the HTTP task has restarted, the Update Site NSF based plugins will be deployed in the OSGi runtime and so the Domino server. To verify that this is so, running running “tell http osgi ss com.ibm.sbt” or “tell http osgi ss com.ibm.xsp.extlibx” in the console will read out the names of the plugins from the IBM Social SDK that have been installed.
> tell http osgi ss com.ibm.sbt
[0E14:0002-0E20] 13/08/2013 13:32:17 Framework is launched.
[0E14:0002-0E20] 13/08/2013 13:32:17 id State Bundle
[0E14:0002-0E20] 13/08/2013 13:32:17 11 RESOLVED com.ibm.sbt.libs.domino_1.0.0.TEST
[0E14:0002-0E20] 13/08/2013 13:32:17 Master=17
[0E14:0002-0E20] 13/08/2013 13:32:17 12 <<LAZY com.ibm.sbt.web_1.0.0.TEST
[0E14:0002-0E20] 13/08/2013 13:32:17 15 RESOLVED com.ibm.sbt.playground_1.0.0.TEST
[0E14:0002-0E20] 13/08/2013 13:32:17 16 RESOLVED com.ibm.sbt.core_1.0.0.TEST
[0E14:0002-0E20] 13/08/2013 13:32:17 17 RESOLVED com.ibm.sbt.libs_1.0.0.TEST
[0E14:0002-0E20] 13/08/2013 13:32:17 Fragments=11
Deploying the same to Domino Designer
The Domino Designer deployment of the IBM Social SDK can use the same imported updatesite from the Update Site NSF.
On Domino Designer verify that the checkbox for "Enable Eclipse plugin install" is checked in the Domino Designer preferences. Then select from the main menu File – Application – Install Management.
On an 9.0 All Client Notes installation, the “\workspace\eclipse\applications” section will appear empty apart from “User Install Site Anchor Feature”.
Closing this dialog and then launching the Eclipse plugin install dialog via File – Application – Install from the main menu, we add and select the remote source to the Update Site NSF on the server using the URL to that application.
Selecting Finish here will in turn launch the Update dialog and here we select to install the “Domino SBT Feature” update site.
Selecting Next we then accept the licensing...
And selecting Finish on the following dialog begins the installation to Designer.
During the installation a prompt will appear to authorize this unsigned installation.
The installation will then complete prompting the user to restart Designer and their All Client to avail of the newly provisioned plugins to the client. Upon relaunch, from the main menu select File – Application – Install Management and verify that the Domino SBT Feature is now installed in Designer.
The Manual Installation Approach for the Domino server
Parent topic: Installing the SDK
In the folder C:\temp\sbtsdk\redist\domino
, extract the plug-ins from com.ibm.sbt.domino.updatesite.zip
Copy the plug-ins to the plug-ins folder in your Domino
This is usually domino\data\domino\workspace\applications\eclipse\plugins
. Copy the following plug-ins:
Restart the http server.