Metadaten-Bezeichnungen im agorum core smart assistant übersetzen

Die Übersetzung von Metadaten-Bezeichnungen im agorum core smart assistant geschieht über Schlüsselwörter (Keys). Diese werden in Message-Property-Dateien für die jeweilige Sprache übersetzt. Pro Sprache gibt es je eine Message-Datei mit dem jeweiligen Ländercode:

• Deutsch: Messages_de.properties
• Englisch: Messages_en.properties
• Französisch: Messages_fr.properties
• usw.

Message-Dateien anlegen und ablegen

In der Regel wird pro Projekt oder Konfiguration ein Verzeichnis angelegt, das die jeweiligen Übersetzungsdateien enthält. 

Zuerst wird auf dem Server folgende Struktur angelegt, hier beispielhaft mit der Bezeichnung demotranslate_module für den Projektordner:

Dort werden nun die jeweiligen Message-Dateien, etwa Message_de.properties, abgelegt.

Inhalt der Message-Dateien

Hier werden die Schlüsselwörter (Keys) mit ihrer jeweiligen Übersetzung angegeben.

Beispiele

In der Datei „Messages_de.properties“

In der Datei „Messages_en.properties“

Übersetzungsschlüssel im agorum core smart assistant konfigurator verwenden

Im agorum core smart assistant konfigurator können Übersetzungsschlüssel anstelle des Namens verwendet werden, etwa bei folgendem:

• Anlage, Ablage, Aktionen, Listen, Suchen, Aktionsgruppen
• Im Client-JavaScript und bei Message-Boxen. Hier wird mit Translator.translate('agorum.demotranslate.TestName') gearbeitet.

Hierbei ist darauf zu achten, dass die Namen (intern) eindeutig sind.

Beispiel für Name

Beispiel für Name

Hier wird der Suche der Name _agorum.home.asa.search.Mail gegeben, wodurch dem Benutzer bei Aufruf im agorum core smart assistant die hinterlegte Übersetzung als Name angezeigt wird. Das gleiche Prinzip gilt für die Metadaten und deren angezeigter Name.

Beispiel für Client-JavaScript

Hier ein Beispiel, wie im JavaScript mit den Message-Property-Dateien gearbeitet werden kann:

Beispiel für Client-JavaScript

Übersetzungsschlüssel im agorum core metadaten designer verwenden

Metadaten können direkt mit Übersetzungsschlüsseln definiert werden. Diese werden direkt in den agorum core smart assistant konfigurator übernommen. Nach demselben Prinzip wie beim agorum core smart assistant konfigurator wird der Schüssel in Angezeigter Name – displayName in der .yml-Datei – mit _ als Präfix angegeben:

Übersetzungsschlüssel im agorum core metadaten designer verwenden

Dies gilt für Standard-Metadaten und Metadaten in Drop-down-Auswahllisten.

Wird eine CSV-Datei verwendet, werden die Schlüssel als Text (ohne _ als Präfix) in der Spalte angegeben. 

Beispiel einer .yml-Datei (Übersetzungsschlüssel ist fett markiert):

Sprachdateien über YML-Export automatisch installieren

Die Sprachdateien werden normalerweise direkt im Installationsverzeichnis von agorum core abgelegt. Soll dies über einen YML-Export geschehen, kann dies durch Anlage eines entsprechenden Ordners unter deploy/pre durchgeführt werden.

Legen Sie diese Ordnerstruktur an:

Beispiel:

Ergebnis im Explorer:

Ergebnis des Beispiels im Explorer

Die Struktur wird in der Datei export.yml folgendermaßen angegeben:

Beachten Sie, dass nach Einspielen der Konfiguration zuerst der Property-Cache geleert werden muss, damit die Sprachdateien aktiv werden. Alternativ kann auch agorum core neu gestartet werden.

Die Übersetzung prüfen

Die Übersetzungsdateien können auf Ihren enthaltenen Text geprüft werden. Dazu wird folgender Syntax verwendet:

