Translating diagrams

Note

This feature is available in the Enterprise Edition.

You can model your diagrams in multiple languages. This allows viewers and modelers who do not understand your standard diagram language to collaborate with you.

Multilingualism is a feature which is available in the Editor, Collaboration Hub and in the Dictionary. You need to to configure languages in the Explorer to use this feature.

The following explains how to translate a diagram and the modeling elements. Note that you need to have already defined your desired language in the Explorer.

Changing the language

When creating a new diagram, it will be displayed in the default language of the workspace. To change the default language, read the Customizing the workspace chapter.

The current language of a diagram can be switched in the Editor via the little flag symbol on the right side of the upper toolbar:

The language is switched from English to German.

The language is switched from English to German.

Hint

If the flag symbol is not visible for you, it is possible that there are no languages defined for your workspace. As a workspace administrator, you can define a set of available languages in the Explorer’s configuration dialog, which is described in the chapter Customizing the workspace.

Select one of the available languages. The diagram will adapt to the language immediately and may look like the following:

The highlighted elements have not been translated into English, yet.

The highlighted elements have not been translated into English, yet.

Diagram elements that were already translated are displayed will be displayed normally. In our example, the task ‘Problem lösen’ was already translated. If the label was formatted, this formatting will be kept.

Diagram elements that are not yet translated are highlighted in red–in this example, the incoming message event ‘Received Invoice’ is only available in English (thus, the “en_us” in brackets).

The following chapter describes how diagram elements can be translated.

Translating diagrams

Translating diagrams means defining a translation for each diagram element in each required language, which can include all element labels and documentation.

This chapter describes how diagrams can be translated into other languages. This is especially useful when multiple people are involved on the translation, each translated into one language. Later in this chapter, you will learn how to translate a diagram in different languages at the same time.

The following example shows a translation from English to German:

  1. First, select which language you want to translate. Proceed as explained above. Elements that were not yet translated are highlighted in red.
  2. Double-click an element to define its label.
Translate element labels manually.
  1. Click somewhere on the canvas to accept the new label. The translation will now be stored in the attribute panel on the right.
Name and description can be defined in multiple languages.
  1. In the attribute panel, you can also add documentation in the current language.

Translate the remaining diagram elements in the same way. After saving the diagram, it will be accessible in all languages of the workspace.

Translating diagrams into multiple languages at the same time

Sometimes, a modeler might want to define a diagram in multiple languages while modeling the diagram. In this case, it is recommended to have the required languages set available while modeling.

  1. Add languages to the diagram via the language tool of the Editor toolbar.
Add a language to the diagram.
  1. Select all the languages you want to work with in your diagram. They will appear in the attribute panel on the right hand side.
This diagram is available in English, German and French. Currently, it is displayed in German.
  1. Now you translate diagram elements into the desired languages simultaneously in the attribute panel by simply entering the translations into the corresponding columns and lines.
  2. To view the result in the other languages, switch the display language on the flag icon in the toolbar.

Migrating diagrams to a different language

You can migrate the contents of a digram from one language to another. This is especially helpful when switching between dialects of a specific language (for example, British English to American/Canadian English). or if the diagram was created in the wrong language and you want to correct this.

Hint

When opening a diagram, the system will ask you for the diagram language if no default is defined.

To migrate a diagram into another language, proceed as follows:

  1. Click the flag symbol, then Migrate diagram to a different language in the top toolbar on the right. The corresponding dialog box opens.
the menu entry to migrate the diagram to a different language
  1. Now choose the source and the target language for the migration. You can choose between all languages that are defined for the workspace.
A diagram will be migrated from German to English.
  1. Optionally, you can delete information in the source language. Activate the checkbox Delete original texts to do so.
  2. Click OK. A confirmation prompt is displayed.
Security check when deleting contents in the initial language.
  1. Click Yes to confirm.

In this example a diagram was created without language definitions. The content was defined in German. As the workspaces’ default language is English, the diagram was configured to be in English when the language tools were activated. The content is now supposed to be migrated from German to English and the German contents are supposed to be removed.

Translating diagram, folder and file names

Important

Please keep in mind that translations that you make within the framework of this feature are only visible in Collaboration Hub.

  1. Select the the name of a diagram, folder or file name you want to translate in the Explorer.
  2. Open the Edit menu and click Change name/description (for files and folders) or Rename (for diagrams).
Editing options in the Explorer.
  1. Now you can add translations of the name in all available languages.
The 'Rename' dialog.
  1. Click Change name/description respectively Rename to save your settings.