Home

 

Using the widgets-config.xml file for Communities

The widgets-config.xml files contains configuration settings for each of the widgets supported by Communities and Profiles. To update settings in the file, check the file out and, after making changes, check the file back during the same wsadmin session as the checkout for the changes to take effect.


To edit configuration files, use the IBM WebSphere Application Server wsadmin client. See Start wsadmin for details.


The widgets-config.xml file defines the widgets available for use in Communities and specifies the life-cycle events associated with each widget. You can edit configuration settings in this file to perform various tasks. For example, if you want to make custom widgets available, you define the widgets in this file. You also need to edit settings in this file if you want to specify a different system user for managing widget life-cycle events. For more information, see Specifying different system users for widget life-cycle events.

To configure settings in the widgets-config.xml file for Communities...

  1. Open a command window and start the wsadmin command-line tool.

    1. Access the Communities configuration files:

      If you are asked to select a server, you can select any server.

  2. Check out the widgets-config.xml file...

    CommunitiesConfigService.checkOutWidgetsConfig(“<working_directory>", "cell_name")

    where:

    • <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. When specifying the path to a working or temporary directory where the checked out files are to be placed, use a forward slash as the path separator, even for Microsoft Windows systems.

    • cell_name is the name of the WebSphere Application Server cell hosting the Communities feature. This argument is required even in stand-alone deployments.

    For example:

      CommunitiesConfigService.checkOutWidgetsConfig"C:/tmp2","Cell01")
      

  3. Navigate to the temporary in which you saved the widgets-config.xml file, and then open the file in a text editor and make the required changes.

  4. Apply your changes by doing the following:

    1. Check in the updated widgets-config.xml file...

      CommunitiesConfigService.checkInWidgetsConfig(“<working_directory>", "cell_name")

      For example:

        CommunitiesConfigService.checkInWidgetsConfig"C:/tmp2","Cell01")
        

    2. To exit wsadmin, type

      exit

      at the prompt.

    3. Restart the Communities application using the WAS admin console.


Administer remote applications

 

Related tasks

Specify different system users for widget life-cycle events

Enable custom widgets for Communities

Checking out the widgets-config.xml file for Profiles


+

Search Tips   |   Advanced Search