Back Forward About the Localization wizard

zzz Show all 

Use the Localization wizard to make an application available in one or more additional languages. The localization process overrides text in user-visible field value rules that appear in application elements such as work object forms and portal displays. The wizard automates many of the steps necessary to create language-specific RuleSets.

zzzHow the localization process works

  1. The wizard begins the localization process by identifying field values and text strings used in your application RuleSet user interface rules. Text includes labels, captions, ToolTips, and instructions that appear in user-facing rules such as harness, section, flow action, list view, summary view, message, or portal. HTML text used in HTML paragraphs, correspondence and correspondence fragment rules is also identified.
  2. After a verification process, which ensures that the rules can be localized, the wizard collects and writes the strings to rows in an Excel spreadsheet. This spreadsheet serves as the translator's worksheet.
  3. The wizard creates a ZIP file called a translation package for each language you specified. The file contains the spreadsheet and other files that help the translator successfully complete the project.
  4. You send the package to a translator, who extracts the file and enters the translated text in the spreadsheet. The translator zips up the file containing the completed spreadsheet and returns it to you.
  5. You use the wizard to import the localized rules. To verify the translation results, you use Process Commander tools.

NoteThe Localization wizard is designed to efficiently and automatically identify relevant user interface rules. However, there may be rules that the wizard does not detect caused by unique application configurations. Complex applications will most likely require some manual translations.

zzzPrerequisites

Before using the Localization wizard do the following:

zzzStarting the Localization wizard

The Localization wizard provides three options:

Click the help button (Help) on any form for help about that form.

Resuming the wizard

This wizard creates a work object with prefix pxAP-. To find open and resolved wizard work objects, select the Developer portal menu option Open > Wizards in Progress > All Wizards.

zzzSteps in the wizard

These are the basic steps you perform in the wizard when you translate to a new language or verify a translated application.

Phase One: Create and export a translation package

Step 1: Select Application RuleSets — Select one or more unlocked application RuleSets and versions you want to include in the translation package. Unless you choose otherwise, the rules in these applications are verified in step 2.

Step 2: Verify Localization Is On — The wizard verifies that the rules are enabled to allow localization and can be saved during validation. It selects the Localize? option in the rule forms for sections, flow actions, harnesses, list views, and summary views if necessary.

Step 3: Manual Tasks — The wizard lists rules that require corrections or updates so that they can be localized. The wizard form provides links to the rule forms and to Help topics for tips on how to correct the issues. You make the corrections or updates as necessary.

Step 4: Select Languages — Select one or more languages to which you want to translate your application. A translation package will be exported for each of these languages.

Step 5: Check for Language Packs — Indicate whether you will acquire a Pegasystems language pack, which provide translated strings that are used in the standard Pega RuleSet user interface rules. This step appears only if you have chosen a language in Step 4 for which a Pegasystems language pack is not in your Process Commander system.

Step 6: Set Options — Indicate whether you want to include fields that have already been translated in your ZIP translation package file. Doing so allows translators to review phrases that were used earlier and help the translators maintain consistency. Also specify whether you want to include base field values from RuleSets in addition to those you selected in Step 1.

Step 7: Export Translations — The wizard creates a ZIP translation package for each language. The package includes an Excel spreadsheet containing the text strings and other files the translator will need. This step allows you to save the package to a local directory so that you can send it out for translation.

Phase Two: Import the translation package

Step 8: Import Translations — Upload and import to your system the ZIP file containing the translated fields. The Localization wizard takes you through the process in three steps:

  1. Select Import RuleSets — Select the RuleSet and version in which you want to import the new fields. You also select the RuleSet versions in which you want to import HTML paragraphs, messages, and existing field values. The wizard will create localized versions of these RuleSets if they don’t already exist.
  2. Upload Translation Pack— Select the ZIP translation package from a local directory to upload it to your server.
  3. View Import Results — The Localization wizard imports the contents of the Excel spreadsheet. The wizard form indicates the number of rules successfully imported. It also provides a list of import errors.

zzzWorking in the wizard

Creating a wizard work object: When you select the Translate to a New Language option, The Step 1: Select Application RuleSets form opens and a wizard work object with the prefix of PXAP is created.

You can also create a new wizard object when you are in the Wizards in progress list (see next topic) by clicking New, which opens the Step 1 wizard form.

Opening a wizard object that is in progress: Use the List New Translations in Progress option to display the Wizards in progress worklist. Clicking an item opens the step at which the Localization wizard exited. The list have four columns. The fourth column (last one on the right) indicates the step at which the Localization wizard exited. When you click an item with Import status, a three-step Localization wizard opens that you use to import the translated package into your system. If you exported multiple translation packages from one wizard object, each package appears as a separate Import item in the list.

Exiting the wizard — You can exit the wizard in any step by clicking zzz on the menu bar. All your entries up to that point are retained. Use the List New Translation in Progress option to reopen the wizard.

Resolving a wizard — You can withdraw and resolve a wizard item in any step by clicking Cancel.

zzzUsing the wizard in your localization project

The following work flow represent a typical implementation of the wizard in a localization project. Bear in mind that it is an iterative process. You may need to repeat steps to ensure that the RuleSets meet your site requirements.

