Skip to main content
Documentation
Documentation
Administrator Guide
Last Updated: 2023-06-23
Create a Translation Resource File for the Default Locale Language

Create a Translation Resource File for the Default Locale Language

Create a report design file.
You must provide certain resource files to enable automatic label translation in Report Designer. One of these is a file that associates a resource key with some text in the default locale language. Other resource files provide text for that same key in a target language. Report Designer can then swap the default locale language text for the target language text when it encounters the key that they have in common.
  1. To create a resource file, select
    File
    New
    Other...
    . Expand the
    General
     node and select
    Untitled Text File
    .
  2. Add keys to the text file in the format
    Key=Value
    , where
    Key
     is the name you want to give to the resource key and
    Value
     is the appropriate text in the default locale language. Example:
    Terms=Your employment with our Company includes the following agreed upon terms:
    . Give each new key its own line in the text file.
    Resource file keys can't contain spaces.
  3. Save the text file in the relevant project folder with the filename
    translations.properties
    .
    The translation resource file for the default locale doesn't have a locale suffix such as
    en_US
     or
    fr_FR
    . Translation resource files for target languages do have these suffixes.
  4. You must now associate the resource file with the report design file. To do so, open the design file and select the
    Resources
     tab of the
    Property Editor - Report
     view.
  5. In the
    Properties Files
     section, add the
    translation.properties
     file you just created.
The following text is an example of a
translation.properties
 resource file's contents:
Dear=Dear
Congratulations=Congratulations on joining our team. We're excited to have you!
Terms=Your employment with our Company includes the following agreed upon terms:
Date_Of_Hire=Date of Hire:
Business_Title=Business Title:
Manager_Name=Manager Name:
Organization=Organization:
Location=Location:
Base_Pay_Amount=Base Pay Amount:
Hire_Advice=Please be advised that your employment with the Company will be "at-will", which means that either you or the Company may terminate your employment at any time, for any reason or no reason, with or without notice. There is no promise by the Company that your employment will continue for a set period of time or that your employment will be terminated only under peculiar circumstances.
Sincerely=Sincerely,