Customize product stringsYou can replace a word or phrase in the product user interface with terminology that better suits your environment.
About this task
The following list defines the application properties files that contain strings you can customize:
com.ibm.lconn.core.strings.templates in the lc.util.web-3.0.jar file found in the <application_name>.ear/<war>/WEB-INF/lib directories.
com.ibm.openactivities.web.coreui.resources.resources in Activities.ear\oawebui.war\WEB-INF\lib\oawebui.jar.
com.ibm.lconn.blogs.strings.ui in Blogs.ear\blogs.war\WEB-INF\classes\com\ibm\lconn\blogs\strings
in <application>.ear\lc-bookmarklet.war\WEB-INF\lib\lc-bookmarklet.jar where <application>.ear is the EAR file of one of the following applications:
- com.ibm.lconn.files.strings.ui: Main Files application user interface and the Files widget in Communities
- com.ibm.lconn.files.strings.uitemplates: About and Metrics pages
- com.ibm.lconn.files.strings.uihelp: Help pop-ups
- com.ibm.lconn.files.strings.cmis: CMIS custom object type property labels and descriptions. See Work with CMIS API object types.
in Files.ear/lconn.files.ui.jar. To customize the text in email notifications generated by the Files application, see Customize Files notification templates.
com.ibm.forum.web.resources.resources_xx where xx is the language identifier in Forums.ear/forum.web.war/WEB-INF/lib/forum.web.jar.
- com.ibm.lconn.homepage.resources.nls.jsp.jsp_resources: Most string appearing in the user interface, except the stories in the river of news
- com.ibm.lconn.homepage.resources.nls.ui.ui_resources: Strings for notifications
- com.ibm.lconn.homepage.resources.nls.catalog.service.ui.CatalogServiceUIMessages: Strings related to widgets, such as widget titles and the strings that are displayed in the customization palette
com.ibm.lconn.files.strings.cmis_xx where xx is the language identifier
where xx is the language identifier in moderation.ear/sn.moderation.ui.jar.
- com.ibm.lconn.news.nls.jsp_resources: Most strings appearing on the email settings page
- com.ibm.lconn.news.nls.ui_resources: Strings that are displayed in the Home page user interface for notifications
- com.ibm.lconn.news.nls.templatePlaceholders: Strings for stories appearing in the river of news in Home page
where xx is the language identifier in lc.profiles.app.war/WEB-INF/lib/lc.profiles.web.app-3.0.jar. You must also define field labels in the profiles-config.xml file. See Specify external labels for attributes for more details.
Email resource strings:
where xx is the language identifier in lc.profiles.core.service.impl-3.0.jar
com.ibm.lconn.search.strings.ui in Search.ear/search.common.jar.
Customize Wikis welcome page title and message:com.ibm.quickr.share.services.rest.handlers.wiki.nls.WikiWelcomeMessagesin Wikis.ear/qkr.share.services.rest.jar You cannot use the customization debugging capability to test edited strings. Note: You cannot use this method to customize the default notification messages sent from the Files, News, and Wikis applications. See Customize IBM Lotus Connections 3.0 email digests and notifications (white paper) for more information.
- Many strings in the user interface are represented by a key-value pair defined in a properties file stored in the application JAR file. Before you can redefine the value of a string, figure out which key is used to represent it.
- Create a properties file in which to store the key-value pair for the string that you want to customize. Give the properties file the same name as the properties file that is used to store that key by the application. Give it the full name. For example, if you copy the templates.properties file, and paste it into the <customization_dir>/strings directory, name it as follows:
Note: The file must be created with the full file name above; that is, it should not be a series of directories containing the file templates.properties.
Also, specify a language code for the properties file in the file name. If you do not provide a _ <language_code> value at the end of the properties file name, the value you specify for the key in the properties file is used despite the locale of the web browser accessing the application.
For example, if you were to change the key with the current value of "Help" to "Ayuda" and defined it in a file named com.ibm.lconn.files.strings.ui.properties (without the _es suffix), then anyone who accesses the product will see Aydua in place of the Help string even if their browser locale is not set to es. In some cases, you might want the same value applied to all languages. If you wanted to change the term "IBM Connections" to a company name, for example, then you could store the customized key in a properties file without the _ <language_code> suffix and the company name shows as-is to all browsers. Use one of the following language codes:
Note: If you provide translated strings in Simplified Chinese, be sure to also provide strings in Traditional Chinese. If the customer's language preference is set to Traditional Chinese, but it is not provided, Simplified Chinese is displayed by default.
- Store the properties file that you created in the following directory, which is created by the installation wizard:
where <customizationDir> is the root directory for customization files. See Customize the user interface for more details. Unlike some of the other areas of the product, the strings directory in the customization root does not have a subdirectory for each application. Each application uses unique properties file names, so all of the strings that you replace can be stored in this common strings directory.
- Use the IBM WAS Integrated Solutions Console, stop and restart each application EAR file.
- Test your changes by clearing your browser cache, and then refreshing the browser.
- To force all user web browsers to refresh all cached content and display your changes, run the command that updates the product version stamp.
- Enter the following command to access the IBM Connections configuration file: execfile("connectionsConfig.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, pick the node where the file is stored. This information is not used by the wsadmin client when you are making configuration changes.
- Check out the IBM Connections configuration files:
- <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 WAS cell hosting the IBM Connections application. This argument is case-sensitive, so type it with care. To obtain the cell name:print AdminControl.getCell()
- AIX or Linux:LCConfigService.checkOutConfig("/opt/temp","foo01Cell01")
- Microsoft Windows:LCConfigService.checkOutConfig("c:/temp","foo01Cell01")
- Enter the following command to increment the value of the versionStamp property:
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, check the configuration files back in and do so during the same wsadmin session in which you checked them out for the changes to take effect. See Apply common configuration property changes for information about how to save and apply your changes.
Add custom strings for widgets and other specified scenarios
You can add custom strings or modify existing strings when performing certain tasks in IBM Connections, without having to update product resource files.
Parent topicCustomize the user interface
Add labels to media gallery fields
Customize Files notification templatesSpecify external labels for attributes
Work with CMIS API object types
November 28, 2011
Nov 28, 2011 2:55:21 PM Fixing link that did not work which I got using the link pop-up featur... 17 Nov 28, 2011 2:53:13 PM Added related link to Specifying external labels for attributes topic. 16 Nov 28, 2011 2:50:49 PM Added field labels note to Profiles section. 15 Nov 10, 2011 2:53:48 PM Added note with link to Customizing notifications white paper per SPRs... 14 Nov 4, 2011 4:41:31 PM Changed News.ear to News.ear/news.common.jar. 13 Oct 24, 2011 2:01:30 PM Replaced lconn.files.ui.jar with qkr.share.services.rest.jar for Media... 12 Oct 21, 2011 1:29:52 PM Changed in News.ear/news.web.war/WEB-INF/lib/news.common.jar to in New... 11 Oct 21, 2011 11:49:47 AM Replaced lc.profiles.app.war/WEB-INF/lib/lc.profiles.core.service.impl... 10 Oct 5, 2011 1:31:44 PM Added media gallery and moderation information per SPR #DMCE8MCC74 9 Sep 27, 2011 10:21:06 AM Minor change 8 Sep 27, 2011 10:20:32 AM Minor change 7 Sep 27, 2011 10:19:27 AM Just trying to fix the messed up formatting now. 6 Sep 27, 2011 10:17:56 AM 5 Sep 27, 2011 10:15:43 AM Added info about the email strings in com.ibm.lconn.profiles.strings.u... 4 Sep 22, 2011 12:54:26 PM 3 Sep 19, 2011 9:58:44 AM 2 Jun 10, 2011 11:20:19 AM Jason T Moore 1 Submitted by Sami Khader on Feb 9, 2012 4:19:20 PM
Re: Customizing product strings
The homepage.utils.jar does not contain the following?
com.ibm.lconn.homepage.resources.nls.catalog.service.ui.CatalogServiceUIMessagesSubmitted by Hunter Medney on Sep 22, 2011 10:01:51 AM
For the News strings, news.common.jar is under News.ear, not the WEB-INF/lib directory.Submitted by Michelle Mahoney on Aug 31, 2011 10:43:50 AM
Re: Customizing product strings
The mobile application does not use this method to find custom strings and use them instead of the predefined strings. Customizing strings in the mobile application is not supported. That said, the strings used in the mobile application are defined in the following file:
mobile.ear/mobile.web.war/WEB-INF/lib/mobile.web.jar/com/ibm/lotus/connections/mobile/web/package_Submitted by Michel Wigbers on Aug 30, 2011 8:48:06 AM
Re: Customizing product strings
where can I find the mobile strings and correct name for the bundle?