Konfiguration
Erstellung bzw. Anpassung der crossTerm Web-Konfigurationsdatei
Die grundlegende Konfiguration des crossTerm Web-Vorschlagsmoduls kann wahlweise durch manuelle Anpassung der crossTerm Web-Konfigurationsdatei presets.xml erfolgen oder – auf einfachere Weise – über das PresetTool, das Konfigurationstool von crossTerm Web.
Die nachfolgenden Ausführungen erläutern die Konfiguration des Vorschlagsmoduls durch manuelle Anpassung der crossTerm Web-Konfigurationsdatei presets.xml.
Bitte wenden Sie sich für weitere Informationen an Ihren Ansprechpartner bei der Across Systems GmbH.
Generelle Informationen zu Across-Dienstleistungen erhalten Sie unter www.across.net/dienstleistungen.
Innerhalb der crossTerm Web-Konfigurationsdatei Presets.xml definiert das Element suggestionConfig über die dazugehörigen Attribute und Attributwerte die Funktionsweise des Vorschlagsmoduls.
Sie erstellen eine crossTerm Web-Konfigurationsdatei z. B., indem Sie – beispielsweise mit einem Texteditor – eine *.txt-Datei erstellen und den Namen der Datei anschließend in Presets.xml ändern. Vergewissern Sie sich daraufhin, dass die Datei tatsächlich die Endung *.xml und nicht mehr *.txt hat. Anschließend können Sie z. B. die Inhalte der Konfigurationsdatei aus der nachfolgenden Beschreibung in die von Ihnen angelegte Konfigurationsdatei kopieren und die Inhalte Ihren individuellen Bedürfnissen anpassen.
Wenn Sie bereits über eine crossTerm Web-Konfigurationsdatei verfügen, müssen Sie lediglich das Element suggestionConfig in Ihre bestehende Datei Presets.xml einfügen.
Eine Konfigurationsdatei Presets.xml kann beispielsweise die folgende Struktur aufweisen:
<webconfig><presetname="default"><suggestionConfigenabled="1"termLanguage="1033"instanceName="Default Across-Server"entryTemplateName="Suggest"termTemplateName="Suggest"layoutName="Suggest"workflowName="Suggest"suggestionButtonView="icon"maxSuggestedTerms="0"anonymousLoginRedirection="1"/></preset></webconfig>
Das Element suggestionConfig enthält standardmäßig die folgenden Attribute:
Attribut | Beschreibung |
enabled | Aktiviert bzw. deaktiviert das crossTerm Web-Vorschlagsmodul. Mögliche Werte: „1“ = aktiviert, „0“ = deaktiviert |
termLanguage | LCID der Sprache, in der Termvorschläge gemacht werden können. Tipp Termvorschläge können pro Preset nur in einer Sprache gemacht werden. Es ist somit nicht möglich, innerhalb des gleichen Presets mehrere Sprachen bzw. LCIDs zu definieren. |
instanceName | Name der crossTerm-Instanz, zu der die Termvorschläge hinzugefügt werden. Es sollte sich hierbei um die Instanz handeln, in der die Vorschläge später als „echte“ Terme enthalten sein sollen. Tipp Termvorschläge können pro Preset nur in einer Sprache gemacht werden. Es ist somit nicht möglich, innerhalb des gleichen Presets mehrere Sprachen bzw. LCIDs zu definieren. |
entryTemplateName termTemplateName | Name der Eintrags- bzw. Termvorlage, die für die Erstellung von Termvorschlägen verwendet wird. Die in den Vorlagen definierten Datenkategorien stehen dem crossTerm Web-Benutzer für die Erstellung von Term-Vorlagen zur Verfügung. |
layoutName | Name des crossTerm-Layouts, das dazu genutzt wird, um dem crossTerm Web-Benutzer seinen vorgeschlagenen Term nach dessen Übermittlung an den Across-Server anzuzeigen. Tipp Wenn das Attribut in der Konfigurationsdatei fehlt, wird automatisch das Standard-Layout von crossTerm verwendet. |
workflowName | Name des Workflows, der für die weitere Verarbeitung der Termvorschläge verwendet wird. Der Name leitet sich von dem Namen der Workflow-Definitionsdatei ab. Im Falle der Workflow-Definitionsdatei Suggest.workflow tragen Sie beispielsweise „Suggest“ als Attributwert ein. |
suggestionButtonView | Definiert, auf welche Art die Seite zur Eingabe eines Termvorschlags aufgerufen wird. |
maxSuggestedTerms | Definiert die Anzahl der Termvorschläge, die ein Benutzer auf der Vorschlagsseite gleichzeitig hinzufügen darf. Hierbei handelt es sich um Termvorschläge, die zum gleichen Begriff bzw. Eintrag gehören und somit die gleiche Bedeutung haben. Klassischerweise sind dies neben den Standardbenennungen z. B. Synonyme, Varianten oder auch Abkürzungen. Die Termvorschläge müssen alle in der gleichen, für die Termvorschläge vorgegebenen Sprache hinterlegt werden. Tipp Wenn das Attribut in der Konfigurationsdatei fehlt, können standardmäßig beliebig viele Termvorschläge gemacht werden.
|
anonymousLoginRedirection | Aktiviert bzw. deaktiviert die Login-Funktion zur Erstellung von Termvorschlägen. Bei aktivierter Login-Funktion wird das Icon bzw. der Link für die Erstellung von Termvorschlägen immer angezeigt, und zwar auch ohne dass sich ein Benutzer in crossTerm Web angemeldet hat. Klickt ein nicht angemeldeter Benutzer auf das Vorschlags-Icon bzw. auf den Vorschlags-Link, erscheint ein entsprechender Anmeldedialog. Mögliche Werte: „1“ = aktiviert die Login-Funktion, „0“ = deaktiviert die Login-Funktion. |
Standardmäßig lassen sich Termvorschläge in genau einer festgelegten Sprache sowie für eine festgelegte crossTerm-Instanz machen. Die Einstellungen hierzu werden zentral in der Konfigurationsdatei presets.xml festgelegt. Durch die Definition unterschiedlicher Presets können Terme z. B. auch in verschiedenen Sprachen, für verschiedene crossTerm-Instanzen vorgeschlagen werden. So ist es z. B. möglich, zwei Presets anzulegen: eines für deutsche Termvorschläge und ein zweites für englische Termvorschläge. Zudem lassen sich auch zwei Presets anlegen, um z. B. unterschiedliche Workflows zu verwenden.
Alle vorhandenen Presets werden zusammen in der Konfigurationsdatei presets.xml gespeichert. Der Aufruf der Presets in crossTerm Web erfolgt über entsprechende URLs. Die URL für ein Preset mit dem Namen „german“ könnte z. B. folgendermaßen lauten:
crossTermWeb/crossTermWeb.dll?preset=german.
Erstellung bzw. Anpassung der Workflow-Definitionsdatei
Die Workflow-Definitionsdatei hat die Endung *.workflow (z. B. Suggest.workflow) und definiert den weiteren Workflow zur Verarbeitung der Termvorschläge.
Sie erstellen die Workflow-Definitionsdatei, indem Sie – beispielsweise mit einem Texteditor – eine *.txt-Datei erstellen und die Endung der Datei anschließend von .txt in .workflow ändern. Vergewissern Sie sich daraufhin, dass die Datei tatsächlich die Endung *.workflow und nicht mehr *.txt hat. Anschließend können Sie z.B. die Inhalte der Workflow-Definitionsdatei aus der nachfolgenden Beschreibung in die von Ihnen angelegte Workflow-Definitionsdatei kopieren und die Inhalte Ihren individuellen Bedürfnissen entsprechend anpassen.
Eine Workflow-Definitionsdatei kann beispielsweise die folgende Struktur aufweisen:
<workflow><states><statename="Suggested"/><statename="Accepted"final="true"/><statename="Rejected"final="true"/></states><transitions><transitionname="Add suggestion"from=""to="Suggested"/><transitionname="Accept"from="Suggested"to="Accepted"><actions><publish/></actions></transition><transitionname="Reject"from="Suggested"to="Rejected"/></transitions></workflow>
Die Workflow-Definitionsdatei enthält standardmäßig die folgenden Elemente:
Element | Beschreibung |
workflow | Wurzelelement, das den Workflow grundlegend definiert. Der Name des Workflows leitet sich vom Namen der Workflow-Definitionsdatei ab und wird entsprechend nicht in der Workflow-Definitionsdatei festgelegt. |
states | Definiert über die unterschiedlichen Tochterelemente state die Zustände der Termvorschläge. |
state | Definiert einen Zustand der Termvorschläge. Für jeden Zustand wird ein state-Element angelegt, wobei die Zahl der Elemente – und somit der definierbaren Zustände
Tipp Wenn Sie mehrere Workflows verwenden, werden gleichnamige Zustände, die in verschiedenen Workflows verwendet werden, in der Oberfläche von crossTerm Web und insbesondere in der Vorschlagssuche nicht gesondert, sondern als ein Zustand angezeigt. Falls Sie die Zustände eindeutig zuordnen müssen, können Sie diesen z. B. unterschiedliche Namen geben oder diese mit spezifischen Zusätzen versehen (wie z. B. „Vorgeschlagen (Standard-Workflow)“. |
transitions | Definiert über die Tochterelemente transition die Zustandsänderungen bei der Verarbeitung der Termvorschläge. |
transition | Definiert eine Zustandsänderung bei der Verarbeitung der Termvorschläge (z. B. von Vorgeschlagen nach Angenommen oder Abgelehnt). In der Oberfläche von crossTerm Web werden die Zustandsänderungen in Form von Buttons dargestellt. Für jede Zustandsänderung wird ein transition-Element angelegt, wobei die Zahl der Elemente – und somit der Zustandsänderungen – prinzipiell unbeschränkt ist.
|
actions | Definiert Aktionen, die zusammen mit der im Elternelement transition definierten Zustandsänderung erfolgen sollen. |
publish | Das Standalone-Kindelement publish definiert die Veröffentlichung der Termvorschläge. Durch die Veröffentlichung eines Termvorschlags wird dieser Vorschlag in einen „normalen“ Term umgewandelt, der z. B. bei Termsuchen gefunden wird und der mit den herkömmlichen crossTerm-Rechten bearbeitet werden kann. |
sendEmail | Definiert den Versand von E-Mails. Der Versand der E-Mails erfolgt automatisch, wenn die Zustandsänderung des Termvorschlags durchgeführt wird, die im entsprechenden Elternelement transition definiert ist. |
Sollte die Workflow-Definitionsdatei z. B. aufgrund einer falschen Struktur nicht ausgelesen werden können, wird ein entsprechender Eintrag in die Log-Datei von crossTerm Web geschrieben.
Die Namen der Vorschlagszustände sowie der Zustandsänderungen lassen sich – ebenso wie die anderen Texte des crossTerm Web-Vorschlagsmoduls – lokalisieren. Auf diese Weise können die Namen passend zu der Sprache angezeigt werden, in der die Oberfläche von crossTerm Web dargestellt wird.
Wir empfehlen dringend, im Falle von individuellen Anpassungen der Workflow-Definitionsdatei, die von der oben dargestellten Konfiguration abweichen, uns zu Rate zu ziehen. Andernfalls übernimmt Across keinen Support in Zusammenhang mit der fehlerhaften Einrichtung des Vorschlagsmoduls.
Bitte wenden Sie sich für weitere Informationen an Ihren Ansprechpartner bei der Across Systems GmbH.
Generelle Informationen zu Across-Dienstleistungen erhalten Sie unter www.across.net/dienstleistungen.
Automatischer E-Mail-Versand bei Zustandsänderungen
Über das Element sendEmail wird der automatische Versand von E-Mails konfiguriert. Der Versand der E-Mails erfolgt, wenn die Zustandsänderung des Termvorschlags durchgeführt wird, die im entsprechenden Elternelement transition definiert ist. Das Element sendEmail kann innerhalb des Elements actions z. B. folgendermaßen in ein Elternelement transition eingefügt werden:
<transition name="Accept" from="Suggested" to="Accepted">
<actions>
<publish />
<sendEmail fromAddress="noreply@across.net" toAddress="translator@across.net"
messageSubject="Suggestion accepted">
<![CDATA[
Dear crossTerm Web user,
A terminology suggestion was accepted.
For details, please look it up in {WorkItemLink}crossTerm Web{/WorkItemLink}.
Thank you.
---
This is an automated message.
You receive it because crossTerm Web was configured this way
by your Across/IT administrator. If you have any questions
regarding the reason or nature of this notification, please talk
to your administrator.]]>
</sendEmail>
</actions>
</transition> - Das Element sendEmail enthält standardmäßig die folgenden Attribute:
- Die Attribute fromAddress und toAddress definieren die E-Mail-Adresse, von der bzw. an die die E-Mail im Falle der Zustandsänderung gesendet wird.
Um bei einer Zustandsänderung eines Termvorschlags die E-Mail an den Benutzer zu senden, der den Termvorschlag gemacht hat, kann im Attribut toAddress als Adressat der Platzhalter {Suggester} verwendet werden (z. B. toAddress="{Suggester}"). Für den jeweiligen Benutzer muss hierfür eine E-Mail-Adresse hinterlegt sein: Handelt es sich bei dem Benutzer um einen Across-Benutzer, muss die E-Mail-Adresse innerhalb von Across in den Eigenschaften des Benutzers eingetragen sein. Handelt es sich bei dem Benutzer hingegen um ein Mitglied einer AD-Gruppe, die Zugriff auf das Vorschlagsmodul hat, muss die E-Mail-Adresse im jeweiligen Benutzerkonto des Active Directorys hinterlegt sein.
Das Attribut toAddress kann mehrere E-Mail-Adressen enthalten, um die entsprechenden E-Mails an mehrere Adressaten zu senden. E-Mail-Adressen werden jeweils durch ein Semikolon abgetrennt (z. B. toAddress="{Suggester};translator@across.net").
- Das Attribut messageSubject definiert den Betreff der E-Mail.
Um E-Mails versenden zu könnnen, müssen in crossAdmin, der Administrationssoftware des Across Language Server, entsprechende SMTP-Einstellungen für den Versand der E-Mails hinterlegt sein. Öffnen Sie crossAdmin zur Eintragung der erforderlichen Einstellungen und klicken Sie in der Modulleiste links auf crossTerm > Server-Administration. Stoppen Sie anschließend den crossTerm-Server über den entsprechenden Button und klicken Sie auf Eigenschaften. Wechseln Sie in den Bereich E-Mail-Einstellungen und geben Sie die nötigen Einstellungen ein. Als SMTP-Authentifizierungs-Verfahren wird die PLAIN-Authentifizierung unterstützt. Bestätigen Sie die Eingaben abschließend mit OK und starten Sie den crossTerm-Server anschließend wieder.
Sollte der Versand von E-Mails über das Vorschlagsmodul fehlschlagen, wird ein entsprechender Eintrag in die Log-Datei von crossTerm Web geschrieben.
Um bei der Zustandsänderung eines Termvorschlags mehrere E-Mails zu versenden, können Sie das Element sendEmail mehrfach innerhalb eines transition-Elements verwenden.
Definition des E-Mail-Textes
Sie legen den Text für die E-Mails fest, indem Sie diesen zwischen dem öffnenden Tag und dem schließenden Tag des Elements sendEmail einfügen.
Innerhalb des E-Mail-Textes ist die Verwendung von XML-Zeichen wie <, > und & nur dann möglich, wenn der E-Mail-Text als CDATA-Abschnitt konfiguriert ist.
Verlinkung mit dem Termvorschlag in crossTerm Web
Über den Platzhalter WorkItemLink besteht die Möglichkeit, einen Link in die E-Mails, die über das Vorschlagsmodul versendet werden, einzufügen. Durch einen Klick auf den Link in der empfangenen E-Mail öffnet sich crossTerm Web mit dem entsprechenden Termvorschlag. Bei der Anzeige des entsprechenden Termvorschlags in crossTerm Web muss der jeweilige Benutzer über die entsprechenden Rechte zur Ansicht von Termen verfügen.
Sie definieren eine solche Verlinkung, indem Sie innerhalb des E Mail-Textes vor und nach dem Text, der den Link enthalten soll, die Platzhalter-Markierung {WorkItemLink} bzw. {/WorkItemLink} einfügen, z. B.: „Informationen zu dem Termvorschlag finden Sie in {WorkItemLink}crossTerm Web{/WorkItemLink}".
Damit die Verlinkung korrekt funktioniert, muss in crossAdmin die URL von crossTerm Web hinterlegt sein. Die URL wird ebenfalls in den Einstellungen des crossTerm-Servers definiert. Öffnen Sie hierzu nochmals die Einstellungen des crossTerm-Servers und wechseln Sie in den Bereich crossTerm Web. Fügen Sie im Eingabefeld die URL von crossTerm Web ein, bestätigen Sie mit OK und starten Sie den crossTerm-Server anschließend wieder.
Nachträgliche Anpassung der Workflow-Definitionsdatei
Falls Sie die Workflow-Definitionsdatei anpassen, nachdem diese bereits zur Erstellung von Termvorschlägen sowie zur Weiterverarbeitung von Termvorschlägen verwendet wurde, bleiben die zuvor gemachten Vorschläge von den Änderungen unberührt. Das bedeutet, dass z. B. bisher bestehende Bearbeitungszustände weiterhin erhalten bleiben und etwa im Zustandsfilter der Vorschlagssuche aufgeführt werden.