Watch a Video with a Sample App
Watch this video to see a sample trouble ticket application.
Prepare your Environment
Developers can use the SDK in different IBM Connections test environments. Below is a list of options.
1) IBM Collaboration QuickStart: There is an image in the IBM SmartCloud which comes with IBM Connections and IBM Domino pre-installed and pre-configured. As developer you’ll get full access to the image.
2) IBM Greenhouse: Everyone can register free accounts to try IBM Connections. Developers can program against this environment using their accounts and basic authentication but no custom gadgets can be deployed.
3) On-Premises: IBM Connections and IBM Domino can be downloaded via the IBM Passport Advantage Online website. Read these slides for step but step instructions on how to install IBM Connections. IBM business partners can also download an IBM Connections image.
The following table shows a comparison of the environments:
|Feature \ Environment||IBM Collaboration QuickStart||IBM Greenhouse||On-Premises|
|Create OAuth tokens||yes||no||yes|
|Full admin access||yes||no||yes|
|Costs||Default: $0.48 / hour||free||yes|
|Test user accounts||yes||no||can|
|IBM Domino and SDK preinstalled||yes||no||can|
|Single sign on||yes||N/A||can|
Choose and prepare your environment:
IBM Collaboration QuickStart
The Collaboration QuickStart image comes with IBM Connections and IBM Domino pre-installed and a trouble ticket sample application (tbd: add link).
In this configuration IBM Connections is used on IBM Greenhouse in combination with an on-premises IBM Domino server and local IBM Domino Designer.
Code your first App
Create a new application and configure the ConnectionsBasicEndpoint to the Connections server.
- Click File -> New -> Application.
- Select a server, name the application, and click OK.
- Via the Package Explorer open Faces-config.xml.
- Click the source tab and replace the source content as follows.
<faces-config> <!-- Connections --> <managed-bean> <managed-bean-name>connections</managed-bean-name> <managed-bean-class>com.ibm.sbt.services.endpoints.ConnectionsBasicEndpoint</managed-bean-class> <managed-bean-scope>session</managed-bean-scope> <managed-property> <property-name>url</property-name> <value><<YOUR SERVER>></value> </managed-property> <managed-property> <property-name>authenticationService</property-name> <value>communities/service/atom/communities/my</value> </managed-property> <!-- Trust the connection --> <managed-property> <property-name>forceTrustSSLCertificate </property-name> <value>true</value> </managed-property> </managed-bean> <!--AUTOGEN-START-BUILDER: Automatically generated by IBM Domino Designer. Do not modify.--> <!--AUTOGEN-END-BUILDER: End of automatically generated section--> </faces-config>
Set the url property to your IBM® Connections server, for example, https://greenhouse.lotus.com. To make it simple at first, ensure that your server doesn’t require authentication when accessing public communities.
- Via the Xsp Properties editor ensure that the application has both the extlib and sbtsdk libraries in its list of dependencies.
Consume the SDK from an XPages application by leveraging the server-side Java APIs.
- Click File -> New -> XPage.
- Name the XPage MySocialXPage and click OK.
- Copy the following content to the page:
To find out what functionality the SDK provides read the Java API documentation. The trouble ticket sample application can be downloaded from OpenNTF to run it on your on-premises IBM Domino server. Watch the webinar to learn how to get started with the Social Business Toolkit SDK.