Page Comparison

Section

Column

The internationalization feature enables you to easily localize your forms for target audiences that vary in culture, region and language. supports all ISO 639-2 languages worldwide including RTL (right-to-left) languages. The list of available languages and locale codes can be configured in your instance of (In-house only). Translations use UTF-8 encoding by default but you may also upload ISO 8859-1 (Unicode) strings.

Column

width	350px

On this page:

Table of Contents

maxLevel	2

...

Info

Notice that the strings on the left side of the '=' have spaces escaped with the '\' character. This is needed so do not remove that. The escape character is not needed on the right side of the '='. The example above correctly has "First\ Name" on the left and "Primero Nombre" on the right.
If you have a label that contains a colon, it must be escaped in the in the default translation files. Newly downloaded default translation files properly escape a colon with a '\'. Translation files with strings containing colons will have to be re-uploaded with the colon properly escaped.

You may find some strings in the default properties file that are not applicable to your form. Here are a few example strings that are only applicable if you're using the save/load feature, workflows feature or Electronic Signatures.

...

Translations use UTF-8 encoding by default but you may also upload ISO 8859-1 (Unicode) strings. If you are using Unicode, check the ISO checkbox above the upload button.

Error message strings that the designer adds to a form using the error message property are translated using these uploaded translation files. The translation of built-in error messages is done in the translation file located in the <frevvo-home>/tomcat/webapps/frevvo directory. war.

Note

You can only specify one translation per language. For example, if a browser locale is set to ger (German) or de-at (German/Austria), your form will be translated using the one german translation you uploaded.

If you click the test button you'll see the URL with &locale=ger and you'll see your form translated to your german strings. And if you manually change the URL to &locale=de_at you will still see your german strings. Live Forms falls back to the single german translation file.

...

will recognize the browser locale and alter displays and input formats as well as language according to the user's browser setting. Refer to browser Locale Handling for the details. You can override the browser's locale setting via the form's locale URL parameter which is typically only done for testing your translations. For example to render the form in Spanish rather than the default browser locale, add &locale=spa to the form Url. The test button and the share button on the Locale Home Page do that for you automatically. The test & share buttons on the Forms Home Page do not set the locale parameter and thus use the browser's default locale setting.

...

In-house supports the ability to customize runtime and design time strings and add additional locales and RTL languages. To make any of these changes to your In-house server you must follow these steps:

Stop the server
Uncompress/expand the frevvo.war file. This is typically located here: Open the directory <frevvo-home>/tomcat/webapps/frevvo.war
Copy the /WEB-INF/data directory to a temporary location.
Modify the files in /WEB-INF/data as described in the topics Adding Locales, Runtime Strings and Design-Time Strings below. These files contain all of the strings that have been externalized as well as the list of supported locales and directions.
Re-WAR to create a new updated frevvo.war file.
Replace the original frevvo.war file with the updated one, typically located here: <frevvo-home>/tomcat/webapps/frevvo.warReplace the /WEB-INF/data directory with your modified version.
Re-start your server.

Adding Locales

To add new locale codes to the Choose Locale dropdown and add/change which locales are right to left languages, update these two properties files located in the /Web-INF/data/users directory in the frevvo.war file. the <frevvo-home>/tomcat/webapps/frevvo directory

/WEB-INF/data/users/locale.directions - add/remove locale codes to this file that need to be displayed in rtl format
/WEB-INF/data/users/locales.properties - add/remove locale codes here from the Choose Locale dropdown - when adding locales ensure that strings are unique and conform to ISO 639-2 (three character code) standards

Refer to the steps above under Server Customization for the instructions to unzipreplace the /rezip the <frevvoWEB-home>/tomcat/webapps/frevvo.war .INF/data directory.

Creating Runtime and Design-Time Translations

Runtime strings such as those found when a user logs in to access their task list, the login page, access denied messages, etc and Design-time strings such as those found in the palette controls, wizards, built-in error messages etc. are localized in the default file in the WEB-INF/data/locale directory.

