Custom Localization enables users to modify existing translations for localized resource data to meet business or regional needs. The Custom Localization form/pop-up window is available to specify a new translation in one or more languages for resource data, e.g., labels, hyperlinks, buttons, and messages, displayed on Essential user interface (UI) pages, such as forms and browse views. For example, assume "Lista" is the most appropriate translation for "List" in the Spanish language, but "Escora" is the existing translation. Custom localization allows you to replace "Escora" with "Lista" for Spanish. A translation for other languages, such as "Liste" for French and/or "Elenco" for Italian, can also be entered. The user's Culture setting determines which value is displayed in the UI. Refer to Custom Settings and Localization for additional information.
Tip: When
localization is required for user-defined values established in the Emergency
and Incident modules, set up a localization resource and enter translation
values on the Localization
Resources form. Custom Localization
does not apply to user-defined localization resources. The other areas
of both modules are available for Custom Localization.
For instruction on custom localization, click the following links or use the scroll bar to scan the page.
Viewing Modules and Pages Where Localization Resources Are Used |
|
- To enter translations using the Custom Localization pop-up window |
|
|
There are three types of translation values for translated resource data in Essential:
Base translation value = The system resource UI value and the basis for language translations. Because Essential is shipped in the default language, English, and with the corresponding default Culture setting, English - United States, the base translation value is displayed in English.
Sphera-provided translated value = The UI value from the translated data provided by Sphera for Essential localization. When your implementation includes localization, translation data is provided by Sphera for certain cultures.
Custom translated value = The UI value entered using the Custom Localization feature. The most recent value entered is displayed.
For example, assume "Country" is the base translation value for the "CountryRes" resource. When the Sphera-provided translated value "Patrie" for the French - France culture exists and a custom translated value "Pays" has been entered, the UI value displayed for a user assigned the French - France culture is determined as follows:
Available Translated Data? |
UI Value Displayed |
1. The Essential implementation has not been configured for localization in French; the base translation value is displayed. |
Country |
2. Translated data for the French culture exists and there are no custom localizations; the Sphera-provided translated value is displayed. |
Patrie |
3. A custom translated value has been entered for the French culture using Custom Localization; the custom translated value is displayed. |
Pays |
The translated UI value is displayed in every instance where its resource value is used in Essential—whether that is a field, check box or button label, section title, message, etc.
Custom Localization provides UI capabilities to replace existing translated values with custom translated values for one or more cultures. Two methods are available:
The Custom Localization pop-up window is available on individual UI pages. It can be accessed by holding down the SHIFT key and moving the mouse pointer over a translatable value. Enter the new value in the field provided and save. A confirmation message is displayed and the UI is automatically refreshed to display the new value. The new value is stored as a translation record for the logged-in user's culture.
The Custom Localization form is available via a link in the Navigation Tree or the Custom Localization pop-up window. One or more translations in different languages can be entered. When a new value is saved for the logged-in user's current culture, the UI typically shows the new value after the Custom Localization form is closed. However, in some instances, a refresh may be required to activate changes.
The Essential application has been designed to use controls and features that maximize performance to provide an efficient and user-friendly method for capturing data and interacting with the software. Most translatable value changes can be made using the Custom Localization pop-up window. In cases where the Custom Localization pop-up window is not available on a page, translation values can be entered via the Custom Localization form instead. Refer to Entering Translations for information about the advantages of using each method.
Regardless of the method used to enter a custom translated value, each language translation represents one translation record that is displayed as a line item in the Localization Resources section on the Custom Localization form. The line item shows the Culture, Custom Translated Value and when applicable, the Sphera-Provided Translated Value. Just one translation record per culture can exist.
After the translated data provided by Sphera has been added to your database, a translation record for each parent culture that is part of your license (plus English - Canada and French - Canada when applicable) is automatically displayed as a line item in the Localization Resources section. A custom translated value can be added, changed, or removed for an Sphera-provided translation record, but neither the record nor its Sphera-supplied translated value can be deleted because they are required by the system for proper translation. The Edit button adjacent to the line item is used to add, change, or remove a custom translated value.
For a culture without Sphera-provided translated values, the Add Custom Localization link is available to initially add a custom translated value. A translation record line item showing the Culture and Custom Translated Value is displayed with an Edit button that can be used to change or delete the custom translated value. When the custom translated value is deleted, the line item is no longer displayed.
A link to the Custom Localization workflow is provided in the Localization Resources section.
The Modules and Pages section on the Custom Localization form identifies the areas of Essential where the resource value is used. Since a custom translated value is displayed in every instance where its corresponding resource applies—whether that is a field, check box or button label, section title, message, etc. in the UI—you may want to review the affected areas before changing the UI value.
To help locate the appropriate value when using the Custom Localization form, the following filters are available on the default browse view:
Translated Value
Base Translation Value
Resource Name
For each record, the Base Translation Value and the Translated Value are displayed for the default browse view. The Base Translation Value is in English and the Translated Value is determined as follows:
The custom translated value entered on the form/pop-up for the logged-in user's culture.
The custom translated value entered on the form/pop-up for the parent of the logged-in user's culture.
The Sphera-provided translated value for the logged-in user's culture (including the English-related cultures).
If there is no translated data that specifically applies to the logged-in user's culture (as described in the three instances above), the Base Translation Value is used. For this reason, the Translated Value column on the browse view is blank.
There is just one record per resource on the browse view. For example, assume the logged-in user's culture is Spanish and Sphera-provided Spanish translated data exists, along with translations for French and Italian. Even though there are three translation records, just one row will be displayed in the browse view. The Spanish value is the Translated Value for the row because the logged-in user's culture is Spanish.
When searching for a specific value, the results may contain what appear to be multiple rows for the same resource value. For example, "State" can mean "Status" or "Geographical Region" in Essential; two rows will be displayed with the Base Translation Value "State". As another example, "Entity" (no colon) and "Entity:" (includes colon) will result in two separate rows. Refer to the Resource Name field on the Custom Localization form to ensure the appropriate resource value is being translated. In addition, the Module and Pages section can help identify where the resource is used within Essential.
The majority of words and phrases within Essential have been made available for translation. Any circumstances that may require special consideration for optimum customization are described below, per module. If one set of circumstances applies to more than one module, details are provided in the All Modules section. Information about Read-only Sphera-provided Translated Values and navigation tips follow the last module.
The Essential application has been designed to use controls and features that maximize performance to provide an efficient and user-friendly method for capturing data and interacting with the application. Most translatable value changes can be made using the Custom Localization pop-up window. In cases where the Custom Localization pop-up window is not available on a page, translation values can be entered via the Custom Localization form instead.
The Base Translation Value "State" can refer to a status or a geographical area. Refer to the Resource Name on the Custom Localization form to distinguish between the two and ensure the appropriate UI value is being translated.
In Essential, BDL is represented as "BDL" and "Below Detection Limit". Enter a custom translated value for both resource values to cover all areas of the application.
On the Sample Quickfill form, the calendar image cannot be localized; custom localization applies only to the translatable values on the form.
Custom Localization does not apply to user-defined localization resource records and associated language translations in the Emergency and Incident modules. Refer to Localization Resources for additional information. The other areas of both modules are available for Custom Localization.
On the Process View Navigation Tree, custom localization applies to the Entity and Search values only.
Custom localization applies to Incident Express and the translatable values involved with this feature can be changed immediately using the Custom Localization pop-up window. When updating translations to meet business/regional needs, consider how the changes may affect the Incident Express users without Essential access or with limited business/regional language knowledge.
The Parameter and Parameter Group Import Review-related forms cannot be localized using the Custom Localization pop-up window. The Custom Localization form must be used instead.
On the Task Calendar, the translatable text above the calendar can be localized, the actual calendar image cannot.
Custom Localization applies to the Auto Task Query Builder with the exception of the filters displayed in the Available Filters list and the Selected Filters list.
The majority of words and phrases within Essential have been made available for translation and Custom Localization. However, some resources are required system resources and must remain static. Examples include tokenized values, data column values in messages, report formula values, and action buttons such as Save, Copy, Cancel, etc. Refer to Read-only Sphera-provided Translated Values for additional information.
If moving the mouse pointer over a label for a radio button does not display the Custom Localization pop-up window, move to the actual radio button. For example, in the Compliance Applicability TreeView, it is necessary to move the pointer over the review status radio buttons instead of the labels (Applies, DNA, NR) to display the Custom Localization pop-up window.
If just a part of the Custom Localization pop-up window is displayed, it may be necessary to resize the browser window or the window panes that show the Navigation Tree and form/browse view to see the entire pop-up window. Another option is to change your browser's zoom level. When using an IntelliMouse and Internet Explorer, you can hold down CTRL and scroll down, which automatically decreases the zoom level.
For translatable values, enter language translations within Essential on the Custom Localization pop-up window or form. The pop-up window contains the existing (custom or Sphera-provided) translated value, a New Value field and a Save button. The existing value is a link to the form. On the Custom Localization form, the resource name, Base Translation Value and Sphera-provided Translated Values, along with existing Custom Translated Values and the modules/pages where the resource value is used within Essential are displayed. Each method for entering a custom value has its advantages:
Easily and quickly change a translatable UI value by opening the pop-up window tor the value, entering the new value and saving. After confirming the change, the page is refreshed and the old value is replaced with the new value entered. This process can be repeated until all values requiring updates have been changed.
A translation is needed in the language of the logged-in user only.
If a resource name is unknown or to review the module pages where a value is used before making a change, the existing value link can be used to open the Custom Localization form for the existing value record.
More than one language translation can be entered for a UI value in the Localization Resources section. Or, a single translation is needed in a language that is different than the language of the logged-in user.
In the Module and Pages section, you can review which pages will be affected by translation changes for the UI value.
A custom translated value can be deleted.
A standard browse view is available to search for resource names. This can be useful to locate UI messages displayed only during certain data entry workflows that may not always be easily reproducible.
The Custom Localization Workflow can be viewed.
Just one custom translation for a resource value in each culture can be specified.
To enter translations using the Custom Localization
pop-up window
Open the browse view or form with the UI value to be updated. When changing a value in the Navigation Tree, expand the tree so the folder/link is displayed.
Hold down the CTRL
key and move the mouse pointer over the value to be changed.
The Custom Localization pop-up
window is displayed and contains the existing value, the New
Value field, the Save
button, and the standard Windows Close
Window icon in the right corner of the title bar. If just a
part of the pop-up window is displayed, it may be necessary to resize
the browser window or the window panes that show the Navigation Tree
and form/browse view to see the entire pop-up window. Another option
is to change your browser's zoom level. When using Internet Explorer,
you can hold down CTRL and
scroll down, which automatically decreases the zoom level.
Verify the value to be changed is
correct by reviewing the Existing
Value. If the value is not the one you want to change, repeat
step 2. When necessary, the pop-up can be closed while holding down
the CTRL key or after the
key has been released.
Tip: If you decide to open the Custom
Localization form via the Existing
Value link, release the CTRL
key first.
Enter a New
Value and click Save.
An informational message is displayed notifying you of a successful
change.
Click OK to refresh the page and review the new value.
Repeat steps 2 through 5 to change another translatable value on the same page. Otherwise, begin with step 1 to make changes on another page.
To enter translations using the Custom Localization
form
Tip: If you accessed the Custom
Localization form via the Custom
Localization pop-up window, begin with step 3.
Click Custom
Localization > Custom Localization in the Navigation
Tree.
The Custom Localization browse
view is displayed.
Use the standard search features to find the resource record and click the record link to open the Custom Localization form.
Review the existing translation
records in the Localization Resources
section to determine if a translated value should be entered for a
new culture or an existing culture. By default, a translation record
exists for each language that is part of your Essential implementation.
Just one translation record for each culture can exist. Therefore,
an existing translation record must be edited even when initially
adding a custom translated value.
Tip: The Modules and
Pages section can be used to review the pages where the resource
applies within Essential, when necessary. Refer to Viewing
Modules and Pages Where Localization Resources Are Used for additional
information.
Use the guidelines below to add a translation for a new culture or existing culture.
Click Add Custom Localization in the Localization Resources section to add a custom translated value for a new culture. Continue to step 5.
Click the Edit button adjacent to the line item to add a custom translated value for an existing culture. Skip to step 6.
Select a Culture from the list.
Enter the Custom
Localization translation value for the culture and click OK.
A new line item is displayed in the Localization
Resources section when translation information is added for
a new culture. For an existing culture, the translation value added
is shown in the line item's Custom
Translated Value field. Change or delete a custom translated
value by clicking the Edit
button adjacent to the line item. The culture can also be edited when
(1) the culture is not associated with an Sphera-provided translated
value or (2) a translation record for the culture does not already
exist.
Repeat steps 3 through 6 to add custom translations for other cultures.
Click Save
and close the Custom Localization
form.
In most instances, the UI is automatically refreshed when the Custom Localization form is closed.
However, it may be necessary to manually refresh or log off and log
back in to activate the changes.
An existing custom translated value can be deleted in the Localization Resources section on the Custom Localization form by clicking the Edit button adjacent to the translation record line item. The deletion process removes the custom translated value and displays the UI value based on the following:
If the custom translated value being deleted is for a culture with an Sphera-provided translated value, the UI value is reset to the Sphera-provided translated value. In this case, the Reset to Sphera Provided Translated Value button is displayed when editing the translation record.
If the custom translated value being deleted is for a culture without an Sphera-provided translated value, the culture and the availability of translation data determines the UI value that will be displayed. For example, an existing translated value for a parent culture or the Base Translation Value may apply. Refer to Custom Localization workflow for information about how UI values are determined. In this instance the Remove Custom Translated Value button is displayed when editing the translation record.
To remove custom translated
values
Click Custom
Localization > Custom Localization in the Navigation
Tree.
The Custom Localization browse
view is displayed.
Use the standard search features to find the resource record and click the record link to open the Custom Localization form.
Locate the custom translated value to be removed in the Localization Resources section and click the Edit button adjacent to the translation record line item.
Click the Remove
Custom Translated Value button or the Reset
to Sphera Provided Translated Value button to delete the custom
translated value.
Tip: For cultures without Sphera-provided translation
data, the culture and the availability of translation data determines
the UI value that will be displayed instead of the custom translated
value. Refer to Custom
Localization Workflow for additional information.
Repeat steps 3 and 4 to delete the custom translated value for another culture.
Click Save
on the Custom Localization
form.
For cultures with an Sphera-provided translated value, the line item
representing the translation record without a custom translated value
is shown in the Localization Resources
section. For cultures without an Sphera-provided translated value,
the line item is no longer displayed.
Close the Custom
Localization form.
In most instances, the UI is automatically refreshed when the Custom Localization form is closed.
However, you may need to manually refresh or log off and log back
in to activate the changes.
In the Module and Pages section on the Custom Localization form, view a list of the modules and forms (pages) where the resource value is used. The file path is also provided for each page. When the UI value for a resource name is changed, the new value replaces the old value on all the pages listed. It is important to note that the list in the Module and Pages section is not all-inclusive because some UI pages and controls, such as pop-up windows and message windows, do not have a resource/system object relationship. In such cases, the module name is based on the file path. A "Common" module name is used when the page or file path refers to more than one module. Although these limitations exist, the Module and Pages section can provide a meaningful representation of the areas that will be affected when a custom translated value is added for a resource.
Standard search features are available to locate specific modules and pages. When applicable, Previous/Next navigation links are displayed to move backward/forward through the list. Ascending/descending column sorting is also available; click a column heading to sort by the values in the column.
Tip:
The names of actual pages (not
form/window titles) have not been localized. As a result, Custom Localization
does not apply. This enhancement will be scheduled for a future release.
The page names displayed in the Modules and Pages section
are based on the logged-in user's culture.
Open the Custom Localization form by clicking Custom Localization > Custom Localization in the Navigation Tree and selecting the appropriate record. You can also click the existing value in the Custom Localization pop-up window to open the form. Expand the Modules and Pages section to view the areas of the application where the resource value is used.
A resource name and a UI value define a resource pair within your Essential database. The UI value is the variable and is either the base translation value, the Sphera-provided translated value, or a custom translated value.
Base translation value = The system resource UI value and the basis for language translations. Because Essential is shipped in the default language, English, and with the corresponding default Culture setting, English - United States, the base translation value is displayed in English.
Sphera-provided translated value = The UI value from the translated data provided by Sphera for Essential localization. When your implementation includes localization, translation data is provided by Sphera for certain cultures.
Custom translated value = The UI value entered using the Custom Localization feature. The most recent value entered is displayed.
For example, the resource pair for the Country field label on the Enterprise Entity form is the resource name "CountryRes" and the base translation value "Country". Assume the Sphera-provided translated value "Patrie" for the French culture exists. In this case, the resource pair is resource name "CountryRes" and value "Patrie". When a custom translated value "Pays" has been entered, the resource pair is resource name "CountryRes" and value "Pays". The logged-in user's culture and available translated data determine the UI values displayed for a user. In this example, the UI value displayed for a user assigned the French culture is determined as follows:
Available Translated Data? |
UI Value Displayed |
1. The Essential implementation has not been configured for localization in French; the base translation value is displayed. |
Country |
2. Translated data for the French culture exists and there are no custom localizations; the Sphera-provided translated value is displayed. |
Patrie |
3. A custom translated value has been entered for the French culture using Custom Localization; the custom translated value is displayed. |
Pays |
It is important to note that the resource pair UI value is displayed in every instance where its corresponding resource name has been applied—whether that is a field, check box or button label, section title, message, etc. in the UI. Just one custom translation for a UI value in each culture can be specified.
The translated data provided by Sphera for Essential is added to the database with the parent culture. Users assigned the parent culture (e.g., Spanish) and users assigned a child culture in the same family (e.g., Spanish - Spain) will see the same translated data, unless separate custom translated values have been entered for a child culture. In this case, the custom translated values will be displayed for users assigned the child culture. This culture hierarchy allows a translated value to be shared by multiple cultures and also allows a specific culture to use a different value for business or regional needs. The Custom Localization Workflow shows how the culture hierarchy is used to determine the UI value. Refer to Culture Settings and Localization for additional information and examples.
The Custom Localization workflow shows how translated data is used to determine the UI value. A link to this diagram is available on the Custom Localization form.
Each custom translated value entered via Custom Localization is stored in the database with the translation record for the resource pair. When an upgrade to a new version of Essential is installed, just the record's other data, such as the Sphera-provided translated value, is updated as necessary. No changes are made to custom translated values; i.e., upgrades do not override Custom Localization translations.
Note:
If you want to add default
translated data for a culture other than the ones provided by Sphera,
the data will be added to the database as custom translated values. These
custom translation records can be edited for business/regional differences
but can also be deleted from the database. To prevent the necessity of
creating replacement records, any records marked for deletion should be
carefully reviewed before initiating the deletion process. Refer to the
Culture
Settings and Localization topic and contact Customer
Care for information about adding default translation data.
By default, Custom Localization capabilities are disabled for all Essential users. Authorization is assigned in the Security Settings section on the User Manager form and provides:
Full access to the Custom Localization form and pop-up window. As long as a user has access to a page and authorization to change translatable resource data, the change will be reflected in all locations within Essential where the same resource is used regardless of the user's security access to the other pages.
A Custom Localization folder displayed in the Navigation Tree.
A link to the Custom Localization form under the Custom Localization folder.
When a user is not assigned Custom Localization permissions, the Custom Localization folder and link to the Custom Localization form are not displayed in the Navigation Tree and the user has no access to the Custom Localization pop-up window. Refer to Setting User Security for additional information.
Note:
Authorization for establishing user-defined resource records and
language translations for the Emergency and Incident modules is assigned
via the General
Security profile. Refer to Localization
Resources for additional information.
When custom translated values are added or edited, the cache of the web server where the logged in user made the entries is refreshed. This process improves Essential performance by allowing the server to retrieve the current translated values for a page from the cached memory instead of the database. The cache expires every 8 hours. Each APE server or other server in a web farm maintains its own cache. Therefore, if a user enters translations on one server, then logs on to a different server or executes a job on an APE server, the translated values may not be displayed until the cache for the different/APE server expires (up to 8 hours).
|
|
|
|
|
