Change configuration settings for managed applications 

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.

Before starting

To edit configuration files, use the IBM WAS wsadmin client. See Starting the wsadmin client for details.

Procedure

To set properties for the managed applications configured on Communities servers...

1. From the dmgr host:
   cd $DMGR_PROFILE/bin
   ./wsadmin.sh -jython
   execfile("communitiesAdmin.py")

   If prompted to specify a service to connect to, type 1 to pick the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a local file path, pick the node where the file is stored.
   

2. Optional: Use the following command to 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

   
   

3. Optional: Use the following command to 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

   
   

4. Check out the Communities configuration files using the following command:
   

   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 directory while you make changes to them.

   • <cell_name> is the name of the WAS cell hosting the IBM Connections application. This argument is required. It is also case-sensitive, so type it with care.
     

   For example:

   wsadmin>ManagedAppService.checkOutConfig("QuickrPortalWiki", "c:/TempDir", "LCServerNode01Cell")

   
   

5. Optional: To view a list of the current properties and their values for the checked-out managed application, use the following command:
   

   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

   
   

6. To change a managed application configuration setting, use the following command:
   

   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 commands that can be used to configure managed applications:

   ManagedAppService.checkOutConfig(String "<app>", String "<working directory>", String "<cell name>")

   Checks out the configuration file for the specified application.

   The working directory must be a directory that already exists.
   

   ManagedAppService.showConfig(String "<app>")

   Lists the configuration settings for the specified application. This command 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.

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

7. Optional: Repeat the previous step once for each property setting that you want to change.

8. Optional: Use the ManagedAppService.showConfig command to display the updated settings in the working directory before you check them in.

9. When you have finished updating the managed application settings, use the following command to save and apply your changes:
   

   ManagedAppService.checkInConfig(String "<app>")

   
   

What to do next

Before your changes can take effect, you need to stop and restart the Communities server.

Parent topic

Work with managed applications

   

 

});

+

Search Tips   |   Advanced Search