Modifying the widgets-config.xml files for the Video Chat widget

Configure the Video Chat widget by modifying the widgets-config.xml file. Add the Video Chat widget to the widgets-config.xml file so that IBM® Connections is able to display a custom widget. Specify the URL to the IBM Sametime® Meetings server in order to use the video functionality provided by Sametime Meetings.

About this task

Modify the widgets-config.xml files by completing this procedure.

Procedure

To display the Video Chat widget on every community's home page, edit the widgets-config.xml file. This file is typically found in these two locations:
- /IBM/WebSphere/AppServer/profiles/AppSrv01/config/cells/cell_name/LotusConnections-config/widgets-config.xml
- /IBM/WebSphere/AppServer/profiles/Dmgr01/config/cells/cell_name/LotusConnections-config/widgets-config.xml
In each of these files, locate the resource tag with a type of community. Within that tag there is a widgets tag, and within that tag there is a definitions tag.

To create a new Sametime Video widget definition, add a new widgetDef tag within the definitions section. The widget definition should look like this:

<widgetDef defId="Video" primaryWidget="false" modes="view" uniqueInstance="true" url="{communitiesSvcRef}/SametimeVideo.xml">
itemSet>
<item name="sametimeMeetingServerUrl" value="http://stmeeting.xxx.co.uk:80/stmeetings" />
<item name="ssl_sametimeMeetingServerUrl" value="https://stmeeting.xxx.co.uk:443/stmeetings" />
<item name="communitiesBaseUrl" value="{communitiesSvcRef}"/>
</itemSet>
</widgetDef>

Set the value of sametimeMeetingServerUrl to the appropriate fully qualified host name, port, and context-root of your Sametime Meeting server. Ensure that the URL specified in the main widgetDef matches where you installed the SametimeVideo.xml file. If you placed the SametimeVideo.xml file somewhere other than the suggested location in step 1.a., modify this URL in your widget definition. For example, the Sametime Video Chat widget added as second definition:

<resource type="community" aclServiceImpl="com.ibm.lconn.comm.acl.ACLSvcImpl"
 resourceValuesProvider="com.ibm.tango.internal.service.CommunitiesResourceValuesProvider"
 xpathMandatedWidgetForMainPage="/tns:config/tns:resource[@type='community']/tns:widgets/
tns:layout/tns:page[@pageId = 'communityOverview']">
		widgets xmlns:tns="http://www.ibm.com/widgets-config">
			<definitions>
				<widgetDef defId="Members" primaryWidget="false" modes="view fullpage"
 showInPalette="false" uniqueInstance="true" url="{webresourcesSvcRef}/web/lconn.comm/
communityMembers/communityMembers.xml?version={version}">
					<itemSet>
						<item name="membersPerPage" value="18" />
						<item name="membersPerPageFullPage" value="16" />
					</itemSet>
				</widgetDef>
				
				<widgetDef defId="Video" primaryWidget="false" modes="view" uniqueInstance="true"
 url="{contextRoot}/SametimeVideo.xml">
					itemSet>
						<item name="sametimeMeetingServerUrl" value="http://stmeetings.company.com:
9080/stmeetings"/>"
					</itemSet>
				</widgetDef>
				
				<widgetDef defId="Blog" prerequisite="blogs" modes="view edit search" url="{blogsSvcRef}
/static/{version}!{locale}/iwidgets/blog/blogsWidget.jsp" navBarLink="{blogsSvcRef}/
{resourceId}" description="blogsDescription" uniqueInstance="true" helpLink="{helpSvcRef}/
topic/com.ibm.lotus.connections.communities.help/community_blog_frame.html" iconUrl="
{contextRoot}/nav/common/images/iconBlogs16.png">

In the same widgets-config.xml files, define where the new widget will display. From within the widgets tag, locate the layout tag. The layout tag is usually after the close of the definitions tag. On the page with an id of communityOverview, create a new widgetInstance tag similar to this:

<widgetInstance uiLocation="col3" defIdRef="Video"/>

The uiLocation setting and the order of the widgetInstance tags determine where the widget is located on the page.

For example, the Sametime Video Chat widget is in column 3:

<!-- mandated widgets -->
	<layout resourceSubType="default">
		<page pageId="communityOverview">
			<widgetInstance uiLocation="col3" defIdRef="Video"/>
			<widgetInstance uiLocation="col3" defIdRef="Members"/>
		</page>
		<page pageId="allCommunities">
			<widgetInstance uiLocation="col1" defIdRef="sand_recomComm"/>
		</page>
		<page pageId="myCommunities">
			<widgetInstance uiLocation="col1" defIdRef="sand_recomComm"/>
		</page>
<	/layout>

Restart the Communities application.
Install the latest Sametime Meetings 8.5.2 IFR 1 fix from IBM Fix Central. At the time of this writing, that fix is RPOH-8U4KJM. Installation instructions are also available from IBM Fix Central.
Note: This step is not necessary if you have Sametime Meetings 9 or later installed.
Adjust the service provider properties as described in these steps:
1. On the computer where the Conference Manager is installed, access this path:
  /IBM/WebSphere/AppServer/profiles/media_profile/sametime_tcspi
2. Open the Service Provider specific properties file, for example, myAV.properties. Make note of the Service Provider ID (SERVICE_PROVIDER_ID).
3. Open the ConferenceManager.properties file. Note the ServiceProvider name from the ConferenceServiceName property.
4. On the Sametime Meeting Server, locate the serviceProvider.json file in this location:
  /IBM/WebSphere/AppServer/profiles/profile_name/installedApps/cell_name/SametimeMeetingServer.ear/stmeetings.webclient.war/serviceProvider.json
  For example,
  /opt/IBM/WebSphere/AppServer/profiles/STMAppProfile/installedApps/stmnode1MeetingCell/Sametime Meeting Server.ear/stmeetings.webclient.war
5. Edit this file and set the following properties using the information:
  1. id = SERVICE_PROVIDER_ID from step b
  2. ConferenceServiceName = ConferenceServiceName from step c
  3. label = ConferenceServiceName from step c
Note: If you plan to use an audio/video service provider other than Sametime audio video, modify the properties file so that video rooms are created with the appropriate attributes.