Tanslation Maintenance Page	Top

The Translation Maintenance page (System Admin → Configuration → Translations) provides these operations:

Operation	Procedure
Add a Language SDI	Click "Add Language" in the toolbar. In the resulting dialog, enter the identifier and (if desired) description of the Language SDI. Select this "Language" in the User Maintenance Page to assign this language to a user. The language is added to the list of "Languages" at the left of the page. You can also add a Lanuage SDI from the System Admin → Configuration → Languages tramstop: Note the "Right To Left" option. For this specific Language, this option determines if the User Interface is presented left-to-right or right-to-left. To use this feature: a. Set "Right To Left" to "Y", then "Save". Note that if left blank, this defaults to "N" (left-to-right). b. In the User Maintenance page, assign this Language to the desired User by selecting from the "Language" dropdown). When the User logs onto LabVantage, the User Interface will be presented right-to-left. NOTE: The "Columns → Language Direction" property of the maint Element and sdclinkmaint Element can be used to override the Language for fields that continue to display English text regardless of the User's Language.
Choose a Language SDI for viewing or editing	Select the language from the list of "Languages" at the left of the page.
Add a text string to the Translation Master List and translate the string	a. Select (check) the language from the list of "Languages" at the left of the page. b. Click "Add" in the toolbar. This inserts a blank input field for the text string and its translation. c. For the "TextId", enter the text string you want to translate in the translated column for the language ("Language-001" in the example below). d. A "Context" of "W" translates all instances of the TextId everywhere in the application. This is suitable for most translations. For other options, see Context Translation. e. If you are conducting translation client-side by the translate and translate.Partial JavaScript methods called on the sapphire object, check "CF" (Client Flag). If you do not know what that means, do not check "CF". The translation will then be done server-side. Note that any translated text that is not defined in the TransMaster table at runtime is stored in the TransMasterTemp table if the "Auto fill temporary translation table" is set to "Yes" in System Configuration → Miscellaneous Options → Translations.
Search for and retrieve text strings in the Translation Master List	a. Choose the Language SDI(s). Search can be conducted on multiple languages. b. Choose the search criteria from the Search for texts to translate options: Search Criteria Retrieves text strings that... Containing ...contain the contiguous string of characters you enter. Starting with ...begin with the contiguous string of characters you enter. Ending with ...end with the contiguous string of characters you enter. If you do not specify any search criteria, all text strings are retrieved. c. To constrain the search to the exact case entered, check "Case Sensitive" (Oracle DBMS only). d. To constrain the search to translation conducted client-side by the translate and translate.Partial JavaScript methods called on the sapphire object, check "CF" (Client Flag). e. To search a specific context, select it using "Search In Context" (see Context Translation). f. Click "Search Now". You can edit the Translation of any text string returned by the search.
Edit translations for text strings in the Translation Master List	a. Choose the Language SDI(s). Editing can be conducted on multiple languages. b. Search for and retrieve the relevant text strings from the Translation Master List. c. Edit the translation in the translated column. For example, if you want to change the translation for "Text" in the example above, edit the "Language-001" column. d. To delete a translated text, select (check) the row containing the text, then click "Delete" in the toolbar.

In general, TextId is matched first to maintain backward-compatibility with previous LabVantage versions. If no match found, the following lenient matching operations are sequentially attempted on TextId until a match is found:

For example, for this single translation entry in French:

add more examples → ajouter d'autres exemples

All of these texts are translated:

add more examples → ajouter d'autres exemples
Add more examples → Ajouter d'autres exemples
Add more examples. → Ajouter d'autres exemples.
Add more examples: → Ajouter d'autres exemples:
ADD MORE EXAMPLES? → AJOUTER D'AUTRES EXEMPLES?

This exports the search results of Text Ids, Contexts, and other translation information in a fixed Excel format. Exported Excel can be edited in Excel, then imported using "Import from Excel".

This opens a dialog that lets you choose a client-side Excel file, which must have the same format as that created using the "Export Search To Excel" operation. For your convenience, the "Transmaster Spreadsheet" directory of the LabVantage Distribution provides Excel spreadsheets that contain many of the TextIds used in the OOB LabVantage configuration. The Transmaster spreadsheets for LabVantage 8 were not available at the time this was written, so check the LabVantage 8 Release Notes for details regarding the actual spreadsheets that are provided in the LabVantage Distribution.

