Localization Coordinator

The Localization Manager can use the localization tasks to localize their deployment. In each release, the lang database tables are empty when shipped, so if you have previously translated strings in your lang database tables (that is, lang_files, lang_strings, lang_enum,and lang_glossary table), and maintain your translations with those tables, you should port the data over, so that you are not working from scratch.

Out-of-the-box Localized Archibus

Without customization, Archibus can appear in these languages if your locale is set to these languages:

  • French

  • Italian

  • German

  • Spanish

  • Dutch

  • Chinese

  • Japanese

The interface of Web Central, OnSite, Archibus mobile apps, Workplace, Smart Client, and the Smart Client Extensions will appear in the corresponding language.

Additionally, if you set the French, Italian, German, or Spanish locale , you will receive a translated version of Archibus Help .

For information on setting the locale, see Setting the Language and Locale.

Note : You do not need to rebuild databases to change the encoding (for example, MS SQL for DBCS), as Archibus already ships databases with the correct encoding.

Note: If you are managing both single-byte (for example, French or Spanish) and double-byte (for example Chinese or Japanese) languages, you need to use a Sybase database. This is because Microsoft SQL CHAR and VARCHAR datatypes do not support both single-byte and double-byte character sets in the same database. Additionally, you cannot use Oracle because it has other limitations that are not supported by the Localization Kit functionality. Sybase documentation was removed from online help beginning with V.2023.02, but you can access it in the archived V.2023.01 System Management Help .

Note:
- The Localization features support translating Web Central V18.1 and higher.
- The Localization features do not translate the online help. The Archibus Help is composed of standard HTML files that can be modified or translated directly as needed.

Localization Tools

For languages not listed above, you use the Archibus Localization Kit, described in these topics, to translate the Archibus user interface.

To localize your deployment using the database shipped for your server:

  1. Import the translatable strings. See Translate the Standard Applications and Core into a New Language .
  2. Write the translatable tables and files. See Translate the Standard Applications and Core into a New Language .
  3. Repeat the process for any other database (e.g. Oracle.)

The Localization features enable you to translate these components:

Component Help Topic
Web Central application or module

Translate a New Application

Mobile app Localize Mobile Apps
Archibus Smart Client programs Localize the Smart Client Programs
Workplace Localize Workplace
OnSite

Localize OnSite

Outlook Plugin Localize Outlook Plugin
Any extensions that you have made to Archibus Creating Language Files for Personalized Extensions

The localization features include these steps:

Task See these Help Topics

Set Up

  • Add the language to the \WEB-INF\config\context\compatibility\afm-config.xml file and to the Languages table. This is the first step in translating.

  • Configure the Database for Double-Byte Languages

Editing the Languages Table

Configure a Microsoft SQL Database for Double-byte Languages

Greek test your new applications and extensions to correct problems before the localization process begins

Greek Testing a New Application or Extension
Create a glossary of unique terms to be translated to jump start new translations

The Glossary Process

How to Use the Glossary Process

Translate new views that you have created using the View Definition Wizard Translating New Views Created Using the View Definition Wizard
Generate comparison reports to compare language or glossary files from different databases. Some of the localization tables include the Data Transfer Status field that tells you the effect of an import on each record

Comparing Language or Glossary Files from Different Databases

About the Data Transfer Field.

Support Policy

The Localization features are found on the System / Localization Manager section of the Navigator.

This application includes the same localization features that are used for translating the Archibus software into both single-byte and double-byte languages. It is provided free-of-charge as an unsupported tool.

If you need support for a localization project, please contact your Archibus Business Partner or Archibus Professional Services, who can draw up a Statement of Work for that project.

Localized Strings for Web Central

Archibus Web Central produces translated interfaces on the fly using strings stored in the following locations:

  • Adding Languages and Locales to the afm-config.xml File

    • Component Description Help Topic
    Project Database Has a series of translatable tables and fields that contain localized versions of the English strings, such as visible titles, summary descriptions, and visible enumeration values. Translatable Tables in the Project Database
    Application Language (.lang) files The \schema\ab-system\lang folder holds a series of XML files that holds translations for each supported language (such as, schema-fr.lang, schema-es.lang).If you create your own application, you have the option of adding your own translated strings to one or more of these .lang files, or to create a new .lang file that holds your own localized strings. If you add a .lang file, it should reside in this same subfolder. Application Tables
    Core language (.lang) files The \schema\ab-system\lang folder also holds a series of XML files for the Core program (for example, core-fr.lang, core-es.lang). It is inadvisable to change these core files, but if you translate a new language you will need to produce a new core.lang file for that language. You produce this file by running the Read and Write Translatable Files task and selecting to write files. Read and Write Translatable FIles
    Core Control language (.lang) files The \schema\ab-core\controls\lang folder holds a series of JavaScript (.js) files (for example, ui-controls-lang-fr.js, ui-controls-lang-es.js) that provides the translated strings for the core client-side JavaScript controls. The grid control and timeline controls are examples of this. You do not need to changes these files, but if you are translating a new language, you must produce a new core control .js file for that language. You produce this file by running the Read and Write Translatable Files task and selecting to write files. See Read and Write Translatable FIles.
    Supported Locales and Languages in afm-config.xml
    • <locales/> list: The list of locales the program supports (for example, fr_FR, es_ES, en_GB, en_US, en_CA) is in the <locales/> list located in the \WEB-INF\config\context\compatibility\afm-config.xml file. Archibus uses the ISO two-letter locale names that are the same as used in the Java standard. You can extend this list as needed.
    • <languages/> list : The list of languages that the program is configured to present is also in the afm-config.xml file in the <languages/> list. You can extend this list as needed. The <languages/> list also provides the Archibus program the list of database extensions (dbExtensions) and Help extensions (helpExtensions) values (for example, "fr, "es, "de"). These are the values that Archibus appends to database fields and to help subfolders to find the translated versions of field values and Help topics.

    See Also

    Set Up

    Setting the Language and Locale

    Configure a Microsoft SQL Database for Double-byte Languages

    Concepts

    Localization Process

    Glossary Process

    Localization Tables

    Translatable Tables in the Project Database

    About the Data Transfer Status Field

    Translated Archibus Help (User Help)

    General Procedures

    Translating New Views

    Creating Language Files for Personalized Extensions

    Greek Testing a New Application or Extension

    Comparing Language or Glossaries Files from Different Databases

    Using the Glossary Process

    Localizing Components of Archibus

    New Applications

    Mobile Apps

    Smart Client Programs

    OnSite

    Workplace

    Outlook Plugin

    Navigator Tasks

    Reading or Writing Translatable Tables

    Reading or Writing Translatable Files

    Importing Localization Extract Files

    Exporting Localization Extract Files

    Exporting or Importing Glossary Extract Files

    Greek All Localization Tables

    Delete Contents of All Localization Tables

    Editing the Languages Table

    Editing the Language Enum Table

    Editing the Language Strings Table

    Editing the Language Files Table