The document discusses customizing IBM Lotus Connections 3.0. It describes what is different in 3.0 including easier customization of styles, headers, footers and login pages. It outlines best practices for creating, maintaining and debugging customizations and migrating customizations from previous versions. The presentation provides examples of customizing styles, logos, headers and login pages for a fictitious renovations branding.
36. Goal #3: Most customization should follow a similar pattern
37. Solution: Allow customer-provided files to override the installed files. Custom files are placed in a special shared customization directory. Removing the file from this directory undoes the customization.
38.
39.
40. Copy the file into the customization directory at the correct sub-directory
44. To undo, delete the customized file and restart the affected applications.
45. The InfoCenter describes where you copy from and where you copy to – generally, you copy the file from where it sits in the WAR to the same relative path inside of the common customization directory
59. Paste those rules in custom.css, and change the colors from light blue to red
60.
61. Tip: Figuring out which CSS rules control which elements can be difficult. Use a tool like Firebug for Mozilla Firefox to locate the rules you want to change.
126. If you have added additional CSS files via the header, copy the contents of those files into <connectionsinstall> /data/shared/customization/common/ nav/common/styles/defaultTheme/custom.css
127. If you have a complete visual override, you may want to port your changes to the new format by following the InfoCenter topic “Making extensive color and style changes”
128.
129. An example of the 2.5 header as a JSP is located at: <websphere> /profiles/ <profile> /installedApps/ <cell> /Files.ear/qkr.share.files.war/ nav/templates/originalHeader.jsp
This talk will cover the different ways Lotus Connections can be branded and customized to fit your corporate deployment. It targets administrators and web developers who are interested in what is new for 3.0. Thanks you for attending my session. I'm the user interface (UI) lead for Lotus Connections, and have been the team lead for the Files component as well as a UI developer in Lotus for many years. You can reach me via e-mail at [email_address] . Be sure to check out the reference material section at the end – there's lots of useful information when getting started.
What's New – cover how customization and branding has changed and what has been added. Understand the new process – deep dive on the how of customization. Show with pictures what goes on when customizing. Branding a simple website – site is first customized with different colors, the logo is changed, images are added to the header, and finally the login page is updated. Recommendations about how to maintain your changes across fixpacks, solutions to common problems, and other useful guidance Migrating from a previous installation
The focus in 3.0 was centralizing and standardizing how we do customizations that require changes to files. We've tried to simplify the deployment, maintenance, and testing of customization. We've also enabled customization of new areas, like the login page, header menus, and “Getting Started” Branding Lotus Connections to look like your intranet should be much simpler in 3.0 – our styles are based on the IBM OneUI platform and are organized to be easy to change. Community themes and email digest customization covered in the infocenter.
While new features may be present for all of these areas, administrators comfortable with how these were managed in 2.5 should not see significant differences.
These roles merely indicate rough outlines of responsibility for branding and integrating a Lotus Connections deployment. Some organizations may combine all three together, and some may have much more formal roles. For instance, in many deployments the responsibility for styling the look and feel of the branding through CSS may be owned by a visual design department or contracted to an external design shop.
We have received a fair amount of feedback in 2.0 and 2.5 about what works and doesn't, and culled common issues from the support teams to understand how we can improve. We also looked at how teams maintain and develop customization and attempted to provide a solution that was as painless as possible. The changes in 3.0 are targeted towards resolving those specific problems, and in future releases we will look to expand what can be customized. Customization is intended to be simple: put files in the correct location on disk, and Lotus Connection will use those files instead of the files in the product. Remove the files and the customization goes away.
The customization directory is located on the file system in the Lotus Connections installation directory. This directory must be located on a shared file system in a clustered environment. Customization is typically a small set of files so the disk requirements are low, and the directory is only read once when the application starts up. Content is copied into a temporary directory in the installed applications directory. If you have very large customization files you will need to ensure your WebSphere installation directory has the necessary space – otherwise locate the files on a separate web server.
The hardest part of customization is finding the correct file, and ensuring you put it in the right location. Once that is correct Lotus Connections manages the rest. New versions of customized files are only picked up when the Lotus Connections applications are restarted, unless you turn on debug mode. You can also restart the application server(s) to pick up all changes at once.
What's New – cover how customization and branding has changed. Touch on how configuration aspecs have changed Understand the new process – deep dive on the how of customization. Show with pictures what goes on when customizing. Walkthrough of a simple example – site is first customized with different colors, the logo is changed, images are added to the header, and finally the login page is updated. Recommendations about how to maintain your changes across fixpacks, solutions to common problems, and other useful guidance Migrating from a previous installation Everything that wouldn't fit in an hour
The examples and images in this section reference the installation of Lotus Connections Files, but all common customization covered here applies to any of the Lotus Connections components equally (with the exception of the Getting Started page).
defaultTheme.css is the style sheet that changes the borders, color, and padding for the theme. For most of your needs this will be the file to change. To get ideas about color palettes, see the other themes located in the /nav/common/styles directory. The “gen1Theme” takes the new styles and makes it look like the 2.5 Lotus Connections theme and so is an example of a more drastic type of change. If you want to make simple changes only (perhaps just minor tweaks), add your rules to custom.css which starts off empty. This file is included last so it takes priority over over everything else. To override the default theme with another theme, copy the entire directory from the installed location to the customization directory, renaming the directory to “defaultTheme” and the primary files from “<xx>Theme.css” to “defaultTheme.css”
Once an image is available, it must still be used. Lotus Connections uses a CSS technique known as background images to centralize changing images across an entire deployment. By identifying the style rule that shows the image, you can override or change the style rule to provide a different image. You will also likely need to specify in CSS the height and width attributes of the new image if different than the old. Some images may be “sprited”, a practice of placing a number of small images into a single larger one and using CSS to show only a portion of the image. In those cases, be sure to reset all of the background-image related properties such as position and repeat.
The header supports dynamic logic through Java, but be aware that some of the Lotus Connections applications will publicly cache their HTML pages (Forums, Blogs, and Bookmarks). If you wish to provide user-specific or dynamic content in the header you will need to disable that functionality. JavaScript can be easily embedded into the header or footer, but if that script needs to leverage the Dojo toolkit used by Lotus Connections it should be placed in the footer (the script for Dojo is not included when the header is rendered). Avoid using document.write() where possible
The Log In page is a simple form with some additional logic for ensuring the user is taken to the correct location after log in. Changing the names of form values or the existing JavaScript on the page may cause issues with applications, therefore we recommend leaving those as is.
In order to more easily override strings, the full directory path of the file is shortened to a filename (by replacing slashes with periods). This allows all files to be located in a single directory. This full name is required (don't use 'templates.properties'). The InfoCenter contains a more thorough list of where to locate the base string files for each application. If you have additional questions please contact your support team about locating the correct file. String customization follows the standard rules from Java for resource loading – see http://java.sun.com/developer/technicalArticles/Intl/ResourceBundles/ for more information If your string changes are not visible please ensure that you have copied the key correctly. Copying the source line to the override file and then changing the value may prevent unintended errors.
Changes to strings requires a restart to the affected applications, even when the customization debug mode is enabled
As an optional step, you can also change the text strings displayed on the welcome page. Locate Homepage.ear/homepage.war/WEB-INF/lib/homepage.utils.jar and extract it to a temporary location. Find the file /com/ibm/lconn/homepage/ resources/nls/jsp_resources.properties. Create a new file <connectionsinstall>/data/shared/customization/strings/com.ibm.lconn.homepage.resources.nls.jsp_resources.properties Copy the strings relevant to the Getting Started page and edit them.
What's New – cover how customization and branding has changed. Touch on how configuration aspecs have changed Understand the new process – deep dive on the how of customization. Show with pictures what goes on when customizing. Walkthrough of a simple example – site is first customized with different colors, the logo is changed, images are added to the header, and finally the login page is updated. Recommendations about how to maintain your changes across fixpacks, solutions to common problems, and other useful guidance Migrating from a previous installation Everything that wouldn't fit in an hour
If you have made extensive unsupported customizations, be sure to keep track of which files you have changed and how you have changed them. While the primary supported customization types (header, footer, stylesheets) should change only rarely, other files may change more often and more significantly. When applying iFixes (as opposed to fixpacks) disabling customizations may not be necessary. However, if your fix does not take effect it may be due to a customization you have applied, and the support team may ask you to disable customization to verify your environment. Merging changes may be complicated, so always ensure you back-up your customizations first
What's New – cover how customization and branding has changed. Touch on how configuration aspecs have changed Understand the new process – deep dive on the how of customization. Show with pictures what goes on when customizing. Walkthrough of a simple example – site is first customized with different colors, the logo is changed, images are added to the header, and finally the login page is updated. Recommendations about how to maintain your changes across fixpacks, solutions to common problems, and other useful guidance Migrating from a previous installation Everything that wouldn't fit in an hour
Because everything is potentially customizable, we only officially support customizations that are documented in the InfoCenter. If you want to change something else, the support team can assist you in finding the right file, but any changes made to that file are at your own risk (and that file may change without notice).
The first four sessions will offer valuable insight into deploying and maintaining Lotus Connections 3.0 as well as the many improvements in this release. The Master Class (JMP302) will cover topics which are equally applicable to branding a Lotus Connections deployment.