After defining a custom theme, you need to add it to the
Communities configuration file, communities-config.xml.
Before you begin
To edit configuration files, you must
use the IBM® WebSphere® Application Server wsadmin client.
See Starting the
wsadmin client for information about how to start the wsadmin
command-line tool.
About this task
The list of themes displayed in the theme palette in Communities
comes from list of themes defined in the Communities configuration
file, communities-config.xml. When you define
a new theme, you must add a corresponding theme entry to the configuration
file for it to display in the user interface. The placement of the
theme in the configuration file list matches its placement in the
Communities theme palette. Typically, you might add new themes to
the end of the list, but if you want to make your new theme the default
community theme, you need to add it to the beginning of the list.
This placement means that the theme is used whenever another theme
has not been explicitly set.Procedure
To add a theme to the Communities configuration file,
complete the following steps.
- Start the wsadmin client from the following
directory of the system on which you installed the Deployment Manager:
app_server_root\profiles\dm_profile_root\bin
where app_server_root is
the WebSphere Application
Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.You
must start the client from this directory or subsequent commands that
you enter do not execute correctly.
- Start the Communities Jython script interpreter.
- Use the following command
to access the Communities configuration files:
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,
you must pick the node where the file is stored.
- Check out the Communities
configuration files using the following command:
CommunitiesConfigService.checkOutConfig("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 directory while you make changes
to them.
Note: AIX®, Linux , and IBM i only: The directory must
grant write permissions or the command will not run successfully.
- cell_name is the name of the WebSphere Application Server cell hosting
the IBM Connections application.
This argument is required. If you do not know the cell name, you can
determine it by typing the following command in the wsadmin command
processor:
print AdminControl.getCell()
For example:
CommunitiesConfigService.checkOutConfig("/opt/my_temp_dir", "CommServerNode01Cell")
- Open communities-config.xml in a text
editor.
- Add a new <comm:theme> element to
include the properties for the new theme in the list of themes that
are already defined in the file:
For example:
<comm:theme>
<comm:themeUuid>corporate</comm:themeUuid>
<comm:displayNameKey>label.theme.name.corporate</comm:displayNameKey>
<comm:isScriptKey>false</comm:isScriptKey>
<comm:cssUrl>/themes/corporateTheme/corporateTheme.css</comm:cssUrl>
<comm:cssRtlUrl>/themes/corporateTheme/corporateThemeRTL.css</comm:cssRtlUrl>
<comm:thumbnailUrl>/images/corporate.png</comm:thumbnailUrl>
</comm:theme>
where:
Note: Ensure the value specified for themeUuid is
in lowercase. Also uuid and cssUrl are
dependent on each other.
- Save the communities-config.xml file.
- After making changes, you must check the configuration
files back in, and you must do so during the same wsadmin session
in which you checked them out for your configuration changes to take
effect. You must also stop and restart the Communities server. See Applying
property changes in Communities for information about how to
save and apply your changes.
What to do next
- Test your changes by refreshing the web browser.
- When you are ready to make the custom theme available to others,
refer to steps 6-8 of Customizing the user interface for
information about how to publish your changes and make them permanent.