Dokumenten-Editor

DOKA-NG bietet eine umfangreiche Sammlung an vordefinierten Briefen. Korrespondenz an die Kunden- und Korrespondenten-Seite wird in fast jeder Geschäftstransaktion erstellt. In der Transaktionsdokumentation des jeweiligen Geschäftsvorfalls (z.B. Eröffnen eines Import-Akkreditivs) ist im Abschnitt 'Ausgehende Korrespondenz' detailliert beschrieben, welche Nachrichten unter welchen Bedingungen erstellt werden können und wer der Empfänger der Nachricht ist. Die Texte und Regeln für die Erstellung dieser Briefe sind in der Anwendung hinterlegt.

Der “Dokumenten-Editor” ist eine eingebaute Funktionalität, die in allen Geschäftsbereichen der Anwendung zur Verfügung steht und es dem Benutzer ermöglicht, bestehende Briefkorrespondenz zu überschreiben und kleinere Textanpassungen vorzunehmen, wie z.B.

• Hinzufügen von Text,
• Unterdrücken von Texten oder
• kleine Formatierungsänderungen usw.

Diese Änderungen können für die künftige Verwendung der ausgehenden Korrespondenz gespeichert werden.

Sobald die relevanten Informationen in die Erfassungsfelder der Transaktion eingegeben wurden, wird die erwartete Briefkorrespondenz im “Nachrichten” Panel angezeigt. Um eine bestimmte Briefvorlage zu bearbeiten, muss zunächst das Icon mit der Lupe geklickt werden, um den Brief anzuzeigen. Sobald der betreffende Absatz oder Text mit Doppelklick ausgewählt wird, wird das Fenster “Dokumenten-Editor” geöffnet, in dem die “XML-Templates” nur für den ausgewählten Text und Absatz angezeigt wird.

Alternativ kann man den “Dokumenten-Editor” starten, indem man auf das Icon mit dem Stift im “Nachrichten”-Panel klickt und dann weiter auf den Button “Doc. Editor”. Das Fenster “Dokumenten-Editor” zeigt nun alle “XML-Templates” an, die im ausgewählten Brief enthalten sind.

Die “XML-Templates” können nacheinander ausgewählt werden, um den Textinhalt sowohl in der Originalsprache als auch in den anderen übersetzten Sprachen zu überprüfen, und es wird auch der Status der Vorlagen angezeigt, ob sie geändert wurden oder nicht.

Der Dokumenten-Editor kann nur in Server-Umgebungen verwendet werden.

Die im “Dokumenten-Editor” vorgenommenen Änderungen werden in den Tabellen “XMX” (“XML-Templates”) und “XMR” (“Dokumenten-Regeln”) unter verschiedenen Schlüssel-Typen und damit auf bestimmten Ebenen gespeichert. Diese Schlüssel-Typen basieren auf vordefinierten Bedingungen, die entscheiden, bei welchem Geschäftsszenario der geänderte Text generiert wird.

Um eine angemessene Kontrolle zu haben, sollte die Bereitstellung des “Dokumenten-Editor” auf eine Vorproduktions- oder UAT-Umgebung beschränkt sein und nach der Validierung der Änderungen schrittweise über SYSUPD mit 4-Augen-Kontrolle in die Produktionsumgebung übernommen werden.

Die Funktion “Dokumenten-Editor” ermöglicht es den Anwendern, den gewünschten Text zu aktualisieren, zu ändern und zu löschen und alle Änderungen an der Briefvorlage auf einmal zu speichern. Da es sich um eine interaktive Fuktionalität handelt, können die in den Briefvorlagen vorgenommenen Änderungen in Echtzeit angewendet und überprüft werden.

Es ist vorgesehen, dass die Benutzer die “XML-Templates” bearbeiten und auch die Dokumentenregeln aktualisieren können. Diese Möglichkeit ist an bestimmte Benutzerrechte in der Transaktion Verwalten von Benutzerprofilen geknüpft.

• Benutzer, der als “Dokumenten-Editor” definiert ist - Ein Benutzer, der nur Rechte zur Bearbeitung der Texte der “XML-Templates” hat. Dieser Benutzer ist für Anwender gedacht, die nicht technisch versiert sind und daher nur Texte ändern können sollen.

