HKR-Kanal konfigurieren
Auf diese Seite gelangt man aus der HKR-Kanal-Übersicht beim Anlegen einer neuen HKR-Kanal-Konfiguration oder beim Bearbeiten einer vorhandenen HKR-Kanal-Konfiguration.
Ein HKR-Kanal kann entweder für den Export von Zahlvorgängen (Sollstellungen) oder für den Import von Daten (Istbuchungen) konfiguriert werden. In Abhängigkeit von der gewählten Richtung im ersten Abschnitt „Allgemein“ ändern sich Feldelemente in der Eingabemaske zur Konfiguration.
Abschnitt „Allgemein“
Im Abschnitt „Allgemein“ wird beim Anlegen zunächst ein Name für den HKR-Kanal festgelegt, der sich bei einer späteren Bearbeitung nicht mehr ändern lässt. Der Name muss systemweit eindeutig sein. Darunter lässt sich eine Beschreibung hinzufügen. Mit der Richtung wird die Art des Kanals angegeben, nämlich ob es sich um einen Export von Zahlvorgängen (Sollstellungen) aus der ePayBL an das HKR-System oder um einen Import von Daten (Istbuchungen) aus dem HKR-System in die ePayBL handelt. Entsprechend der gewählten Richtung werden im folgenden Abschnitt die passenden HKR-Module angezeigt. Nach dem Anlegen eines Kanales kann die Richtung nicht mehr geändert werden, weshalb sie dann bei der nachträglichen Bearbeitung oberhalb des Abschnitts „Allgemein“ erscheint. Über den Status „aktiv“ lässt sich angeben, ob der Kanal die Daten der zugeordnete(n) Organisationseinheit(en) verarbeitet.
Für die Richtung „Export“ lässt sich außerdem festlegen, ob der Kanal allen Organisationseinheiten oder nur einer spezifischen Organisationseinheit zuordenbar sein soll (Erläuterungen dazu siehe unter: Organisationseinheiten / HKR-Kanäle). Im ersten Fall muss bestimmt werden, ob die Daten der Organisationseinheiten gemeinsam oder einzeln verarbeitet werden sollen. Im zweiten Fall muss zunächst der Mandant und anschließend nach dem Klick auf den dahinterstehenden Pfeil-Button seine zugehörige Organisationseinheit ausgewählt werden.
Für die Richtung „Import“ dagegen ist der HKR-Kanal stets nur einer spezifischen Organisationseinheit zuordenbar.
Außer der Beschreibung und dem Status lassen sich die Festlegungen in diesem Abschnitt im Nachhinein nicht mehr ändern.
Abschnitt „HKR-Modul“
Im Abschnitt „HKR-Modul“ lässt sich auswählen, über welches HKR-Modul die Transformation erfolgen soll, und es lassen sich dessen Modulparameter setzen. Die Auswahl der Module ist hierbei abhängig von der zuvor gewählten Richtung. Derzeit steht für die Export-Richtung nur das Modul „XFinanz3_EXPORT“ und für die Import-Richtung nur das Modul „XFinanz3_IMPORT“ zur Verfügung.
Für das Export-Modul „XFinanz3_EXPORT“ steht der Modulparameter „Nachrichtentyp“ zur Verfügung, über den sich einstellen lässt, ob es eine kamerale oder doppische Nachricht nach XFinanz-Standard Version 3.1.0 erzeugen soll (kasseImport.AOMitPersonKameral.0315 bzw. kasseImport.AOMitPersonDoppisch.0313). Erläuterungen zur Struktur der Nachricht siehe: https://www.xrepository.de/details/urn:xoev-de:agxfinanz:standard:xfinanz.
Das Import-Modul „XFinanz3_IMPORT“ benötigt keine Modulparameter.
Abschnitt „Zahlvorgangsauswahl für den Export“
Der folgende Abschnitt „Zahlvorgangsauswahl für den Export“ wird nur für die zuvor gewählte Export-Richtung „Export“ angezeigt. Hier wird dargelegt, welche Zahlvorgänge durch den Kanal verarbeitet werden sollen. Zum einen wird der Abfragezeitraum definiert, zum anderen wird der Zahlvorgangsstatus festgelegt, nach dem gefiltert werden soll („alle“ oder „bezahlt“). Bei der Auswahl „alle“ für den Zahlvorgangsstatus werden keinerlei Einschränkungen bzgl. des Status gemacht. Der Abfragezeitraum kann relativ zum Ausführungszeitpunkt gesetzt werden: entweder als „sich wiederholender Zeitraum“ bei mehrfacher Ausführung („vorheriger Monat“, „vorherige Woche“ oder „vorheriger Tag“) oder als „konkretes Zeitintervall“ bei einmaliger Ausführung unter Angabe eines eigens definierten Anfangs- und Endzeitpunkts. Schließlich werden in diesem Abschnitt auch die tatsächlich zugeordneten Organisationseinheiten angezeigt, deren Daten dieser Kanal verarbeitet (Erläuterungen dazu siehe unter: Organisationseinheiten / HKR-Kanäle).
Abschnitt „Transport“
Im Abschnitt „Transport“ lässt sich der Transportweg der Daten mit dem HKR-System festlegen. Je nach Auswahl des Transportweges werden die entsprechenden Eingabefelder eingeblendet.
Für die Export-Richtung erfolgt zunächst die Verarbeitung und anschließend der Transport der Daten. Hierbei stehen „Download“, „SCP“ und „SFTP“ als Transportwege zur Auswahl. Beim Transportweg „Download“ werden die erzeugten HKR-Dateien im Hauptmenüpunkt „Zahlungsdaten“ in der HKR-Dateien-Übersicht zum Herunterladen bereitgestellt (Erläuterungen dazu siehe unter: HKR-Dateien-Übersicht). Hierzu sind keine weiteren Angaben notwendig. Bei den Transportwegen „SCP“ und „SFTP“ werden die erzeugten HKR-Dateien auf den Zielserver ins angegebene Remote-Verzeichnis übertragen. Dazu müssen Hostname, Portnummer, Benutzername und Passwort für die Anmeldung am Host sowie das Remote-Verzeichnis auf dem Zielserver angegeben werden.
Für die Import-Richtung hingegen erfolgt zunächst der Transport und anschließend die Verarbeitung der Daten. Hierbei stehen „Upload“, „SCP“ und „SFTP“ als Transportwege zur Auswahl. Beim Transportweg „Upload“ müssen die zu verarbeitenden Istbuchung-Dateien zuvor in der Istbuchung-Dateien-Übersicht hochgeladen bzw. importiert werden (Erläuterungen dazu siehe unter: Istbuchung-Dateien-Übersicht). Bei den Transportwegen „SCP“ und „SFTP“ müssen die zu verarbeitenden Istbuchung-Dateien zuvor auf dem Quellserver im angegebenen Remote-Verzeichnis bereitgestellt werden, von wo sie in die Istbuchung-Dateien-Übersicht übertragen werden. Dazu müssen Hostname, Portnummer, Benutzername und Passwort für die Anmeldung am Host sowie das Remote-Verzeichnis auf dem Quellserver angegeben werden. Eine Verarbeitung der Istbuchung-Dateien ist erst eine Stunde nach deren letzten Bearbeitung auf dem Quellserver möglich. Da es derzeit nur das XFinanz3-Modul gibt, lassen sich nur XML-Dateien verarbeiten.
Für die Verwendung der Transportwege „SCP“ bzw. „SFTP“ muss der Betreiber dafür sorgen,
dass der Ziel- bzw. Quellserver in die Liste der erlaubten Hosts aufgenommen wird.
Diese Liste liegt im Home-Verzeichnis des Benutzers, unter dem die Portal-Applikation läuft,
im Unterverzeichnis „.ssh“ und heißt „known_hosts“.
Am einfachsten ist dies zu erreichen, indem auf der Kommando-Zeile eine ssh-Verbindung zum Ziel- bzw. Quellserver hergestellt wird.
Abschnitt „Zeitsteuerung“
Im letzten Abschnitt „Zeitsteuerung“ wird konfiguriert, wann der Kanal laufen soll, d.h. wann die automatische Datenverarbeitung erfolgen soll. Hier wird zunächst der Turnus bestimmt: Entweder wählt man als Turnus „monatlich“ mit der Ausführung am „ersten Tag des Monats“ bzw. „letzten Tag des Monats“. Oder man wählt als Turnus „ausgewählte Wochentage“ und kann hier für die Ausführung einen einzelnen Wochentag oder auch mehrere Wochentage aussuchen. Zuletzt wird noch die Uhrzeit der Ausführung angegeben.
Bei der Konfiguration der Uhrzeit zur Datenverarbeitung sind folgende Hinweise zu beachten:
- Für eine bessere Lastverteilung sollte die Verarbeitung über mehrere Kanäle auf unterschiedliche Zeitpunkte verteilt werden. Dies gilt insbesondere für wöchentliche und monatliche Verarbeitungen über größere Zeiträume mit vielen Daten. Anderenfalls kann es wegen der technisch begrenzten Systemressourcen zu Lastspitzen kommen.
- Uhrzeiten im Bereich der Zeitumstellung zwischen Normalzeit und Sommerzeit bzw. umgekehrt, d.h. die Zeiten zwischen 2:00 Uhr und 3:00 Uhr, sollten unbedingt vermieden werden. Es ist nicht möglich, doppelte Ausführungen oder ein Überspringen des Zeitpunkts zu erkennen oder zu verhindern.
Über den Button „Speichern“ werden die Eingaben validiert und die Konfiguration gespeichert. Kommt es zu Fehlern, werden diese am entsprechenden Eingabefeld angezeigt.
Eingabefelder
Bei der HKR-Kanal-Konfiguration gibt es folgende allgemeine Eingabefelder:
| Eingabefeld | Pflichtfeld | Typ | Längenbegrenzung | Format |
|---|---|---|---|---|
| Name | ja | String | 1 – 80 Zeichen | Groß-, Kleinbuchstaben, Ziffern, Unterstrich, Bindestrich und Leerzeichen |
| Beschreibung | nein | String | 0 – 1023 Zeichen | Beliebige Zeichen |
| Hostname | ja | String | 1 – 250 Zeichen | Beliebige Zeichen |
| Portnummer | ja | Zahl | 1 – 5 Ziffern | Zahl von 1 – 65535 |
| Benutzername | ja | String | 1 – 250 Zeichen | Beliebige Zeichen |
| Passwort | ja | String | 1 – 100 Zeichen | Beliebige Zeichen |
| Remote-Verzeichnis | ja | String | 1 – 250 Zeichen | Beliebige Zeichen |
Funktionsweise
Mit der Aktivierung des Kanals wird gleichzeitig ein entsprechender Batch-Job angelegt, der den Kanal entsprechend der Zeitsteuerung ausführt.
Für die Verarbeitung von Daten einer Organisationseinheit (Zahlvorgänge oder Istbuchungen) müssen folgende Voraussetzungen erfüllt sein:
- Ein HKR-Kanal ist konfiguriert und weist die Organisationseinheit als zuordenbar aus.
- Der HKR-Kanal ist in der Organisationseinheit zugeordnet (Erläuterungen dazu siehe unter: Organisationseinheiten / HKR-Kanäle).
- Der HKR-Kanal befindet sich im Status „aktiv“.
Für die erfolgreiche Verarbeitung der Daten ist die Zuordnung des HKR-Kanals zu einer Organisationseinheit innerhalb der betreffenden Organisationseinheit selbst sowohl für die Export-Richtung als auch für Import-Richtung erforderlich.
Struktur der XFinanz3-Nachrichten
Abhängig vom Modul-Parameter „Nachrichtentyp“ erzeugt das XFinanz-Modul Nachrichten vom Typ „kasseImport.AOMitPersonKameral.0315“ oder „kasseImport.AOMitPersonDoppisch.0313“ entsprechend XFinanz-Standard Version 3.1.0. Eine Beschreibung des Standards lässt sich unter https://www.xrepository.de/details/urn:xoev-de:agxfinanz:standard:xfinanz finden.
Die verschiedenen Kontierungsinformationen in den Nachrichten werden über Haushaltsparameter abgebildet. Dabei kann für die wichtigsten Kontierungsangaben ein entsprechender Haushaltsparameter verwendet werden. Da im Zahlvorgang sowohl auf Buchungsebene als auch auf Buchungslistenebene Haushaltsparameter gesetzt werden können, wird der Haushaltsparameter beim Schreiben der Nachricht zunächst in der Buchung gesucht und anschließend in der Buchungsliste. An manchen Stellen können aus traditionellen Gründen zwei Haushaltsparameter verwendet werden. So kann in der doppischen Nachricht für das Element „kontierungDoppisch.produkt“ als Haushaltsparameter sowohl „haushaltstelle“ als auch „kontierung.produkt“ gesetzt werden. Das Modul sucht hierbei als erstes den Haushaltsparameter „haushaltstelle“ zunächst in der Buchung und anschließend in der Buchungsliste und erst wenn dieser Parameter nicht gefunden wird, wird in den beiden Listen nach dem Haushaltsparameter „kontierung.produkt“ gesucht. Dies gilt entsprechend ebenso für das Element „kontierungDoppisch.sachkonto“ (mit der Suche nach den Haushaltsparametern „objektnummer“ und „kontierung.sachkonto“), für das Element „kontierungKameral.gliederung“ (mit der Suche nach den Haushaltsparametern „haushaltstelle“ und „kontierung.gliederung“) und für das Element „kontierungKameral.gruppierung“ (mit der Suche nach den Haushaltsparametern „objektnummer“ und „kontierung.gruppierung“).
Im Portal-Benutzerhandbuch ist an dieser Stelle eine Excel-Tabelle enthalten, die das Mapping der Daten eines Zahlvorgangs auf die Daten des XFinanz3-Standards zeigt.