Manage workbook localization

Localization allows workbook editors to translate workbook text to other locales. Translations are created at the individual workbook level and can be applied to workbook previews and embed views.

This article explains how to create and manage workbook translations.

User requirements

To manage workbook translations, you must be granted Can edit workbook permission.

📘

Any user with a workbook preview or embed view URL and a valid locale definition can view a translated workbook.

Supported languages and locales

Sigma supports the following languages and locales:

Create a workbook translation

Translations are managed via the MANAGE LOCALES panel, accessible from your workbook’s  settings menu.

1. Open the workbook.
2. Click the gear icon (), located in the workbook’s left sidebar, to open your workbook’s settings panel.
3. Click Manage locales.
   
   This will open the MANAGE LOCALES panel.
4. To add a new language, click the panel’s plus icon (+).
   
5. Select a locale from the popup menu.
   Note: This selection determines translation of all standard Sigma text (e.g. menu labels, modal text, etc). It does not translate custom text.
   
6. [optional] Click the eye icon () to open a workbook preview using the translation.
7. To begin adding your own translations, click the locale’s download icon.
   This will download a .json file containing all custom text contained in the workbook.
   
8. Open the downloaded file.
9. The .json file contains a list of key-value pairs.
   Update the “values” to the appropriate translations.
   Important: Do not edit any of the “keys”.
   
   **Important:
   - Markdown is used for rich text
   - Dynamic text is represented like this → [={formula-id}]
   **
10. After editing and saving your file, return to Sigma.
11. Click your locale’s upload icon, and select your updated .json file.
    

Now what?

• Click the eye icon () to open a workbook preview with translated text.

• Add the locale to a workbook preview or embed URL, to view it in its translated state. See how

• Important: Each time you publish text changes to your workbook, you should download and re-upload the locale’s .json file with any new translations.

• Existing text and translations will persist when the file is downloaded.

• Removed text will automatically be removed from the downloaded file, along with its translation.

• New text will be added at the bottom of the file, awaiting translation.

Apply an existing translation to an embed or preview

To apply a translation to an embed or preview, append the embed or workbook preview URL with :lng=<your-locale>, or add the following parameter to the embed API code:

// NOTE: Localization values are case ensitive
searchParams += '&:lng=<your-locale>';

Example embed URL:

<https://app.sigmacomputing.com/my-company/workbook/My-Workbook-2PG8oM9uFxNLyzxAukJfBrL?:embed=true&:lng=fr-ca

Example embed API code:

searchParams += '&:lng=fr-ca';

Current limitations

• Auto-generated data element names are not included in the Sigma generated .json file. Please manually name all data elements prior to defining your custom text translations.
• Some components and labels do not support translations yet.
• Explore mode is not yet supported.
• Number and date formats are not supported.