• Benutzer, der als “Designer” definiert ist - Ein Benutzer, der sowohl Rechte für die Bearbeitung von “XML-Templates” als auch für die Aktualisierung von Dokumentenregeln hat. Dies ist für technisch versierte oder erfahrene Benutzer mit ausreichenden Kenntnissen, um die Auswirkungen von Änderungen an den Dokumentregeln zu verstehen.

Für Benutzer mit dem Profil “Dokumenten-Editor” sind die erweiterten Optionen zur Aktualisierung von Dokumentregeln wie “Feld einfügen” und “Logik Regeln” nicht verfügbar.

Die folgenden Funktionen sind für Benutzer verfügbar, die als “Dokumenten-Editor” und “Designer” definiert sind:

• “Absatz nach Name” - Dieses Feld ermöglicht es dem Benutzer, die Textvorlagen nach ihrem Namen zu durchsuchen. Es besteht die Möglichkeit, nur einen Teil des Namens einzugeben und dann auf den Button “Suchen” zu klicken, um das gewünschte “XML-Template” aus einer Liste von Vorlagen mit ähnlichem Namen zu finden.

• “Absatz nach Inhalt” - Hier kann der Benutzer einen Teil des Inhalts eingeben und dann auf den Button “Suchen” klicken, um eine Liste von “XML-Templates” mit ähnlichem Inhalt zu finden. Um bessere Suchergebnisse zu erzielen, kann die Suche sowohl nach dem Namen als auch nach dem Inhalt gleichzeitig durchgeführt werden.

• “Liste von Absätzen” - In diesem Feld kann der Benutzer zwischen den im Brief verwendeten Textvorlagen wählen und umschalten.

• “Absätze” - Basierend auf der Auswahl der Textvorlage im Feld “Liste der Absätze” hilft dieses Feld dem Benutzer, die verfügbaren Schlüssel-Typen zu erkennen, die in der Spalte “Schlüssel” zusammen mit der jeweiligen Ebene in der Spalte “Ändern in” angezeigt werden. Diese Spalte hilft bei der Bestimmung des spezifischen Geschäftsszenarios, bei dem ein bestimmter geänderter Text generiert werden soll. Nachfolgend sind die verfügbaren Schlüssel-Typen von einer sehr spezifischen zu einer generischen Ebene geordnet.

• Dokumentregel - Dies impliziert einen Textinhalt, der spezifisch für eine XML-Vorlage innerhalb eines bestimmten Briefes vorgesehen ist. Wenn beispielsweise innerhalb eines Briefes eine “XML-Vorlage” mit dem Schlüssel “Dokumentenregel” geändert wird, erfolgt die Änderung nur für die Kombination von diesem Brief und “XML-Vorlage”. Wenn das gleiche “XML-Template” noch in einem anderen Brief verwendet wird, wird die Änderung an diesem nicht berücksichtigt.

• Transaktion ​- Dies bedeutet, dass der Textinhalt spezifisch für die Transaktionsebene ist, z. B. spiegeln sich solche Änderungen in “XML Template” nur in den Briefen wider, die innerhalb einer bestimmten Transaktion verwendet werden, wie LITOPN, BCTDAV usw.

• Geschäftsbereich - Dies beinhaltet einen Text, der für die Ebene des Geschäftsbereichs spezifisch ist, z. B. wird sich eine solche Änderung in “XML Template” in den Briefen widerspiegeln, die innerhalb eines bestimmten Geschäftsbereichs verwendet werden, wie Export LC, Import LC usw.

• All - Dies bedeutet, dass der Textinhalt in allen Geschäftsbereichen gleich ist, d. h., wenn ein “XML-Template” geändert wird, wird die Änderung in allen Briefen, die dieselbe “XML-Vorlage” enthalten, berücksichtigt.

Standardmäßig ist der Textinhalt aller Schlüssel-Typen für ein bestimmtes “XML-Template” identisch. Nach einer Änderung hat jedoch der Textinhalt des spezifischeren Schlüssel-Typs Vorrang vor dem der anderen Schlüssel, falls geänderter Textinhalt für ein bestimmtes “XML-Template” in mehreren Schlüssel-Typen vorhanden ist. Es hilft auch, den Status der Vorlagen zu erkennen, ob sie geändert wurden oder nicht. In der Spalte “Modifiziert” wird entweder “Ja” oder “Nein” angezeigt, um anzugeben, ob die “XML-Vorlage” bereits geändert wurde oder nicht. Wenn eine der Vorlagen ausgewählt wird, ist der Textinhalt sowohl in der Originalsprache als auch in der übersetzten Sprache in den Feldern “Inhalt” bzw. “Gleicher Paragraph in” verfügbar. Der Benutzer kann entscheiden, ob er benutzerdefinierte oder generische Texte für jede Transaktionsart mit einem bestimmten “XML-Template” verwenden möchte.

• “Zeige alles” - Wenn die Checkbox aktiviert ist, werden alle “XML-Templates” angezeigt, die tatsächlich im Quellcode eines bestimmten Briefes verfügbar sind. Hierbei ist zu beachten, dass es sich hierbei um eine sehr lange Liste handelt und dass aufgrund der codierten Geschäftslogik nicht alle möglichen und verfügbaren “XML-Templates” sinnvoll angepasst werden können.

• “Inhalt” - Nach Auswahl eines bestimmten “XML-Templates” im Feld “Absätze” zeigt das Feld “Inhalt” den Textinhalt in der Originalsprache zusammen mit dem Namen der Sprache an. Dieser Bereich ist editierbar und ermöglicht es dem Benutzer, den Textinhalt zu ändern und den Inhalt in Echtzeit zu speichern, indem er auf den Button “Anwenden” klickt. Alle Textänderungen werden sofort auf das betreffende Dokument angewendet und können beim erneuten Öffnen des Dokuments überprüft werden.

Sobald das Feld “Inhalt” mit dem neuen Text aktualisiert wurde, zeigt das Feld “Absätze” den Status “Geändert” als “Speichern in Bearbeitung” an, wenn der Benutzer auf das nächste “XML-Template” klickt. Der Benutzer hat nun die Möglichkeit, die Änderungen entweder zu speichern oder zu verwerfen, indem er auf die entsprechenden Buttons “Anwenden” oder “Discard” klickt.

• “Gleicher Paragraph in” - Nach Auswahl eines bestimmten “XML-Templates” im Bereich “Absätze” zeigt der Bereich “Gleicher Paragraph in” den Textinhalt in einer übersetzten Sprache und den Namen der verfügbaren Sprache an. Der Inhalt dieses Feldes ist beschränkt und kann nicht geändert werden, aber es ermöglicht dem Benutzer, andere Sprachen auszuwählen, in der Übersetzungen vorhanden sind. Wenn ein neuer Text in das Feld “Inhalt” eingefügt wird, muss die Übersetzung des neu hinzugefügten Textes im Feld “Gleicher Paragraph in” manuell übersetzt werden.

• “Default” - Falls der geänderte Text wieder in seinen ursprünglichen Zustand zurückversetzt werden soll, kann dies durch Klicken auf den Button “Default” erreicht werden. Die Option “Default” hilft dabei, den ursprünglichen Text aus dem Sourcecode wiederherzustellen, auch wenn bereits Textänderungen durchgeführt und gespeichert wurden. Sobald die Texte unter “XML-Templates” wieder in ihren Ursprungszustand gebracht wurden, ändert sich der Status der Spalte “Geändert” im Feld “Absätze” automatisch von “Ja” auf “Nein”.

Jede Änderung oder Einfügung von Textinhalten innerhalb von spezifischen “XML-Templates”, die ein Argument (z. B. {$1}) oder leere Templates (z.B. TRNDOC:emptyline) enthalten, sollte nach Möglichkeit vermieden werden, da dies sonst zu strukturellen Problemen führen kann. Auch jede Änderung an “XML-Templates” in den zentralen Modulen, z. B. dem Abrechnungsmodul (SETMOD), sollte sorgfältig geprüft werden, da dies allgemeine Auswirkungen auf die gesamte Applikation haben kann.

Die folgende Funktionalität ist nur für Benutzer verfügbar, die als “Designer” definiert sind:

• “Feld einfügen” - Der Button “Feld einfügen” ermöglicht es dem Benutzer, bei Bedarf zusätzliche Datenbankfelder in den Inhalt von “XML-Templates” einzufügen, unabhängig von Schlüssel-Typ. Durch Klicken auf den Button “Feld einfügen”/ wird das Fenster “Feldinspektor” geöffnet, in dem ein beliebiges Datenbankfeld aus der aktuellen Transaktion ausgewählt und in das entsprechende “XML-Template” eingefügt werden kann. In der Regel steht der in das Template aufgenommene Feldname in einer Klammer oder wird manchmal durch einen zusätzlichen Funktionsnamen ergänzt. Wenn der Brief gedruckt wird, ist nur der eigentliche Feldinhalt sichtbar. Da die Funktion “Feld einfügen” eher technischer Natur ist, ist sie nur für Benutzer zulässig, die im Benutzerprofil als “Designer” definiert sind.

• “Logik Regel” - Um die Dokumentregeln zu ändern, muss der Benutzer auf den Button “Logik Regel” klicken und die neuen Regeln im Fenster “Dokumentenregel bearbeiten” unter einer bestimmten “DocRule ID” aktualisieren. Hier kann der Benutzer auch die Schlüssel-Typen angeben, für die diese Dokumentregel verwendet werden kann. Sobald die neue Dokumentregel eingefügt ist, kann
• der Button “Discard” verwendet werden, um das Fenster zu schliessen, ohne die neuen Regeln zu speichern,
• der Button “Prüfen” zum Kompilieren verwendet werden, und
• der Button “Speichern” sowohl zum Kompilieren als auch zum Speichern der neuen Regel verwendet werden.

Standardmäßig sind die Dokumentenregeln aller Schlüssel-Typen für eine bestimmte “DocRule ID” identisch. Nach einer Änderung hat die neue Dokumentenregel des spezifischeren Schlüsseltyps jedoch Vorrang vor den anderen Schlüssel-Typen, falls für eine bestimmte “DocRule ID” eine neue Dokumentenregel für mehrere Schlüssel-Typen existiert. Die gespeicherten Dokumentenregeln werden immer ohne Fehler ausgeführt, da die Änderungen bereits beim Speichern berücksichtigt werden und somit keine Fehler bei der Ausführung auftreten können. Das Dokument spiegelt die aktualisierte Dokumentenregel sofort wider, wenn das Dokument das nächste Mal geöffnet wird. Die Dokumentenregeln müssen mit Sorgfalt gehandhabt werden, da sie ein fundiertes technisches Verständnis erfordern und daher nur für Designer zugelassen sind.

Sobald mit dem “Dokumenten Editor” Änderungen an einem bestimmten Dokument vorgenommen werden, werden diese in der Datenbank gespeichert und stehen für alle zukünftigen Kontrakte zur Verfügung.

Aus Gründen der Datenbanksicherheit können Befehle, die die Datenbank durch Dokumentenregeln verändern könnten, nicht gespeichert werden und führen zu einer Fehlermeldung, beispielsweise TradeDesign-Befehle wie “DBexecutesql” oder “DBread”.

Alle mit dem Dokumenten Editor vorgenommenen Änderungen an den XML Templates können über die Transaktion Verwalten von Dokumenten Templates angezeigt werden. Änderungen an den Dokumentenregeln können über die Transaktion Verwalten von Dokumentenregeln angezeigt werden.

Der “Dokumenten-Editor” erlaubt nur die Bearbeitung von Briefkorrespondenz. Elektronische Nachrichten wie SWIFT, Score, Bolero, allNETT usw. können nicht geändert werden.

Der “Dokumenten-Editor” erlaubt nur das Überschreiben der vorhandenen “XML-Templates” oder der Dokumentenregeln innerhalb des Briefes. Falls ein zusätzliches “XML-Templates” oder Regel angefordert werden, würde dies dem Standard-Overlay-Entwicklungsprozess folgen. Sobald die zusätzliche Vorlage oder Regel entwickelt und in die Basisversion übernommen wurde, können die Benutzer diese ändern.

Falls zusätzliche Dokumente benötigt werden oder die Änderungen im Brief komplexer Natur sind, werden diese Änderungen im Rahmen der Standard-Overlay-Entwicklung behandelt.