Home
Change configuration settings for managed applications
Overview
Communities supports integration with a number of applications, including Confluence Wiki and different types of IBM Lotus Quickrâ„¢ places. Use the ManagedAppService commands to display and update properties for these applications, which can (optionally) be installed on community servers.
To edit configuration files, use the IBM WebSphere Application Server wsadmin client. See Start the wsadmin client for details.
Configure managed applications on Communities servers
- Start the wsadmin client so that you can access the Communities configuration files.
- Access the Communities configuration files:
- Stand-alone deployment:
execfile("communitiesAdmin.py")
- Network deployment:
execfile("WAS_HOME/communities/Dmgr01/config/bin_lc_admin/communitiesAdmin.py")
If you are asked to select a server, you can select any server.
- Optional: Retrieve a list of the managed applications on your Communities server:
ManagedAppService.listApp()Depending on the managed applications that you have installed on your server, something similar to the following is returned:
wsadmin>ManagedAppService.listApp() ConfluenceWiki true QuickrPortalTeamspace true QuickrPortalWiki true- Optional: Get a Help list of the configuration settings that can be used for any specified application:
ManagedAppService.configHelp(String "<app>")For example:
wsadmin>ManagedAppService.configHelp("QuickrPortalWiki") Setting Description PortalWiki:resourceBundleName resourceBundleName for translated strings PortalWiki:contentFeedLink name of the contentFeedLink PortalWiki:name placeTypeName PortalWiki:enabled Enable place type PortalWiki:server server PortalWiki:publicRole role for public PortalWiki:ownersRole role for Community owners PortalWiki:membersRole role for Community members PortalWiki:managedApplicationTypeID managed Application Type ID PortalWiki:placeTemplate place template name
- Check out the Communities configuration files...
ManagedAppService.checkOutConfig(String "<app>", String "<working_directory>", String "cell_name")where:
- <app> is the name of the managed application, which you can obtain via the ManagedAppService.listApp() command.
- <working_directory> is the temporary working directory to which the configuration XML and XSD files are copied. The files are kept in this working while you make changes to them.
- cell_name is the name of the WebSphere Application Server cell hosting the Lotus Connections feature. This argument is required even in stand-alone deployments, and is case sensitive.
For example:
wsadmin>ManagedAppService.checkOutConfig("QuickrPortalWiki", "c:/TempDir", "LCServerNode01Cell")
- Optional: To view a list of the current properties and their values for the checked-out managed application...
ManagedAppService.showConfig(String "<app>")For example:
wsadmin>ManagedAppService.showConfig("QuickrPortalWiki")
Here is an example of what you might see after running this command:
wsadmin>ManagedAppService.showConfig("QuickrPortalWiki") Configuration properties: PortalWiki:resourceBundleName = com.ibm.lconn.comm.quickr.resources.QuickrWikiResources PortalWiki:contentFeedLink = wikis PortalWiki:name = PortalWiki PortalWiki:enabled = true PortalWiki:server = DefaultServer PortalWiki:publicRole = Readers PortalWiki:ownersRole = Managers PortalWiki:membersRole = Editors PortalWiki:managedApplicationTypeID = QuickrPortalWiki PortalWiki:placeTemplate = Team Wiki- To change a managed application configuration setting...
ManagedAppService.updateConfig(String "<app>", String "<property>", String "<value>")where:
- <app> is the name of the managed application.
- <property> is one of the managed application configuration properties that can be edited.
- <value> is the new value with which you want to set that property.
The following table displays information regarding the configuration properties for managed applications.
Command Description ManagedAppService.checkOutConfig(String "<app>", String "<working directory>", String "<cell name>") Checks out the configuration file for the specified application. The working must be a that already exists. ManagedAppService.showConfig(String "<app>") Lists the configuration settings for the specified application. Also displays the settings that can be configured. ManagedAppService.updateConfig(String "<app>", String "<property>", String "<value>") Updates a specific property in the configuration file for the specified application. Each application has its own set of configuration properties. The listApp method lists the properties for an application.
ManagedAppService.checkInConfig(String "<app>") Checks in the configuration file for the specified application. ManagedAppService.configHelp(String "<app>") Prints the help messages for the configuration settings that can be set for the specified application.
- Optional: Repeat the previous step once for each property setting that you want to change.
- Optional: Use the ManagedAppService.showConfig command to display the updated settings in the working before you check them in.
- When you have finished updating the managed application settings, use the following command to save and apply your changes:
ManagedAppService.checkInConfig(String "<app>")
Before your changes can take effect, you need to stop and restart the Communities server.
Working with managed applications