Localize Bamboo Applications or Custom Columns

Localize Bamboo Applications or Custom Columns

Overview of the localization process for Bamboo Products

Bamboo applications and custom columns are slightly different than web parts when it comes to localizing/translating. The user interface isn’t confined to a web part, but can exist as site definitions or other custom pages. For example, the configuration of a Bamboo custom column is within the SharePoint list settings area.
The text strings that require translation are located in different files than the strings that appear in a web part.

Changing the language or text for an application or custom column is a multi-step process:


About the Language Files

Text displayed in a Bamboo application may be included in one or both of the following locations:

  • Provisioning Resources. These resources are located in the 12, 14, or 15 “Hive”, in the Resources folder. The number of the Hive depends on the version of SharePoint you are using (e.g., SP2007 has a 12 Hive, SP2010 has a 14 Hive, and SP2013 has a 15 Hive). 14Hiveresources.jpg

    The Bamboo.*.resx files include text used in site features, site definitions, list definitions, and other provisioning resource elements. Any changes you make in these files will apply to new product instances only.

  • Application/Runtime Resources. These are also located in the 12, 14, or 15 Hive, but in the CONFIGResources folder.The Bamboo.*.resx file in the CONFIG folder is different than the one included in the Resource folder.14HiveCONFIGResources.jpg This one includes text used in application pages, custom site menu actions, navigation elements, and other runtime resources. Any changes you make will apply to new and existing product instances only.

In each location, there may be multiple versions of Bamboo.*.resx files with identical content. The different files are provided for English (en-US), German (de-DE), French (fr-FR), and Spanish (es-ES). The content of all files is in English until you translate it to your language. If your site is configured to use a language that does not have a corresponding Bamboo product .resx file, copy an existing file and rename it to include the culture name for that language pack. For example, create a file for Italian by saving the default file as Bamboo.[Product].it-IT.resx. Make your changes to this new file. If your site is configured to use a specific language but you do not have a culture-specific file, the product will use the default Bamboo.[Product].resx file instead.

Icon-WarningIMPORTANT: If you customize one of the default resource files provided with the product, your changes will be overwritten when you upgrade.

To avoid losing customizations, copy the customized file to a different location (not the same folder) before upgrading. After the upgrade is finished, compare the new file with your customized file to incorporate any new entries. Then copy the merged file to the Resources folder. Culture-specific files created for languages that are not provided with the product will not be overwritten during an upgrade, but you still need to incorporate new resource entries.


Editing text in resource files

Icon-WarningIMPORTANT: Before making any changes, back up your original file to a different folder.

To change text in a resource file, open it in a text editor and locate the text you want to change. Editable text is usually found between the <value></value> tags, as shown in the screen shot below. Do not modify the data tag. If you want to remove text completely, delete only the text; do not delete the <data> or <value> entries from the file, or the server will display an error message. In the example below, the editable text is highlighted in gray.


When you are finished with your changes, save the file and copy it to the appropriate Resources *folder on *all Web front-end servers in your SharePoint farm. Follow the instructions below to make your changes take effect.


Applying Language File Updates

To apply changes to Provisioning Resource Files:

If you modified the provisioning resources file, apply your changes by restarting Web services with the following command on all Web front-end servers.


NOTE: changes to provisioning resources affect new instances of the Bamboo product only; existing instances of the product are not updated.

To apply changes to Application/Runtime Resource Files:

If you modified the application/runtime resources file, apply your changes by executing the following stsadm command on all Web front-end servers. This command copies the updated resource file to the App_GlobalResources folder of each Web application. Changes apply to existing product instances and any new instances you create.

stsadm -o CopyAppBinContent

NOTE: Changes apply to EXISTING product instances AND any new instances you create.

Configuring the Bamboo KPI Column Display Web Part

Configuring the Bamboo KPI Column Display Web Part

To configure the Bamboo KPI Column Display Web Part:

  1. Select the down arrow on the far right-hand side of the Web Part title bar, then select Modify Shared Web Part.
  2. From the tool pane, you can change the name of the Web Part under the Appearance section.
  3. Select a list that contains the KPI Columns. Make sure the Web Part was added to a page that is on the same site as the list with the KPI Columns you want to display.
    HW41J WebPartSetup.jpg

  4. Select the KPI Columns you want to display in the Available KPI Columns box (using Shift/Ctrl + Click), then select the right arrow button to move them to the Selected KPI Column(s) ** box. Click the double right arrow button to move all the available KPI columns to the Selected KPI Column(s) box. Click the Up or Down buttons to order the KPI Columns in the Web Part.

  5. Enter in the column header text you want for each column that displays in the Web Part.
  6. You can choose to show or hide any column by selecting or clearing the Hide check box next to the column header of your choice.
  7. Select a language from the drop-down menu to translate the Web Part user interface and tool pane settings. You can also create your own translation or modify the default files available in the drop-down menu. See Customizing the Language Setting for more information.

NOTE: The translation options for Spanish, French, German and English are currently all still in English. You must customize the files directly to translate the Web Part user interface to the language you require. See Customizing the Language Setting for more information.

  1. Click Apply, then OK.
  2. An example of the Bamboo KPI Column Display Web Part (based on the configuration screenshot above) is as follows:
    HW41J WebPart.jpg

How to Modify KPI Settings

How to Modify KPI Settings

Some of PM Central’s lists feature the Bamboo KPI Column. This is a custom column type that evaluates the contents of a column in another list (e.g., Sum, Count, etc.), compares the results against a set of criteria, and displays the value and an icon indicating which of three categories the value falls in.

For example, in the project Site, the Project Info section uses Bamboo KPI Columns to indicate the current health of the project. One of these columns, Issue Status, looks at the project’s Issues list and counts the number of items displayed in the Overdue Issues view.

  • If there are no items in that view, a green icon is displayed.
  • If there are between one and five issues, a yellow icon is displayed.
  • If there are more than five issues, a red icon is displayed.

To modify the settings for the KPI custom columns:

  1. Navigate to the list containing the KPI column you want to update, such as the Project Health List.
  2. From the List Tools tab on the top ribbon, select List.
  3. Select List Settings from the right side of the ribbon.

  4. Select the column you want to customize under Columns.

  5. Under Additional Column Settings, modify the settings as desired, such as choosing the list, the view, how the column values are evaluated, what the criteria for the values are, and how the KPI is displayed (type of icon, whether to include values, etc.).

  6. Click OK.