Follow these steps:

Refer to steps 1 and 2 above under Server Customization to unzip frevvo.war, then...
Find the file named "default" located in /WEB-INF/data/locales. This file contains all of the runtime and designer strings that have been externalized. Notice there are partially completed Chinese and German sample translation files provided in this directory as well.

Copy the file "default" to a new file named using the ISO 639-2 three character or the the ISO 639-1 two character language codes .For example, the German translation file can be called ger or de, for English you can use eng or en. The Portuguese translation file can be named por or pt and the Chinese translation file an be chi or zh.

Tip

Translation files can also be named to specify a country code. In this case you must name the file using this format: <language code>_<country code>. For Example, let's say the Firefox browser is set for de-at (German/Austria). The translation file in the Web_INF/data/locales directory MUST be named de_AT. The de represents the german language, followed by the underscore followed by a capitol AT which is the country code for Austria. These file names are case sensitive.

There are several files for specific areas of the application. The names of these files indicate the area for which the file contains externalized text strings:
- form-designer-properties
- flow-designer-properties
- flow-designer-step-properties
- rule-builder
- frevvo-ui (currently covers the template install dialog)
Pre-pended the locale onto the file. For example for french, "form-designer-properties" becomes "fr-form-designer-properties". All 6 files are required for each locale in order for this to work properly. For example for french (fr), you must place the following files into WEB-INF/data/locales, even if not all of them are translated:
- fr
- fr-form-designer-properties
- fr-flow-designer-properties
- fr-flow-designer-step-properties
- fr-rule-builder
- fr-frevvo-ui
Edit the new language file and add your translations.
Refer back to steps 4 - 6 under Server Customization for the instructions to complete.

Here is a section of the chi (Chinese) translation file with translations for the palette controls in the designer. This file is included in the frevvo directory.war.

Code Block

# Default strings in the frevvo UI
# Form designer
Text=ä»–é¥¿å°ä»–
TextArea=ä»–é¥¿å°ä»–å•Šäººé¥¿å•Š
Date=çš„å•Šä»–é¥¿
Time=ä»–æ²¡é¥¿
Date/Time=çš„å•Šä»–é¥¿ï¼ä»–æ²¡é¥¿
EMail=é¥¿æ²¡å•Šä¸€äº†
Money=æ²¡å“¦å¹´é¥¿æœ‰
Phone=æ‰¹å’Œå“¦å¹´é¥¿
Quantity=åŽ»å“¦å“¦å¹´ä»–å“¦ä»–æœ‰
Number=å¹´å“¦æ²¡ä¸é¥¿äºº
BooleanCheckbox=ä»–ï¼å‘
Image=å“¦æ²¡å•Šä¸ªé¥¿
Video=æˆ‘å“¦çš„é¥¿å“¦
Submit=æ˜¯å“¦ä¸æ²¡å“¦ä»–
Cancel=æ‰å•Šå¹´æ‰é¥¿äº†
Dropdown=çš„äººå“¦æ‰¹çš„å“¦æˆ‘å¹´
Radio=äººå•Šçš„å“¦æ‰¹
Checkbox=æ‰å’Œé¥¿æ‰å¯ä¸å“¦å°
Section=æ˜¯é¥¿æ‰ä»–å“¦å“¦å¹´
Repeat=äººé¥¿æ‰¹é¥¿å•Šä»–
Tabs=ä»–å•Šä¸æ˜¯
Tab=ä»–å•Šä¸
Panel=æ‰¹å•Šå¹´é¥¿äº†
Table=ä»–å•Šä¸äº†é¥¿
Col=æ‰å“¦äº†
Message=æ²¡é¥¿æ˜¯æ˜¯å•Šä¸ªé¥¿
Link=äº†å“¦å¹´å¯
Trigger=ä»–äººå“¦ä¸ªä¸ªé¥¿äºº
Upload=å“¦æ‰¹äº†å“¦å•Šçš„

