Skip to main content
Lesson 12

Localizing Reports

Back to S150: Report Designer

Lesson 12: Localizing Reports

In this lesson, you will learn about report localization.

Report Localization: General Information

Acumatica ERP provides built-in localization functionality. In the Acumatica Report Designer, you can localize any report, so that a user can run this report and view the resulting report in the language they selected when signing in to Acumatica ERP.

Learning Objectives

In this chapter, you will learn how to localize a report in the Report Designer.

Applicable Scenarios

You may want to learn about report localization in the following circumstances:

  • You are responsible for the customization of Acumatica ERP in your company, including developing and modifying reports to give users the information they need to do their jobs.
  • You need to provide reports in different languages.

The Objects of Localization

To localize a report, you have to provide translations for its source strings, which include form names, element labels, parameters, predefined values of parameters, and constant strings of variables and formulas. On the Translation Dictionaries (SM200540) form, you can collect, filter, and then translate any strings of Acumatica ERP forms, including reports, whether they are predefined reports or those designed by using the Report Designer. The value of the Behavior > Localizable property, which can be specified in the Report Designer for a report, determines the multiple language support of the report. You can specify this property for the whole report, as well as for each element, such as a text box. The default value of this property is True, indicating that multiple languages are supported for report elements.

Process of Report Localization

To localize a report into a language, you perform the following general steps on the Translation Dictionaries (SM200540) form:

  1. You collect the report strings to be translated.
  2. You select the language or languages to which you want to localize your report.
  3. In the collection of strings, you find the strings related to the report and type your translation.
  4. You save your translation.
    You can also collect strings on the Translation Sets (SM211500) form, as described in the next section.
           To localize any resources of Acumatica ERP, make sure that the languages to which resources will be
           localized are activated on the System Locales (SM200550) form.
    

Lesson 12: Localizing Reports | 116

Collection of Strings for Translation

When you localize the system for the first time, or aer you update or publish any report that you want to be
localized, you should collect the strings to be translated. In Acumatica ERP, all the strings are considered to be
either bound or unbound. Bound strings are strings associated with system resources bound to forms, such as
table names. Unbound strings are strings associated with unbound resources—resources, such as prompts, that are
not bound to forms. Any reports are also considered to be unbound resources. You can collect particular unbound
resources used in reports.
You can collect the report strings for translation in one of the following ways:
  • On the Translation Dictionaries (SM200540) form: You click Collect Strings on the form toolbar to collect all the strings used in the system, including the report strings. This operation can be time-consuming.
  • On the Translation Sets (SM211500) form: You create a translation set with the following options selected in the Unbound Resources To Collect box:
  • Chart Name
  • Constant in Formula
  • Prompt
  • Text Box Value
  • Valid Value You select these types of elements because reports include only elements of these types. Then you save the translation set and click Collect on the form toolbar to collect all the strings of the translation set. This operation may also take a significant amount of time, but less time than the collection of strings on the Translation Dictionaries form.

Report Localization: To Localize a Report

In the following activity, you will learn how to localize a report.

           This activity is based on the U100 dataset. If you are using another dataset, or if any system settings
           have been changed in U100, these changes can affect the workflow of the activity and the results of
           the processing. To avoid any issues, restore the U100 dataset to its initial state.

Story

Suppose that you are a technical specialist in your company who is working on simple customizations. A sales
manager of your company has requested that you localize the predefined Vendor Summary (AP655000) report to
the Italian language. You will localize a copy of the predefined report, starting with a test of the capability in which
you localize the report header and table header.

Process Overview

In the Report Designer, you will open the AP6550C5.RPX report, which is a copy of the Vendor Summary (AP655000)
report, and make sure that it can be localized. On the System Locales (SM200550) form, you will add the Italian
language. On the Translation Dictionaries (SM200540) form, you will collect strings, select the language, and type a
translation for the strings related to the needed report. To experiment with the capability, as a translation, you will
use the same strings as the original ones with $$ as a prefix and suffix. You will localize the report header and the
table header in the report.

Lesson 12: Localizing Reports | 117

System Preparation

