You can add custom strings or modify existing strings when performing certain tasks in IBM® Lotus® Connections, without having to update product resource files.
Before you begin
When adding custom strings to Lotus Connections, you must use the wsadmin client. See Starting the wsadmin client
Lotus Connections provides a external resource bundle loader for adding and updating strings to Profiles, Communities, and the Home page. You can only use this mechanism when performing the following tasks:
- Adding custom extension attributes to profiles
- Customizing the Profiles business card
- Adding custom widgets to Communities, Profiles, and the Home page
- Configuring the vCard export application
- Renaming the tabs in the Home page
- Adding custom themes to Communities
For any other scenarios that are not explicitly listed above, you can add custom strings by following the steps outlined in Customizing product strings
About this task
To add custom strings for the scenarios listed above, you need to create a bundle containing the strings and save it in the <customization_dir>/strings
directory that is created at installation time. You must then register the file in the LotusConnections-config.xml
file. For performance reasons, include all the resource strings in a single bundle.
- Create a properties file containing the strings that you want to add in the <customization_dir>/strings directory.
Register the resource bundle in the LotusConnections-config.xml file:
- To specify the name of the default properties file, use the following syntax: <resource_bundle_name>.<properties_file_name>
- To specify custom strings in multiple languages, append an underscore followed by the appropriate language code to the resource bundle name using the following syntax: <resource_bundle_name>_<language_code>.<properties_file_name>
- Open a command window and start the wsadmin command-line tool as described in the topic, Starting the wsadmin client.
- Enter the following command to access the Lotus Connections configuration file:
Enter the following command to check out the Lotus Connections configuration file:
From the temporary directory to which you just checked out the Lotus Connections configuration files, open the LotusConnections-config.xml file in a text editor.
Add the following line of code into the <resources> element block to register the resource bundle:
Save your changes to the LotusConnections-config.xml file.
To check in the updated file, use the following command:
<widgetBundle prefix=<bundle_prefix> name=<bundle_name> />
The following sample code is used to register the com.example.resources bundle:
- <bundle_prefix> is a globally unique name that identifies the bundle. This is a string value. The bundle prefix is used to uniquely scope the keys in each bundle. The prefix must be unique across all registered widget bundles.
- <bundle_name> is the Java™ package name. This parameter takes a string value. When you name the resource bundle, the elements in the bundle name must correspond to the file name of the properties file that you created in step 1.
For example, if the strings customization directory contains the files com.example.resources.properties, com.example.resources_en.properties, and com.example.resources_sk.properties, the name of the bundle is com.example.resources.
<!-- Example: The attribute 'prefix' must be globally unique as it identifies the bundle when used in Lotus Connections. -->
<widgetBundle prefix="example" name="com.example.resources"/>
To exit the wsadmin client, type exit at the prompt.
What to do next
, and Administration
tabs in the Home page.
Note that when you specify external labels for attributes, editable attributes, or custom extension attributes, the labels are only applied to the user interface element that the configuration object represents. For example, if you apply a custom label to a business card <attribute> element, the label does not automatically apply to the same element in the advanced search page layout. For information about how to apply the label configuration to each user interface element individually, see Specifying external labels for attributes
Example: Adding custom strings
The following code shows some examples of the type of custom strings that can be added using the external resource bundle loader.
Parent topic: Customizing product strings
Customizing the Profiles business card
Starting the wsadmin client
Enabling custom extension attributes for Profiles
Configuring the vCard export application for Profiles
Configuring Profiles directory search options
Enabling custom widgets for Communities
Enabling custom widgets for Profiles
Specifying external labels for attributes
Adding third-party links via the XML configuration file
Adding a theme to the Communities configuration file
Installing the non-English version of the SharePoint widget for Communities