...

will detect the language setting of the browser and search for a corresponding ISO named translation file in the WEB-INF/data/locale directory . If a translation file exists, the designer and server-wide runtime strings display with the translations specified in this file. If the translation file does not exist, the designer and server wide runtime strings display in English - the language of the default translation file. If a locale specific file does not contain a particular property or string, then the English translation in the default file is used.

When you first examine the locale directory, you will notice a sample translation file named ger (German). Let's say you copy/modify the default translation file to make a second file for German named with the ISO 639-1 two character code - de. Then you create/modify another German translation file and name it de_AT for German/Austria.

Select German/Austria (de-at) as the language in the Firefox browser and log into as a designer user. The designer displays the translations from the de_AT file. If thee de_AT translation file was not present in the WEB-INF/data/locale directory, the designer and server-wide runtime strings display the translations specified in the ger (German) file. If the ger file was not present in the locale directory, the translations in the default file (English) would be used.

To display the designer and server-wide runtime strings using the translations from the de (German) file, you would have to change the language in the browser to German (de).

ISO 8559-1 Unicode Characters

There are two options for the runtime and design-time translation strings.

UTF-8 encoded language files named with ISO language codes without any extension. Examples would be spa, ger, de, es, de_AT etc
Unicode versions using the same name but with an extension of .unicode. For example, the French unicode language file would be named fre.unicode. This file must contain the unicode equivalent for any international characters that cannot be properly represented in the UTF-8 language file. Some examples are shown in the image:

For example, let's say you are translating the designer to Spanish (es) and the Spanish word for the video control is vÃdeo.

Follow the steps above to copy the default properties language file to make the spa.unicode file.
Provide the translations.
To properly represent the Ã, you must provide it's unicode equivalent. You can use a tool such as native2ascii which is included in the JDK to convert the international characters to their unicode equivalents. Be sure to save the file with UTF-8 encoding before running the conversion.
Or you can manually encode international characters by replacing it with \uxxxx where the xxxx is the 4 digit hex value for the unicode character.
Refer back to steps 4 - 6 under Server Customization for the instructions to complete.

Here is what the Video control looks like in the designer if the entry in the spa.unicode file for the Spanish word for video contains the unicode equivalent for the Ã (\u00e). The language of the browser is set to Spanish (es - if using Firefox):

The UTF-8 and unicode files for a language must reside in the <frevvo-home>/tomcat/webapps/locale directory. You can mix the two different file types with regards to different languages. For a particular language/locale, the system will try to load the UTF-8 version first.

Testing Runtime and Design-Time Translations

Runtime Translations:

Test that your Runtime string translations show up as expected, for example on your Task list by:

Get the share Url to your task list
In another browser window/tab, paste the url and append "&locale=yyy" where yyy is the target language code and the name of the target language file that was added to the war file.

Code Block
http://localhost:8082/frevvo/web/tn/nancy.com/subject/designer/tasks?submissionState=PENDING?embed=&locale=spa

If you append &locale=spa to the task list as a test as discussed above you will notice that ' surrounding page content is visible (as expected) and is not localized. This is correct and expected behavior. You are expected to embed the task list in your own localized web site.

Design Time Translations:

Test that your designer translations show up as expected by:

Set your browser to the target language.
Login to the as a designer user.
Edit a form to verify the designer strings are translated to the language specified by the language file that was added to the war file. An example is shown in Chinese translation example above.

...

Date and time type controls are locale parsing and formatting aware. When Automatic format is selected, both date and time entry and display formatting will be locale specific.The designer has the option to force a particular date or time format upon the users that is independent of the locale by using the date format and time format properties. but this is not recommended.

...

The automatic locale specific formatting and parsing for date, time and date/time controls can be configured by manually adding the following properties in the locale properties file:

