Configuring System Text and XLIFF for Reports

When a report administrator edits the RTF report template, rather than hard-coding the text for field labels and column headings, keys to items of System Text are used The keys are substituted with translations appropriate to the user when the report runs. The process for locating the appropriate system text keys, and creating those that do not exist is as follows:

  • A separate area of system text is provided specifically for use in reports, with a prefix of orseReports.

  • Whenever the Supplier Evaluation System Text is updated, a new XLIFF file containing the translations of fixed text used in reports is automatically generated (a separate file for each of the portal's supported languages).

  • The XLIFF file is downloadable from the System Text Admin area (by system administrators) and from the Reporting Admin area (by report administrators). The file contains the existing system text used in reports.

  • The report designer refers to the XLIFF file to locate the appropriate system text key and uses that rather than fixed text in the RTF template. The XLIFF file can be viewed using a text editor, such as Notepad++. The system text keys are located by simply searching for the relevant text.

    An example of a simple XLIFF file, where the source element is field label and the target element is the system text is as follows:

    <xliff version='1.0'>
<file source-language='en-GB' target-language='en-GB' datatype='biprtf'>
   <header/>
   <body>
     <trans-unit id="orseReports.activeIngredients">
       <source>orseReports.activeIngredients</source>
       <target>ACTIVE INGREDIENTS:</target>
     </trans-unit>
     <trans-unit id="orseReports.additionalConsumerInformation">
        <source>orseReports.additionalConsumerInformation</source>
        <target>ADDITIONAL CONSUMER INFORMATION:</target>
     </trans-unit>
  </body></file></xliff>

  • If a label or piece of text to appear in the report cannot be found in the XLIFF, it must be added to the System Text area for Reports in the Admin area. This can be done by a user with the System Text Administrator authority profile. When the system text is updated, new XLIFF files are automatically generated.

  • See Configuring System Text in RTF Report Templates for further details, including dealing with multiple occurrences of a system text label within a report, where a separate system text key is required for each occurrence.

  • When the template is complete and the report is run, the system combines the XLIFF and RTF files to derive the translations for the required language.