In this example, an application was developed using RuleSet version 01-01-01. You want to create a localized version of the application.

  1. Lock 01-01-01 when complete, and then create RuleSet version 01-01-02 to be used in the wizard.
  2. Select Application > Localize > Translate to a New Language in the Localization wizard. Create a translation package using version 01-01-02.
  3. Open the package and review the version 01-01-02 spreadsheet. If there are rules you don't want translated, delete them before shipping the package. If there are text inconsistencies or errors, correct the text and create a new package.
  4. Lock the 01-01-02 package, and then send it to the translators.
  5. Create RuleSet version 01-01-03 to use for further development.
  6. When the translated package (01-01-02) is ready for import, unlock it and set it as the highest version in the import user's access group.
  7. Import the package. Test the translations using access groups that are limited to 01-01-02.
  8. Select Application > Localize > Verify Existing Translations in the wizard using RuleSet 01-01-03. This process will identify new or modified rules, and it will capture them in the Excel spreadsheet.
  9. Send the package for translation.
  10. Return to step 5 and repeat the process.

zzzLocalized rule types

Rule types that are localized include the following:

Rule Type

Field

Notes

Class (for work types)

Short Description

Visible on the portal

Flow action

Short Description

Basis of user selection of the flow action

Flow action

Harness

Section

Caption (button panel, Layout tab)

Visible on work object form

Flow action

Harness

Section

Value (Field panel,
Layout tab)

Visible on work object form

Harness

Title (Layout panel,
Layout tab)

Visible on work object form

List view

Field Label
(Display Fields tab)
Visible on report display

Summary view

Group By Caption (Content tab)

Caption and Title
(Drill Down tab)

Visible on report display

Message

Message

Localization is needed only for Rule-Message rules presented to users, such as through the Page-Set-Messages method in an activity, or a validation rule.

zzzLocalized properties

The properties listed below are included in the localization process. Some field value rules may already be defined in a language pack for the locale. You need not override the language pack rule if the value it provides in the Localized Label field is appropriate for your application and user community.

Applies To

Name

Purpose

@baseclass

pyActionPrompt

A sentence corresponding to a longer form of a pyActionLabel, as explanation that be presented as a ToolTip.

For example, the pyActionLabel with English text Add A New Party has the Localized Label value Ajoutez une nouvelle partie for the Pega-ProCom_fr language pack.

@baseclass

pyButtonLabel

Generally an imperative verb that conveys a command from the user to the application, such as appears on buttons or links to be clicked. Examples of the English forms are Save, Cancel, Submit, Next, and OK.

For example, the pyButtonLabel with English text Advanced View has the Localized Label value Affichage Avançé for the Pega-ProCom_fr language pack.

@baseclass

pyCaption

An imperative verb or verb plus object that is a request to the user. For example: Select a value, Click to close.

May also be single word noun or noun phrase, such as Amount, Received, Due, Limit. Typically used for localized versions of field labels in section rules and harness rules, and column headings in reports.

For example, the pyButtonLabel with English text Attach a File has the Localized Label value Joindre un Fichier for the Pega-ProCom_fr language pack.

@baseclass

pyInstructions

Application-specific instructions to a user regarding a human task in a flow. These may appear on a worklist. Typically these start with an imperative verb and contain no more than six words. Examples:

Verify applicant salary.

Check customer credit limit.

Confirm receipt of goods.

Review mortgage application.

@baseclass pyLabel

Short Descriptions for the work types (concrete class rules derived from Work-) in the application.

For example, the PegaSample application includes the work type PegaSample-CustomerRequest, with Short Description Customer Request. The Localized Label value of the corresponding field value rule for the Pega-ProCom_fr language pack is Demande du Client.

@baseclass pyMessageLabel

zzzYou can localize alert messages contained in JavaScripts. For examples, these field values convert messages to the user conveying errors, progress, success, or needed action. Also includes the Where-am-I? form. Examples:

Enter a value; field may not be blank.

Submitting...

Save failed. Contact your administrator.

For example, the pyMessageLabel with English text Clear the error if you believe it has been fixed has the Localized Label value Dégagez l'erreur si vous croyez qu'elle a été fixée for the Pega-ProCom_fr language pack.

@baseclass pyStatusLabel

Localized versions of work object status values, such as New, Open, Resolved.

For example, the pyStatusLabel with English text Open has the Localized Label value Ouvert for the Pega-ProCom_fr language pack.

zzzAdvanced Creating a language pack

To create your own language pack that includes standard Process Commander field values, do the following:

  1. Run the Localization wizard using the Translate to a New Language option. Use a RuleSet that does not contain any significant user interface rules that reference field values, for example, an organization RuleSet.
  2. When you reach Step 5 in the wizard, select the second option Add all PRPC field values to my application translation pack. This creates a translation package that contains an Excel spreadsheet with all the standard Process Commander field values.
  3. When the file is complete, import it to a top-level (organization) application RuleSet so that it can be shared across business applications. Field values in language-specific RuleSets Rule use normal rule resolution. Your custom language pack cannot be imported to a standard locked RuleSets such as Pega-ProCom (where Pegasystems language packs are located).
Definition Language-specific RuleSet
Locale
Related topics Internationalization and Localization — Concepts and terms
Rules Inspector tool — Localizing forms with the Field Value Inspector
About Field Value rules

zzzTools, accelerators, and wizards