Before you begin performing the steps of this activity, launch the Acumatica ERP website with the U100 dataset preloaded, and sign in as a system administrator Kimberly Gibbs by using the gibbs username and the 123 password. Also, to prepare for use the file that is intended for this activity, do the following:

  1. Download the AP6550C5.rpx file.
  2. Open the downloaded file in the Report Designer.
  3. On the Report Designer menu bar, select File > Save To Server, which opens the Save Report on Server dialog box.
  4. In the dialog box, specify the connection string and sign-in credentials of your Acumatica ERP instance, type AP6550C5 as the report name, and click OK. The report is saved on the server.

Step 1: Localizing the Report To localize the report, do the following:

  1. In the Report Designer, make sure that the AP6550C5 report (which you have saved to the server) is open.
  2. In the top le corner of the Design pane, click the icon to select the report, and make sure that the Behavior > Localizable property of the Properties tab is set to True (which is the default value).
  3. In Acumatica ERP, open the System Locales (SM200550) form.
  4. Add a new row, and specify the following settings in the added row: a. Locale Name: it-IT b. Locale Name in Locale Language: Italiano c. Description: Italian d. Sequence: 2 e. Active: Selected
  5. On the form toolbar, click Save.
  6. In Acumatica ERP, open the Translation Dictionaries (SM200540) form, and on the form toolbar, click Collect Strings. The process can be time-consuming. In the upper-right corner of the form, a notification should appear indicating successful processing.
  7. In the Language box, select Italiano.
                   You can select two or more languages if you want to translate the report into multiple
                   languages simultaneously.
    
  8. Select the Show Only Unbound check box. Based on this selection, all unbound strings, including report strings, will be shown on the Collected tab of the form.
                   Because you decided to translate only the report heading and column headers that are
                   TextBox elements, in the Unbound Resources To Display box, you can select Text Box Value.
    

Lesson 12: Localizing Reports | 118 9. On the Collected tab, in the lookup box below Default Values, type the string you are looking for to find the particular string of your report (which is initially Vendor Summary).

                  To view already localized strings, select the Show Localized check box.


   10.In the Source Value column of the Default Values table, click the string that exactly matches the string in
      the AP6550C5 report. To look for a string in a long list, use the arrow buttons below Default Values.
      In the Key column of the Key-Specific Values table, all elements that use the string are listed.

                  When you look for the string in the Default Values table, make sure that in the Key-Specific
                  Values table, the Key value is AP6550C5.rpx textBox11.Value. You need to look for this value
                  because in the Report Designer, the Vendor Summary string is the value of the Appearance
                  > Value property of the text box element with the textBox11 value of the Design > (Name)
                  property.

   11.In the Italiano column of the Default Values table, type your translation—that is, $$Vendor Summary$$.
   12.On the form toolbar, click Save.
   13.Repeat the four previous instructions to find and translate the strings from the first column of the following
      table.
      For each of the strings in the first column, in the Key-Specific Values table, the Key value is a concatenation
      of the AP6550C5.rpx prefix and the corresponding string from the second column of the following table.

       The Appearance > Value property of the text box         The Design > (Name) property of the text box
       Vendor                                                  textBox35

       Vendor Name                                             textBox39

       Status                                                  textBox30

       Class                                                   textBox37

       Terms                                                   textBox34

       Vendor Currency                                         textBox32

       Tax Zone                                                textBox33

       Phone                                                   textBox38

       FAX                                                     textBox36

       Current Balance                                         textBox27

       Balance Currency                                        textBox4

Step 2: Viewing the Report To view the report, do the following:

  1. In Acumatica ERP, open the S150 Vendor Summary (AP6550C5) report form by searching for its identifier. Lesson 12: Localizing Reports | 119
               This report, which you have modified in this activity, has been published in the U100 dataset.
               That is, it has been added to the Site Map (SM200520) form, and you can access it in Acumatica
               ERP.
    
  2. In the Locale box of the Selection area, select Italian.
  3. On the report form toolbar, click Run Report.

The following screenshot displays the localized report. Make sure that the report heading and each column header has $$ as a prefix and a suffix.

Figure: The localized AP6550C5 report