Customize appearance
Workplace XT provides the capability to tailor its appearance, such as the images and colors of the application's banner and menu bar. For example, you might want to change the application's default banner color to match your site's colors. The customizable objects are controlled by a style sheet. Workplace XT provides a properties file where you can modify the appearance properties, and a script file that generates a new style sheet with your changes.
Here are the areas in Workplace XT that you can customize:
Area |
You can customize... |
Banner and Global Menu |
The logo, banner and global menu images. The global menu includes the banner links. You can also change the size of the logo and the color of the text used in the banner and global menu bar. |
List View |
The color of the column header and font. You can also change the colors that are used for highlighting: a selected document, dragging a document, and the folder in which the document is located in the tree view. |
Login Page |
The login banner and background images, background colors and font colors. |
Customizing Workplace XT's appearance consists of the following steps:
- Modify the properties file.
- Generate a new style sheet.
- Deploy the new style sheet.
- Restart Workplace XT.
NOTE Before you can run the script to customize the application's appearance, ensure that you have the following items installed or configured:
- Java™ Runtime Environment (JRE) or Java™ Development Kit (JDK) version 1.5 or greater.
- JAVA_HOME environment variable that points to the location of the JRE or JDK.
To customize the appearance of Workplace XT
- Locate the SkinGen.properties file. By default, it is located in the <XT_install_path>/FileNet/WebClient/Skinning folder.
- Use a text editor to modify the property values, such as changing images and font colors. The details are listed in the properties file. You cannot modify the keys.
- Run the script file to generate new style sheets. The script file is located by default in the <XT_install_path>/FileNet/WebClient/Skinning folder.
- For Windows, run SkinGen.bat.
- For UNIX, run SkinGen.sh.
- Deploy the new style sheets.
- Back up the files in the css folder in one of the following paths:
- For an exploded directory deployment, <XT_deploy_path>/WorkplaceXT/css.
- For a WAR or EAR file deployment, <XT_install_path>/FileNet/WebClient/WorkplaceXT/css.
- Copy all of the new style sheets from the Skinning folder to the css folder in which you backed up your files.
- Undeploy the application. See the "Back up, undeploy, and remove" procedures in Upgrading the Workplace XT software for more information. Optionally, if you customized your deployed configuration files, also perform the "Copy configuration" procedures in that same section.
- If Workplace XT is deployed as a WAR or EAR file, you must re-create the WAR file or WAR and EAR files. See Re-creating the WAR and EAR files for more information.
- Redeploy the Workplace XT application. See Deploying Workplace XT on the Web application server for more information.
- Restart the Workplace XT application.