Customize product strings 

You 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:

Common strings

Activities

Blogs

Bookmarklet

Bookmarks

Communities

Files

Forums

Home page

Media gallery

 Moderation

 News repository

Profiles

Email resource strings:

          where xx is the language identifier in lc.profiles.core.service.impl-3.0.jar
Search

Wikis

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.


Procedure

  1. 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.

  2. 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: 

      com.ibm.lconn.core.strings.templates.properties

      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:

      ar

        Arabic

      cs

        Czech

      da

        Danish

      de

        German

      el

        Greek

      en

        English

      es

        Spanish

      fi

        Finnish

      fr

        French

      hu

        Hungarian

      it

        Italian

      iw

        Hebrew

      ja

        Japanese

      ko

        Korean

      no

        Norwegian

      nl

        Dutch

      pl

        Polish

      pt_BR

        Brazilian Portuguese

      pt

        Iberian Portuguese

      ru

        Russian

      sl

        Slovenian

      sv

        Swedish

      tr

        Turkish

      zh

        Simplified Chinese
        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.

      zh_TW

        Traditional Chinese

  3. Store the properties file that you created in the following directory, which is created by the installation wizard: 

      <customizationDir>\strings

      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.

  4. Use the IBM WAS Integrated Solutions Console, stop and restart each application EAR file.

  5. Test your changes by clearing your browser cache, and then refreshing the browser.

  6. To force all user web browsers to refresh all cached content and display your changes, run the command that updates the product version stamp.

    1. 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.

    2. Check out the IBM Connections configuration files:

        LCConfigService.checkOutConfig("<working_directory>","<cell_name>")

        where:

        • <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()

        For example:

        • AIX or Linux:LCConfigService.checkOutConfig("/opt/temp","foo01Cell01")

        • Microsoft Windows:LCConfigService.checkOutConfig("c:/temp","foo01Cell01")

    3. 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","").

    4. 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.


Parent topic

Customize the user interface

Related tasks
Add labels to media gallery fields
Customize Files notification templatesSpecify external labels for attributes

Related reference
Work with CMIS API object types

+

Search Tips   |   Advanced Search