|The steps that you must perform to customize IBM Lotus Connections are the same no matter what part of the product you are customizing.
The steps that you must perform to customize IBM Lotus Connections are the same no matter what part of the product you are customizing.
Before you begin
Start Lotus Connections and review the product user interface to determine which areas of the product you want to customize.
Attention: This documentation is provided to help you customize
your deployment of IBM Connections. IBM Support can address questions
about the customization process, but cannot address questions about the
particulars of your customization.
- In the web application source directories for the applications, find the file that serves as the source of the area of the product that you want to edit.
The default location for the web application directory for each application is: <WAS_home>/profiles/<profile_name>/installedApps/<cell_name>/<application_name.ear>/<application_name.war> where:
Turn on the customization debugging capability by setting the node-level CONNECTIONS_CUSTOMIZATION_DEBUG WebSphere Application Server environment variable to true. To do so, open the Integrated Solutions Console and click Environment -> WebSphere variables.
Copy the file that you want to edit from one of the web application directories listed in Step 1.
- <WAS_home> is the directory to which you installed IBM® WebSphere® Application Server
- <profile_name> is the profile to which you installed one of the Lotus® Connections applications
- <cell_name> is the cell to which you installed the application
- <application_name.ear> is the EAR file name for the application
- <application_name.war> is one of the following file names:
Table 1. Application WAR files
The following list identifies the files that serve as the source of the user interface areas that are popular targets for customization:
And then paste the file into the appropriate directory. For example:
- Colors and fonts: /nav/common/styles/defaultTheme/custom.css and /nav/common/styles/defaultTheme/defaultTheme.css.
Note: If your users view the product in Arabic, Hebrew, or another right-to-left language, also copy the defaultTheme_rtl.css file.
- Error page: /nav/templates/error.jsp
- Footer: /nav/templates/footer.jsp
- Login page: /nav/templates/login.jsp
- Navigation bar: /nav/templates/header.jsp
To determine the appropriate directory to paste the file to, complete the following steps:
- To edit the footer and have the same footer be displayed in all of the applications, store the updated footer file in the following directory:
- To change the login page of a single application, store the updated login page file in the directory where customizations that are specific to that application are stored. For example, to change the login page of the Files application only, you would store the login.jsp file in the files subdirectory instead of the common subdirectory:
- Figure out the base directory where your customizations should go. The base directory is defined during the installation; it is saved as a WebSphere Application Server variable named CONNECTIONS_CUSTOMIZATION_PATH. By default, the variable is set to <installdir>\data\shared\customization.
Do one of the following things:
Add your file to the appropriate subdirectory within the common directory or within a specific application directory.
The customization directory contains the following subdirectories:
- To make changes to all of the applications, copy the file into the common subdirectory.
- To make changes to a single application only, copy the file into the subdirectory for that application.
Stores files to be applied to all of the applications. You most often copy edited files to this directory.
Stores files to be applied to the Activities user interface only.
Stores files to be applied to the Blogs user interface only.
Stores files to be applied to the Bookmarks user interface only.
Stores files to be applied to the Communities user interface only.
Stores files to be applied to the Files user interface only.
Stores files to be applied to the Forums user interface only.
Stores files to be applied to the Home page user interface only.
Stores files to be applied to the News user interface only.
Stores files to be applied to the Profiles user interface only.
Stores files to be applied to the Advanced Search user interface only.
Stores files to be applied to the Wikis user interface only.
where <customizationDir> is the customization directory specified in the CONNECTIONS_CUSTOMIZATION_PATH environment variable, which by default is set to <installdir>\data\shared\customization.
Edit the file stored in the customization directory to make your changes.
Test your changes by refreshing the web browser. You might also need to clear your browser cache to see the changes.
When you are ready to publish your changes, turn off the customization debugging capability by setting the CONNECTIONS_CUSTOMIZATION_DEBUG WebSphere Application Server environment variable to false.
- To add custom styles to the product, edit the custom.css or custom_rtl.css files.
Note: You only need the custom_rtl.css if your users view the product in Arabic, Hebrew, or another right-to-left language.
- To make extensive changes to the color of the product, edit the defaultTheme.css file.
For the menus available from the navigation bar:
Important: Do not leave the product in debug mode when using it in a production environment. It has a major impact on product performance. Only use debug mode while you are making and testing changes to the user interface during the testing phase. If you forget to turn off debug mode, an error is written to the log to remind you.
Using the WebSphere Application Server Integrated Solutions Console, stop and restart each application EAR file.
Force all user web browsers to refresh all cached content and display your changes by running the command that updates the product version stamp.
- Enter the following command to access the IBM Lotus Connections configuration file: execfile("connectionsConfig.py")
If you are prompted to specify which server to connect to, type 1.
Enter the following command to check out the Lotus Connections configuration files:
Note: This information is not used by the wsadmin client when you are making configuration changes.
Enter the following command to increment the value of the versionStamp property:
- <working_directory> is the temporary working directory to which the configuration XML and XSD files are copied and are stored while you make changes to them. Use forward slashes to separate directories in the file path, even if you are using the Microsoft® Windows® operating system.
AIX and Linux only: The directory must grant write permissions or the command does not run successfully.
- <cell_name> is the name of the WebSphere Application Server cell hosting the Lotus Connections application. This argument is case-sensitive, so type it with care. If you do not know the cell name, type the following command while in the wsadmin command processor:print AdminControl.getCell()
- AIX or Linux:LCConfigService.checkOutConfig("/opt/temp","foo01Cell01")
- Microsoft Windows:LCConfigService.checkOutConfig("c:/temp","foo01Cell01")
LCConfigService.updateConfig("versionStamp","<gmt_timestamp>") where <gmt_timestamp> is the GMT time. You can specify an empty string for the time stamp or provide a GMT value string. When you specify an empty string, the client calculates the current GMT time and updates the version stamp with that value. If you choose to provide the time, specify it using the following format: yyyyMMdd.HHmmss and specify the time in GMT. It is best to provide an empty string and let the client format the time stamp. For example: LCConfigService.updateConfig("versionStamp","").
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 the changes to take effect. See Applying common configuration property changes for information about how to save and apply your changes.
What to do next
See the following topics for more information about customizing specific areas of the product.
Customizing the navigation bar
You can edit the files that control the content of the Lotus Connections navigation bar to add to the bar's functionality. This procedure describes how to add a link to the navigation bar and change the company logo.
Customize the product by replacing images specific to IBM Lotus Connections with your own company images.
Adding styles to the Lotus Connections stylesheet
You can change the look of the IBM Lotus Connections pages to give them a custom look by adding new style definitions in the cascading stylesheet and applying that style to different parts of the product user interface.
Making extensive color and style changes
Edit the defaultTheme.css file to make extensive changes to the product user interface, such as changing the font style and background color.
Customizing the login page
Customize the login pages in IBM Lotus Connections to have the appropriate style and content for your organization.
Customizing the footer
You can edit the files that control the content of the IBM Lotus Connections footer to improve the footer's functionality.
Customizing the error page
Customize the text on the error pages in IBM Lotus Connections.
Customizing the Getting Started tab
Help your users get started with your implementation of Lotus Connections by customizing the Getting Started tab that is displayed in the home page.
Customizing product strings
You can replace a word or phrase in the product user interface with terminology that better suits your environment.
Customizing file type icons
Add new file extensions to an existing file type icon, or add a new file extension with a new icon. Custom file type icons display in the Files and Communities applications in Lotus Connections release 3.0.
Parent topic: Customizing
Applying common configuration property changes