...
Um den PlunetConnector in Verbindung mit Plunet korrekt nutzen zu können, müssen folgende Anforderungen erfüllt sein:
Plunet:
Die Admin-Option Erweiterte Workspace Anpassungist in Plunet aktiviert.
Das Plunet-Zusatzmodul „Plunet API“ ist aktiviert; die API ist eingerichtet.
- Es muss einen Plunet-User mit API-Rechten geben.
Mind. eine aktive CAT-Lizenz für den verwendeten Plunet-User (mit API-Nutzer Rechten) ist verfügbar.
Die konfigurierte CAT-Schnittstelle unterstützt den TradosStudioManager | Standard und dessen Analyse-Format TradosStudioManager (.xml) wird unterstützt.
Eine Konfiguration des TradosStudioManager ist angelegt, um Analyse-Werte korrekt auswerten und in Preislisten verarbeiten zu können.
Die Plunet-Instanz liegt in Version 9 vor (Der JS-Injection-Code und die Plugin-Interaktion sind getestet mit Version 9.14.9).
...
Neben diesem Plugin, welches zahlungspflichtig für translate5 aktiviert werden kann, werden für korrekte Ausführbarkeit der Verbindung noch translate5-interne Konfigurationen benötigt. Siehe dazu Kapitel Installation und Konfiguration der Anpassung in translate5.
Installation und Konfiguration
...
in Plunet
Installation
...
des JS Injection-Loaders
Um die PlunetConnector-Funktionalität in Plunet zu integrieren, muss eine JavaScript-Injection-Loader eingefügt und angewandt werden:
Entnehmen Sie den Code für die JavaScript-Injection-Loader aus dem bereitgestellten Auslieferungsarchiv.
Loggen Sie sich als Administratorbenutzer in Plunet ein.
Navigieren Sie zu Admin -> Anpassungen -> Erweiterte Workspace Anpassung.
Fügen Sie den bereitgestellten Code für die JavaScript-Injection in das Textfeld ein (2).
Sollten Sie noch weitere JavaScript-Injections in Plunet aktiv haben, kopieren Sie den bereitstellten Code einfach an das Ende des Textfeldes.Konfigurieren Sie außerdem Ihre translate5URL sowie das translate5ApiToken (1), welches für Plunet-Zugriffe verwendet werden soll (s. Konfiguration des Plugins in translate5).
Bestätigen Sie mit Eigenes Skript anpassen.
Verbleiben Sie im Menü Anpassungen und scrollen Sie zu Allowlist für externe Domains.
Fügen Sie die Basis-URL Ihrer translate5-Instanz ein (ohne abschließenden Slash („/“)) und bestätigen Sie mit
.
Konfiguration der notwendigen Elemente in Plunet
API-User
Legen Sie in Plunet einen neuen Benutzer an, welcher die notwendigen Rechte hat, um die Plunet-API nutzen zu können. Merken Sie sich Nutzername und Passwort dieses Users, da sie die Daten später in translate5 hinterlegen müssen.
Vergeben Sie innerhalb von Plunet außerdem eine CAT-Lizenz für diesen Benutzer, damit die Analyse-Daten über die API hochgeladen werden können.
Anlage und Konfiguration dieses Nutzers sowie die Aktivierung einer CAT-Lizenz sind nicht Teil dieser Anleitung. Konsultieren Sie dazu bitte Ihren Plunet-Administrator oder verfügbare Dokumentationsquellen direkt von Plunet.
Textbausteine
Das translate5 PlunetConnector-Plugin sowie die JavaScript-Injection benötigen einen spezifischen Textbaustein innerhalb von Plunet, um den Projektstatus aus translate5 abbilden und die Interaktionen im Plunet-Interface steuern zu können.
Gehen Sie folgendermaßen vor, um den benötigten Textbaustein anzulegen:
Loggen Sie sich als Administratorbenutzer in Plunet ein.
Navigieren Sie zu Admin -> Dokumentvorlagen -> Textbaustein.
Legen Sie einen Textbaustein an, der nachfolgende Kriterien erfüllt:
...
Art: Textfeld
...
Bezeichner (mind. in englischer Lokalisierung): translate5ProjectState
...
Flag: [translate5ProjectState]
...
Verbleiben Sie in der Konfigurationsmaske und aktivieren Sie den Textbaustein für die Seiten Angebot und Auftrag:
Stellen Sie sicher, dass die Option „nur lesen in“ des Textbausteins für die Seiten Angebot und Auftrag nicht aktiviert ist:
Jobs
Damit das translate5-PlunetConnector-Plugin erkennen kann, auf welche Jobaktivitäten es in Plunet reagieren soll, müssen spezielle, relevante Jobs definiert werden.
Ebenso wird ein spezifischer Job benötigt, der dem translate5-Plugin signalisiert, dass die translate5-Aufgabe abgeschlossen und die Zieldateien nach Plunet geladen werden sollen.
Gehen Sie folgendermaßen vor, um Standard-Jobs anzulegen, deren Aktivität in translate5 ausgeführt werden soll:
Loggen Sie sich als Administratorbenutzer in Plunet ein.
Navigieren Sie zu Admin -> Job.
Fügen sie einen neuen Job der Kategorie Standard hinzu.
Stellen Sie sicher, dass Sie in den verschiedensprachigen Namen des Jobs jeweils die Zeichenkette translate5 verwenden und dass das Kürzel einen für Sie aussagekräftigen Verweis auf translate5 beinhaltet.
Konfigurieren Sie optional eine Leistung für den Job.
Gehen Sie folgendermaßen vor, um einen automatischen Job anzulegen, dessen Ausführung in translate5 den notwendigen Aufgabenabschluss signalisieren soll:
Loggen Sie sich als Administratorbenutzer in Plunet ein.
Navigieren Sie zu Admin -> Job.
Fügen sie einen neuen Job der Kategorie Automatisch hinzu.
Stellen Sie sicher, dass Sie in den verschiedensprachigen Namen des Jobs jeweils die Zeichenkette translate5 verwenden und dass das Kürzel einen für Sie aussagekräftigen Verweis darauf beinhaltet, dass der Job den translate5-Aufgabenabschluss auslöst.
Konfigurieren Sie den initialen Jobstatus, den finalen Jobstatus (das Plugin wird den finalen Jobstatus stets auf „Ohne Rechnung“ setzen) sowie die Anzeige-Einstellungen des Jobs. Der initiale Jobstatus sollte vor „04 In Arbeit“ liegen, da später der Status „04 In Arbeit“ die Lieferung auslöst.
Konfigurieren Sie optional eine Leistung für den Job.
Merken Sie sich die Kürzel der Jobs, da diese später in der Konfiguration des translate5-Plugins für die Zuordnung der Jobs zu translate5-Workflow-Schritten benötigt werden.
Verwenden Sie den Aufgabenabschlussjob (im Beispiel „Finish translate5 task“) an der Stelle, an der die Aufgabe in translate5 beendet und die Zieldateien hochgeladen werden sollen. Das Plugin wird die Zieldateien aus translate5 dann in den Upload-Ordner des Jobs transferieren und die Aufgabe in translate5 final abschließen. Sie können auch nach dem Aufgabenabschlussjob weitere, nicht translate5-bezogene Workflow-Schritte in Plunet abbilden, die mit den resultierenden Zieldateien aus translate5 weiterarbeiten:
...
...
Existiert kein Aufgabenabschlussjob in der Jobkette, so prüft das PlunetConnector-Plugin bei einem Task-Abschluss eigenständig, ob noch weitere Schritte in translate5 erledigt werden müssen. Dazu ermittelt es alle für translate5 relevanten Jobs in Plunet und gleicht diese mit den vorhandenen Workflowschritten in translate5 ab. Existiert zu jedem dieser Jobs ein Workflowschritt in translate5 und sind alle Workflowschritte abgeschlossen, so wird der Projektabschluss auch in diesem Fall gestartet. Zieldateien werden dann jedoch in den Target-Ordner der Plunet-Position transferiert.
| Info |
|---|
// Plugin PlunetConnector: config // Plugin PlunetConnector: injection loader |
Konfiguration der notwendigen Elemente in Plunet
API-User
Legen Sie in Plunet einen neuen Benutzer an, welcher die notwendigen Rechte hat, um die Plunet-API nutzen zu können. Merken Sie sich Nutzername und Passwort dieses Users, da sie die Daten später in translate5 hinterlegen müssen.
Vergeben Sie innerhalb von Plunet außerdem eine CAT-Lizenz für diesen Benutzer, damit die Analyse-Daten über die API hochgeladen werden können.
Anlage und Konfiguration dieses Nutzers sowie die Aktivierung einer CAT-Lizenz sind nicht Teil dieser Anleitung. Konsultieren Sie dazu bitte Ihren Plunet-Administrator oder verfügbare Dokumentationsquellen direkt von Plunet.
Textbausteine
Das translate5 PlunetConnector-Plugin sowie die JavaScript-Injection benötigen einen spezifischen Textbaustein innerhalb von Plunet, um den Projektstatus aus translate5 abbilden und die Interaktionen im Plunet-Interface steuern zu können.
Gehen Sie folgendermaßen vor, um den benötigten Textbaustein anzulegen:
Loggen Sie sich als Administratorbenutzer in Plunet ein.
Navigieren Sie zu Admin -> Dokumentvorlagen -> Textbaustein.
Legen Sie einen Textbaustein an, der nachfolgende Kriterien erfüllt:
Art: Textfeld
Bezeichner (mind. in englischer Lokalisierung): translate5ProjectState
Flag: [translate5ProjectState]
Reihenfolge: beliebig, bspw. 1
Verbleiben Sie in der Konfigurationsmaske und aktivieren Sie den Textbaustein für die Seiten Angebot und Auftrag:
Stellen Sie sicher, dass die Option „nur lesen in“ des Textbausteins für die Seiten Angebot und Auftrag nicht aktiviert ist:
Jobs
Damit das translate5-PlunetConnector-Plugin erkennen kann, auf welche Jobaktivitäten es in Plunet reagieren soll, müssen spezielle, relevante Jobs definiert werden.
Ebenso wird ein spezifischer Job benötigt, der dem translate5-Plugin signalisiert, dass die translate5-Aufgabe abgeschlossen und die Zieldateien nach Plunet geladen werden sollen.
Gehen Sie folgendermaßen vor, um Standard-Jobs anzulegen, deren Aktivität in translate5 ausgeführt werden soll:
Loggen Sie sich als Administratorbenutzer in Plunet ein.
Navigieren Sie zu Admin -> Job.
Fügen sie einen neuen Job der Kategorie Standard hinzu.
Stellen Sie sicher, dass Sie in den verschiedensprachigen Namen des Jobs jeweils die Zeichenkette translate5 verwenden und dass das Kürzel einen für Sie aussagekräftigen Verweis auf translate5 beinhaltet.
Konfigurieren Sie optional eine Leistung für den Job.
Gehen Sie folgendermaßen vor, um einen automatischen Job anzulegen, dessen Ausführung in translate5 den notwendigen Aufgabenabschluss signalisieren soll:
Loggen Sie sich als Administratorbenutzer in Plunet ein.
Navigieren Sie zu Admin -> Job.
Fügen sie einen neuen Job der Kategorie Automatisch hinzu.
Stellen Sie sicher, dass Sie in den verschiedensprachigen Namen des Jobs jeweils die Zeichenkette translate5 verwenden und dass das Kürzel einen für Sie aussagekräftigen Verweis darauf beinhaltet, dass der Job den translate5-Aufgabenabschluss auslöst.
Konfigurieren Sie den initialen Jobstatus, den finalen Jobstatus (das Plugin wird den finalen Jobstatus stets auf „Ohne Rechnung“ setzen) sowie die Anzeige-Einstellungen des Jobs. Der initiale Jobstatus sollte vor „04 In Arbeit“ liegen, da später der Status „04 In Arbeit“ die Lieferung auslöst.
Konfigurieren Sie optional eine Leistung für den Job.
Merken Sie sich die Kürzel der Jobs, da diese später in der Konfiguration des translate5-Plugins für die Zuordnung der Jobs zu translate5-Workflow-Schritten benötigt werden.
Verwenden Sie den Aufgabenabschlussjob (im Beispiel „Finish translate5 task“) an der Stelle, an der die Aufgabe in translate5 beendet und die Zieldateien hochgeladen werden sollen. Das Plugin wird die Zieldateien aus translate5 dann in den Upload-Ordner des Jobs transferieren und die Aufgabe in translate5 final abschließen. Sie können auch nach dem Aufgabenabschlussjob weitere, nicht translate5-bezogene Workflow-Schritte in Plunet abbilden, die mit den resultierenden Zieldateien aus translate5 weiterarbeiten:
| Existiert kein Aufgabenabschlussjob in der Jobkette, so prüft das PlunetConnector-Plugin bei einem Task-Abschluss eigenständig, ob noch weitere Schritte in translate5 erledigt werden müssen. Dazu ermittelt es alle für translate5 relevanten Jobs in Plunet und gleicht diese mit den vorhandenen Workflowschritten in translate5 ab. Existiert zu jedem dieser Jobs ein Workflowschritt in translate5 und sind alle Workflowschritte abgeschlossen, so wird der Projektabschluss auch in diesem Fall gestartet. Zieldateien werden dann jedoch in den Target-Ordner der Plunet-Position transferiert. |
E-Mail-Vorlage
Das translate5-PlunetConnector-Plugin wird, wenn es in translate5 einen Benutzer anlegt, keine Registrierungsnachricht an den Nutzer versenden. Daher ist es zwingend notwendig, dass die Partner über Plunet auf eine neue Aufgabe in translate5 hingewiesen werden. Dazu sollten die Job-E-Mail-Templates dahingehend angepasst werden, dass Sie dem Nutzer bei translate5-Jobs direkt die URL des translate5-Systems, sowie Instruktionen zum erstmaligen Login bereitstellen.
Installation des Plugins in translate5
Das PlunetConnector-Plugin wird nicht standardmäßg als Public Plugin mit translate5 ausgeliefert, sondern ist ein sogenanntes Private Plugin. Gehen Sie daher wie folgt vor, um das Plugin in translate5 zu installieren und zu aktivieren. Die nachfolgenden Schritte müssen in einer Kommandozeile ausgeführt werden, mit der Sie sich bereits mit Ihrer translate5 Instanz verbunden haben:
Kopieren Sie den Plugin-Ordner PlunetConnector aus dem Auslieferungsarchiv in den Pfad application/modules/editor/PrivatePlugins Ihrer translate5-Instanz.
Erstellen Sie den Ordner PrivatePlugins, sollte er unter dem angegebenen Pfad noch nicht existieren.Navigieren Sie nun in das Verzeichnis application/modules/editor/Plugins
Erzeugen Sie in diesem Verzeichnis eine Verknüpfung, die auf den Ordner PlunetConnector im PrivatePlugins-Verzeichnis verweist. So kann translate5 das Plugin erkennen, obwohl es im privaten Ordner abgelegt ist.
Unter Linux können Sie nachfolgenden Befehl verwenden, um aus dem Plugins-Verzeichnis eine Verknüpfung in das PrivatePlugins-Verzeichnis zu erstellen:
ln -rs ../PrivatePlugins/PlunetConnectorNavigieren Sie zurück in das Installationsverzeichnis von translate5.
Das Plugin integriert eigene Datenbankmigrationen, die zur Installation ausgeführt werden müssen.
Linux-Kommando: ./translate5.sh database:update
Windows-Kommando: translate5.bat database:update
Das Skript wird ihnen eine Auswahl an erkannten, noch nicht migrierten Datenbankmigrationsdateien anzeigen und Sie bitten zu bestätigen, dass diese migriert werden sollen.
Bestätigen Sie mit Yes, sodass das Skript die notwendigen Migrationen ausführt.Aktivieren Sie das Plugin.
Linux-Kommando: ./translate5.sh plugin:enable PlunetConnector
Windows-Kommando: translate5.bat plugin:enable PlunetConnector
Der Dialog wird Ihnen die erfolgreiche Aktivierung bestätigen.Öffnen Sie die translate5-Anwendung nun im Webbrowser und loggen Sie sich mit einem Administratorbenutzer ein.
Navigieren Sie in das Menü Einstellungen -> Systemkonfiguration und stellen Sie sicher, dass die Plugin-spezifischen Einstellungsmöglichkeiten unter dem Stichwort PlunetConnector vorhanden sind.
Für Zugriffe, die aus Plunet heraus gestartet werden, wird außerdem noch ein API-Token benötigt.
Loggen Sie sich als Administrator-User in translate5 ein.
Navigieren Sie in das Menü Benutzer und klicken Sie auf Benutzer hinzufügen, um einen neuen Benutzer anzulegen, welcher für den Zugriff aus Plunet verwendet werden soll. Achten Sie dabei darauf, dem User mindestens die Systemrolle „API“ zu konfigurieren.
Navigieren Sie nun zu Einstellungen -> APP Tokens.
Klicken Sie auf Hinzufügen, um den Token-Erstellen-Dialog zu öffnen.
Geben Sie eine Beschreibung (1) ein, wählen Sie den Benutzernamen des zuvor angelegten Benutzers aus (2) und konfigurieren Sie optional ein Verfallsdatum (3) (Hinweis: Sollten Sie ein Verfallsdatum definieren, müssen Sie das Token regelmäßig in translate5 erneuern und auch in Plunet aktualisieren).
Sichern Sie das nachfolgend angezeigte APP-Token für die Konfiguration in translate5
E-Mail-Vorlage
...
.
Konfiguration des Plugins in translate5
...
Damit das Plugin mit Plunet kommunizieren und die Informationen korrekt auswerten kann, werden einige Einstellungen auf Systemebene benötigt:
benötigt:
| Bitte stellen Sie sicher, dass Sie URLs immer ohne den schließenden / (Slash) konfigurieren, da die Konfiguration sonst ungültig wird. |
Name der Config | Hinweise zur Konfiguration |
|---|---|
Fallback Customer ID | Gebe Sie hier auf Instanz-Ebene den translate5-Kunden an, dem diejenigen Projekte aus Plunet zugewiesen werden, für die keine Zuordnung Plunet-translate5-Kunde auf Kundenebene erfolgt ist. Erstellen Sie z. B. einen Kunden "Leere TMs" mit leeren Translation Memories, den Sie für Neukundenanfragen verwenden. |
| Bitte stellen Sie sicher, dass Sie URLs immer ohne den schließenden / (Slash) konfigurieren, da die Konfiguration sonst ungültig wird. |
Name der Eigenschaft | Hinweise zur Konfiguration |
Finish translate5 task job name | Spezifizieren Sie hier das Kürzel des Jobs, der den translate5-Aufgabenabschluss auslöst. |
Job to WorkflowStep mapping | Spezifizieren Sie hier, wie Plunet-Jobs (durch Ihr Plunet Kürzel dargestellt) in translate5 als Workflow-Schritte (durch den gesamten Namen spezifiert) abgebildet werden soll. Die verfügbaren Workflow-Schritte hängen vom eingestellten Workflow ab. Die genauen Bezeichnungen der Schritte entnehmen Sie bitte Ihrer translate5 Datenbank oder kontaktieren hierzu ihren translate5 Administrator.translate5 Datenbank oder kontaktieren hierzu ihren translate5 Administrator. Z. B. für die Schritte des Standardworkflows in translate5 "Übersetzung" und "Lektorat" wie folgt:
Hinweis: Der Wert dieser Konfiguration ist ein JSON-Objekt. Bitte achten Sie darauf, dass Sie die vorgegebene Struktur korrekt einhalten. |
Language Mapping | Spezifizieren Sie hier, welche Projektsprache aus Plunet welcher Projektsprache in translate5 entspricht. Plunet-Sprachen werden mit ihrem vollen Namen in englischer Lokalisierung angegeben, während translate5-Sprachen anhand ihrer RFC-5646-Codes genannt werden. Diese Eigenschaft ist schon von Werk her vorausgefüllt. Da die Sprachen in Plunet allerdings frei konfigurierbar sind, sollten Sie sicherstellen, dass tatsächlich alle relevanten Zuordnungen enthalten und korrekt sind. Hinweis: Der Wert dieser Konfiguration ist ein JSON-Objekt. Bitte achten Sie darauf, dass Sie die vorgegebene Struktur korrekt einhalten. |
Plunet API Password | Passwort des API-Users aus Plunet |
Plunet API Username | Benutzername des API-Users aus Plunet. |
Plunet Customer IDStandard-Einstellung für | Hier sollte ausschließlich auf Kundenebene beim zu verwendenden trasnlate5-Kunden die Plunet - Customer -ID. Wenn keine passende Plunet Customer ID auf translate5-Kundenebene gefunden wird, , um einen translate5-Kunden mit dem korrekten Plunet-Kunden zu verbindenID des zu verknüpfenden Plunetkunden eingegeben werden. |
Plunet URL | URL Ihres Plunet-Systems. Bitte beachten Sie die oben aufgeführten Hinweise zur Konfiguration von URLs. |
SOAP Callback Authentication Token | Für die Callbacks aus Plunet ist es notwendig, eine gesonderte Absicherung zu erzeugen. Erstellen Sie eine sichere Passphrase, welche als Authentifizierungsmerkmal für die Callbacks in Plunet registriert wird und tragen Sie sie hier ein. Wenden Sie sich bei Fragen bitte an Ihren translate5 Administrator. |
translate5 API Token | Tragen Sie hier das APP Token für translate5 ein, dass das sie zuvor für den neu angelegten translate5-Benutzer erzeugt haben. |
Workflow Name | Konfigurieren Sie hier den in translate5 zu verwendenden Workflow. Bitte beachten Sie, dass diese Auswahl Auswirkungen auf die verfügbaren Workflow-Schritte hat und bei einer Änderung auch die Eigenschaft Job to WorkflowStep mapping passend aktualisiert werden muss. |
...
Wenn Sie das erste Mal in dieser Plunet-Session auf den Button klicken, werden Sie aufgefordert, Ihren Login für translate5 anzugeben. Dieser User muss mindestens Projektmanager sein und wird dann auch als PM für das Projekt in translate5 verwendet.
...