Überblick
Kurzbeschreibung
Das Currency-Nuclet bietet die Möglichkeit
Währungen und Wechselkurse zu pflegen
Währnungsbeträge von einer Währung in eine andere zu konvertieren
Wechselkurse über eine Schnittstelle bei der Europäischen Zentralbank (EZB) täglich aktualisieren zu lassen
Nuclet-Bestandteile
Das Currency-Nuclet umfasst im Rahmen der .nuclet-Datei
drei Entitäten (für Währungen, Wechselkurse und einen Währungsrechner),
drei Layouts,
diverse Java-Regeln (verteilt auf Packages),
zwei Jobsteuerungen (zur Steuerung des EZB-Schnittstelle einerseits, für Tests andererseits),
zwei Strukturdefinitionen (für den Import von Stammdaten) und
eine Nuclet-Abhängigkeit.
Darüberhinaus werden in der ZIP-Datei folgende Komponenten mitgeliefert:
zwei CSV-Dateien für Objektimporte
Typ | Name, englisch | Name, deutsch | Kurzbeschreibung |
|---|---|---|---|
Entität | Currency | Währung |
|
| Currency Converter | Währungsrechner |
|
| Exchange Rate | Wechselkurs |
|
Layout | Currency |
| Layout für Entität „Currency“ |
| Currency Converter |
| Layout für Entität „Currency Converter“ |
| Exchange Rate |
| Layout für die Entität „Exchange Rate“ |
Java-Package | org.nuclet.currency.facade |
| Java-Regeln für Datenbankzugriffe je Entität |
| org.nuclet.currency.job |
| Java-Regeln zur Steuerung von Jobs („Jobsteuerung“) |
| org.nuclet.currency.logic |
| Geschäftslogik |
| org.nuclet.currency.rule |
| Regeln für Insert-,Update- und Delete-Events |
| org.nuclet.currency.test |
| Java-Regeln zur Steuerung von Tests |
| org.nuclet.currency.xml |
| XML-Parserfunktionalität für die EZB-Schnittstelle |
Jobsteuerung | Currency Converter Test |
| Test-Job für Währungskonvertierungen |
| ECB Exchange Rates |
| Fristenjob für die Aktualisierung von Wechselkursen |
Strukturdefinition | Currency |
| Importstruktur für Entität „Currency“ |
| Currency Converter |
| Importstruktur für Entität „Currency Converter“ |
Nuclet-Abhängigkeit | org.nuclet.Common |
| allgemeine Helferfunktionalität |
Objektimporte | Currency.csv |
| Stammdatensätze für Entität „Currency“ |
| Currency_Converter.csv |
| Stammdatensätze für Entität „Currency Converter“ |
Tabelle 1: Nuclet-Bestandteile
Java-Package-Struktur
Die Java-Regeln sind in sechs Packages unterteilt:
Regeln für maskengesteuerte Events (org.nuclet.currency.rule)
Regeln zur Steuerung von System-Jobs (org.nuclet.currency.job)
Regeln für die Geschäftslogik (org.nuclet.currency.logic)
Fassaden-Klassen für die Ausführung von Datenbankabfragen je Enität (org.nuclet.currency.facade)
Regeln zum Einlesen und Verarbeiten von MT940-Dateien (org.nuclet.currency.xml)
Regeln für die Ausführung von Tests (org.nuclet.currency.test)
Die Abhängigkeiten der Packages sind in der folgenden Abbildung veranschaulicht.
Das Currency-Nuclet ist Java-seitig voll funktionsfähig. Hier eine Übersicht über die auf die einzelnen Packages verteilten Java-Klassen:
Java-Package | Java-Klasse | Kurzbeschreibung |
org.nucket.currency.facade | CurrencyFacade | Datenbankzugriffe für die Entität „Currency“ |
| ExchangeRateFacade | Datenbankzugriffe für die Entität „Exchange Rate“ |
org.nuclet.currency.job | EcbExchangeRateImporter | Importer-Klasse für die EZB-Schnittstelle |
| EcbExchangeRatesJob | Job für den Aufruf des EZB-Schnittstellenimports |
org.nuclet.currency.logic | CurrencyConverterLogic | Logik für Währungskonvertierungen |
| CurrencyLogic | Validierungslogik für Währungen |
org.nuclet.currency.rule | ConvertCurrencyAmount | Konvertierung in der Währungsrechner-Maske |
| DeleteCurrency | maskengesteuertes Löschen einer Währung |
| InsertCurrency | maskengesteuertes Hinzufügen einer Währung |
| SwapCurrencies | Währungstausch (Basis- und Zielwährung) in der Währungsrechner-Maske |
| UpdateCurrency | maskengesteuertes Editieren einer Währung |
org.nuclet.currency.test | CurrencyConverterTest | Test-Klasse zum Testen von Währungskonvertierungen |
| CurrencyConverterTestJob | Job zum aufruf des Tests von Währungskonvertierungen |
org.nuclet.currency.xml.sax | EcbExchangeRate | Wrapper-Klasse für den Import über die EZB-Schnittstelle |
| EcbExchangeRateHandler | XML-Handler für die EZB-Schnittstelle |
Tabelle 2: Java-Package-Struktur
Anwendungsspezifische Anpassungen sollten in den Java-Regeln i.A. nicht notwendig sein.
Integration
Notwendige Schritte zur Integration
Die Integration des MT940-Nuclets erfolgt in 8 Schritten:
Download
Nuclet-Import
Objektimporte anlegen
Objektimporte ausführen
Anpassungen im Entitäten-Wizard
Alle Integrationschritte werden im folgenden im Detail erläutert.
Schritt 1: Download
Download der ZIP-Datei „Currency-v1.0.0.zip“ auf der Nuclos-Webpage unter „Nuclos Services“ > „Download“ > „Nuclet Download“. Das ZIP anschließend lokal entpacken.
Schritt 2: Nuclet-Import
Import des MT940-Nuclets unter „Konfiguration“ > „Nuclet Management“ > „Importieren“ in Ihre bestehende Nuclos-Instanz, Auswahl der Datei „Currency-v1.0.0.nuclet“
Schritt 3: Objektimporte anlegen
Objektimporte („Konfiguration“ > „Import & Export“) anlegen zu den Strukturdefinitionen „Currency“ und „Currency Converter“. Dazu können die mitgelieferten CSV-Dateien „Currency.csv“ und „Currency_Converter.csv“ (zu finden im Unterverzeichnis „data“ der ZIP-Datei) verwendet werden.
Achtung: Es besteht eine Abhängigkeit zwischen „Currency Converter“ und „Currency“; die Währungen („Currency“) müssen vor dem Währungsrechner („Currency Converter“) importiert werden.
Hinweis: Die CSV-Dateie „Currency.csv“ umfasst 34 Stammdatensätze. Das sind alle Währungen, die aktuell von der EZB-Schnittstelle unterstützt werden. Sollten Sie für einige Währungen darunter keine Verwendung in Ihrer Anwendung haben, dann löschen Sie diese Datensätze bitte einfach nach dem Import. Nicht vorhandene Währungen werden bei der Aktualisierung über die EZB-Schnittstelle nicht berücksichtigt.
Schritt 4: Objektimporte ausführen
Die in Schritt 3 angelegten Objektimporte ausführen, so dass alle notwendigen Stammdaten im System sind.
Schritt 5: Anpassungen im Entitäten-Wizard
Bitte verwenden Sie die Währungs-Entität („Currency“) in den Entitäten, in denen Währungsbeträge enthalten sind. Wenn noch keine Währung als Attribut-Referenz in Ihrem Nuclos-System vorhanden ist, dann genügt es die Währung als zusätzliches Attribut hinzunehmen. Sollten Sie bereits eine eigene Entität nutzen, die Währungen abbildet, dann ist die Integration des Nuclets nur mit einem Mehraufwand zu realisieren.
Nutzung
Einrichten der Jobsteuerung
Öffnen der Jobsteuerung „ECB Exchange Rates“ unter „Administration“ > „Jobsteuerung“
Konfiguration von Startdatum, Startzeit, Intervall, E-Mail-Benachrichtigung und Optionen zum Löschen des Log-Infos.
Jobsteuerung aktivieren, falls der Job im konfigurierten Rhythmus automasiert ausgeführt werden soll. Alternativ lässe sich der Job über die Jobsteuerung auch manuell ausführen.
Betrieb
Die importierten Daten werden in der Entität für Wechselkursee („Exchange Rate“) gespeichert.
Die Masken für Währungen und Wechselkurse sind unter dem Menüpunkt „Wechselkurse“ zu finden. Dies ist über den Entitäten-Wizard jederzeit zu ändern.
Der Währungsrechner ist ebenfalls unter dem Menüpunkt „Wechselkurse“ zu finden. Sollten Sie ihn nicht nutzen wollen, dann können Sie ihn über den Entitäten-Wizard aus dem Menü entfernen.
Das Nuclet ist zur Zeit so eingestellt, dass alle Wechselkurse in der Basiswährung des System angezeigt werden. Da die Aktualisierung über die EZB-Schnittstelle läuft, ist der Euro (EUR) als Basiswährung hinterlegt. Sie können das Nuclet auch leicht so einstellen, dass in jeder Währung der Wechselkurs zum Euro angezeigt wird: Dazu öffnen Sie das Layout „Currency“ und tauschen den eingetragenen Wert im Feld „Fremdschlüssel“ (Unterformular „Exchange Rates“) von „baseCurrency“ auf „counterCurrency“.
Einrichten von Benutzerrechten (optional)
Zugriffsrechte für existierende Benutzergruppen für Layouts, Entitäten, Attribute und Attributgruppen können in Nuclos wie üblich über drei Wege festgelegt werden (siehe dazu http://wiki.nuclos.de):
allemeine Einstellungen für Entitäten unter „Administration“ > „Benutzergruppen“
statusabhängige Einstellungen für Attribute/Attributgruppen unter „Konfiguration“ > „Statusmodell“
datensatzspezifische Einstellungen unter „Konfiguration“ > „Datenquellen“ > „Datensatzfreigabe“
Tests
Für einfache Tests von Währungskonvertierungen steht die Währungsrechner-Maske zur Verfügung.
Für erweiterte Tests von Währungskonvertierungen nutzen Sie bitte die Klasse org.nuclet.currency.test.CurrencyConverterTest. Diese können Sie auch gerne auf Ihre eigenen Bedürfnisse anpassen und erweitern. Die Klasse wird vom org.nuclet.currency.test.CurrencyConverterTestJob aufgerufen, und dieser lässt sich über die Jobsteuerung „Currency Converter Test“ bei Bedarf (am besten manuell) ausführen.