Property Name	Purpose	Notes
frevvo.date.format	Allows the admin to configure the locale specific format pattern for date controls and the date portion of date/time controls. If not set it falls back to the system default value for the locale as derived from the Java runtime.	See http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html for date and time formatting pattern rules.
frevvo.time.format	Allows the admin to configure the locale specific format pattern for time controls and the time portion of date/time controls. TIf not set it falls back to the system default value for the locale as derived from the Java runtime.	See http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html for date and time formatting pattern rules.

For example, let's say you want to change the MM.DD.YYYY to display as "Day of the week, Month Day ,year" in the German locale. Simply add the following to the ger locale file located in the WEB-INF/data/locale directory after expanding the frevvo.war as explained above:

Code Block
frevvo.date.format="EEE, MMM d, ''yy"

After rezipping and replacing the frevvo.war /WEB-INF/data directory file with the updated one, the date will display as shown in the Firefox browser set for the German locale:

...

Tip
To translate AM and PM in time / date-time control formats, assign the value "h:mm a" to the frevvo.time.format property in the concerned locale file.

Date Picker

The Date picker will be automatically translated according to the browser locale. You can override the browser setting by adding the properties shown below to the locale file. This localization only applies to the date picker on the desktop as the native date picker will be shown on mobile devices. You can translate (locale-specific) month names and abbreviated day of week names (two character). The days of the week will always be shown as Sunday through Saturday, left to right on the date picker. Only the Gregorian calendar system is supported.

To localize the date picker on the desktop, manually add the following properties in the appropriate locale properties file in the WEB-INF/data/locale directory after expanding the frevvo.war as explained above.

Property Name	Purpose
frevvo.date.month.1	Allows the admin to override the locale specific short name for the 1st month of the year (January). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.month.2	Allows the admin to override the locale specific short name for the 2nd month of the year (February). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.month.3	Allows the admin to override the locale specific short name for the 3rd month of the year (March). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.month.4	Allows the admin to override the locale specific short name for the 4th month of the year (April). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.month.5	Allows the admin to override the locale specific short name for the 5th month of the year (May). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.month.6	Allows the admin to override the locale specific short name for the 6th month of the year (June). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.month.7	Allows the admin to override the locale specific short name for the 7th month of the year (July). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.month.8	Allows the admin to override the locale specific short name for the 8th month of the year (Aug). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.month.9	Allows the admin to override the locale specific short name for the 9th month of the year (Sept). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.month.10	Allows the admin to override the locale specific short name for the 10th month of the year (Oct). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.month.11	Allows the admin to override the locale specific short name for the 11th month of the year (Nov). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.month.12	Allows the admin to override the locale specific short name for the 12th month of the year (Dec). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.weekday.1	Allows the admin to override the locale specific short name for the 1st day of the week (Sunday). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.weekday.2	Allows the admin to override the locale specific short name for the 2nd day of the week (Monday). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.weekday.3	Allows the admin to override the locale specific short name for the 3rd day of the week (Tuesday). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.weekday.4	Allows the admin to override the locale specific short name for the 4th day of the week (Wednesday). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.weekday.5	Allows the admin to override the locale specific short name for the 5th day of the week (Thur). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.weekday.6	Allows the admin to override the locale specific short name for the 6th day of the week (Fri). This overrides the system default value for the locale as derived from the Java runtime.
frevvo.date.weekday.7	Allows the admin to override the locale specific short name for the 7th day of the week (Saturday). This overrides the system default value for the locale as derived from the Java runtime.

For example, Let's say you add the properties below to a Chinese translation file named zh:

Code Block
frevvo.date.month.1=JaC frevvo.date.month.2=FeC frevvo.date.month.3=MaC frevvo.date.month.4=ApC frevvo.date.weekday.1=Mc frevvo.date.weekday.2=Tc frevvo.date.weekday.3=Wc frevvo.date.weekday.4=Tc

After rezipping and replacing the modified frevvo.war modified /WEB-INF/data directory file, restarting and setting the Firefox browser to Chinese - zh, the date picker will display as shown in the image:

...

Versions Compared

Old Version 8

New Version 9

Key