You can use Transmaster spreadsheets to form the basis of your Translation table for a given Language. The spreadsheet contains the Text Id, Context, and CF columns. Enter your Language Id in the first row of the fourth column, then save the file. You can then enter your translations in the fourth column, then use "Import From Excel" to populate the TransMaster and TransLanguage tables and work with the translations in the GUI.

If a matching TextId and Context are found in the TranslationMaster table, the corresponding translated text is inserted or updated if the Excel file contains the translation. If the TextId and Context does not exist in the TranslationMaster table, they are inserted into the TranslationMaster table first. The Client Flag (CF) is updated from the imported Excel file, which must contain correct "CF" values if exported from the TransMasterTemp table.

This is a development tool that consumes a great deal of resources. Never use it on a production system. To use this, logon as a user with the relevant language and clear the Web Page Designer cache (see Monitoring → System Monitor → Cache Sizes).

This operation loads a JSP page that retrieves all Web Page Designer pages containing translated texts that are not in the TransMaster table. The page refreshes to generate progress feedback, as the operation requires a considerable amount of time. This also collects Text Ids from Reference Values/Reference Display Values, column labels in the data model, single/plural SDCIds, Query names, Query argument titles, and Report argument titles.

This exports the Transmastertemp table in a fixed Excel format.

Context Translation	Top

When the same text for a given language must have multiple translations depending on usage or context, you can use "Context Translation" to differentiate among the common text. For example, the text string "Add" may be "Add" on a advancedtoolbar button, but "Add Single" on an sdclinkmaint button. The TranslationContext Reference Type contains these predefined contexts OOB (you can add more if required):

A context of "W" indicates that all instances of the text will be translated everywhere throughout the application. For the Reference Values, a dot syntax of context translation follows an inheritance structure. Context is matched case-sensitively from the most specific context to the least specific context (which is W) until a match is found. If a TextId has only one context, the context is ignored.

For example, button.text is a subcontext of button W (the default context that defines everything). To translate "Add" on a Button text property where the translation context is button.text:

Context translation is not supported by the JavaScript API (translate and translate.Partial called on sapphire object). those methods build the JavaScript only for TextIds in the TransMaster and TransMasterTemp tables with ClientSideFlag set to Y. The "Auto fill temporary translation table" in System Configuration → Miscellaneous Options → Translations sets the ClientSideFlag to Y if a missing translation is client-side.

When translating properties in the Web Page Designer, a default context will replace "W" (or be appended to the existing Element property) if the existing <Root> level context is specified and is not "W". For example, if the existing context is column.title, the final context at page rendering time will be column.title.Sample on the Sample List page, and column.title.Address on the Address List page. Default context is determined in the following sequence:

The default context in list, maint, and sdclinkmaint Elements is:

You can choose the context at the <Root> node of each property tree. This affects all child (descendant) nodes. Dynamic Lookup is also supported. Single translation is also available using the icon shown below.

The maint and sdclinkmaint Elements contain the property Columns → Translate Value → No (Allow Edit Translations). For the column modes specified in the maint and sdclinkmaint Elements, this adds an icon to to the field which (onClick) opens a Translation Maintenance page for single translation by the user on the page detail itself:

header columns in gwtdataentrygrid Elements are translated server-side. If the header is ParamListId, VariantId, ParamId, or ParamType, the default SDCId context is ParamListId. For other headers, the default context is the primary SDCId.

Finding Untranslated Text	Top

"Untranslated text" refers to text that should be translated but is not. There are two type of untranslated text:

To assist in finding untranslated text, the "Show Translations" option in System Configuration → Miscellaneous Options → Translations lets you see translation status throughout the application. Set "Show Translations" to "Yes", then restart the Application Server and logon as the User having the Language you want to test. Then examine all of the pages you want to debug.

All texts that are translated server-side or client-side are tagged with a dollar sign ($) at the beginning and end if a translation does not exist. When a translation is found, the text is replaced with the first letter followed by an underscore (_____). For translations with defined Context, the context is shown (such as button.text.Sample below). A text is not tagged at all if it is not translated by code.

Java API for Translations	Top

Context translation is supported by these API methods in sapphire.accessor.TranslationProcessor:

Context translation in Reports in also supported by sapphire.report.JasperReportScriptlet using translate( String text, String context ). Specifically, this default translation context is supported:

Here are some guidelines for best coding practices: