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:

Top

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.

Top

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.

Common_resxEdit.jpg

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.

Top

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.

iisreset

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.

Custom Identifier formats using the Bamboo Custom Identifier Column

Custom Identifier formats using the Bamboo Custom Identifier Column

Overview of Custom Identifier Column configuration settings

The format of the Custom Identifier is determined in the columns configuration screen

CustomID-ex1b.png
The above image has been edited to show available options from the drop down selectors

CustomID_ex2b.png
1. Include Auto-Incremented Number is a numerical value that increments for each new item. Select the desired number of digits between 1-5 from the drop down.


2. Include Text String allows you to insert static text into the identifier. This field can be used to add a prefix to the Auto-Incremented Number


3. The date and time of the items creation can become part of the identifier when you select Include Current Date and Time and select the date format from the drop down selector.


4. To include value from another column in the same item, check the Include Column From Current Item box and select the desired column from the drop down selector.

Icon-WarningImportant:
When including column values in the format of the identifier, only these column types are supported:

  • Single text
  • Currency
  • Number
  • Date time
  • Choice (drop-down and radio)
  • Multi text (multi line, but not rich text),
  • Lookup (not Multi-value Lookup)

5 Both the List Name and the Site Name can be included in the automatically generated ID.


6. As identifier components are checked, they will be added to the Order of Selected Variables list box. Use the arrows to change the item order.


7. Identify the delimitation between identifier variables. By default None is selected.


8. Define the Identifier Case to ensure standardization in the presentation of identifier elements:

  • Capital – the first letter will be capitalized while all other characters will be lower case

  • Upper – all characters are capitalized

  • Lower – all characters are lower case