Anstelle von xxxx tragen Sie den gewünschten Übersetzungsschlüssel ein. Dabei können Sie entweder den gesamten Namen oder nur der Anfang eintragen.

Beispiel 1

http://roihost/api/rest/translate/agorum.home.asa.menu.admin.json

Als Ergebnis werden alle Übersetzungsschlüssel, die mit agorum.home.asa.menu.admin beginnen, und deren Inhalt angezeigt:

{
  "success": true,
  "errorClass": 0,
  "errorCode": 0,
  "errorKey": 0,
  "message": "",
  "translation": {
    "agorum.home.asa.menu.admin.XmlParse": "XML Ausführen",
    "agorum.home.asa.menu.admin.infos.PrintIndexXml": "Print Index XML",
    "agorum.home.asa.menu.admin.infos.PrintDocumentText": "Print DokumentText",
    "agorum.home.asa.menu.admin.systemflags.Calc": "Systemflags - berechnen",
    "agorum.home.asa.menu.admin.Infos": "Infos",
    "agorum.home.asa.menu.admin.systemflags.Status": "Systemflags - welche sind gesetzt",
    "agorum.home.asa.menu.admin.infos.MetaDataAsJson": "Metadaten als JSON anzuzeigen",
    "agorum.home.asa.menu.admin.Folder": "Ordner",
    "agorum.home.asa.menu.admin.SystemFlags": "Systemflags",
    "agorum.home.asa.menu.admin.Export": "Export",
    "agorum.home.asa.menu.admin.systemflags.Set": "Systemflags - setzen",
    "agorum.home.asa.menu.admin.CreateMetaData": "Metadaten anlegen (YML)",
    "agorum.home.asa.menu.admin.ProfilePicture": "Benutzerbild ablegen",
    "agorum.home.asa.menu.admin.infos.PrintRawDocumentText": "Print RawDokumentText",
    "agorum.home.asa.menu.admin.GlobalMailFooter": "E-Mail - Globale Fussnote",
    "agorum.home.asa.menu.admin.folder.NewWithAreaAndIdentifier": "Neu mit area und identifier",
    "agorum.home.asa.menu.admin.JavascriptConsole": "Öffnen Javascript-Konsole",
    "agorum.home.asa.menu.admin.folder.ChangeAreaAndIdentifier": "area und identifier ändern",
    "agorum.home.asa.menu.admin.MailFooter": "E-Mail - Fussnoten"
  },
  "locale": "de"
}

Beispiel 2

http://roihost/api/rest/translate/agorum.home.asa.menu.admin.infos.MetaDataAsJson.json

Als Ergebnis werden alle Übersetzungsschlüssel, die mit agorum.home.asa.menu.admin.infos.MetaDataAsJson beginnen, und deren Inhalt angezeigt: 

{
  "success": true,
  "errorClass": 0,
  "errorCode": 0,
  "errorKey": 0,
  "message": "",
  "translation": {
    "agorum.home.asa.menu.admin.infos.MetaDataAsJson": "Metadaten als JSON anzuzeigen"
  },
  "locale": "de"
}

Die Sprache hinzufügen

Im Standard von agorum core sind folgende Sprachen enthalten:

de
Deutsch

en
Englisch

fr
Französisch

So fügen Sie weitere Sprache hinzu:

1. Öffnen Sie auf der Startseite von agorum core Administration.
2. Wählen Sie links im Menü MetaDb.
3. Öffnen Sie den Pfad:

   MAIN_MODULE_MANAGEMENT/roiwebui/control/Languages
   

4. Legen Sie über  ein neues Property-Entry an.
   
   Name
   <Kürzel der Sprache>, etwa es
   
   Datentyp
   Zeichenkette (String)
   
   Wert (String)
   <Bezeichnung der Sprache>, etwa Spanisch
5. Speichern Sie das neue Property-Entry.

Proprty-Entry für neue Sprache anlegen