Mit dem FileOutput-Knoten können Sie Nachrichten in Dateien schreiben.
Nachrichten aus Nachrichtenflusstransaktionen können in eine Datei im Dateisystem des Brokers geschrieben werden. Jede Nachricht wird beim Schreiben in eine Datei in eine Bytefolge konvertiert, die als Datensatz bezeichnet wird. Die Datensätze werden akkumuliert, bis ein Prozess zur Verarbeitungsbeendigung ausgelöst wird. Die Verarbeitungsbeendigung erfolgt, wenn keine weiteren Datensätze mehr zur Verarbeitung vorhanden sind. Die akkumulierte Datei wird dann in das angegebene Ausgabeverzeichnis oder in ein Verzeichnis auf einem fernen FTP-Server gestellt. Wie die Datensätze in Dateien akkumuliert werden und wohin diese Dateien nach ihrer Beendigung gestellt werden, wird durch Knoteneigenschaften festgelegt.
Der FileOutput-Knoten befindet sich im Ablagefach Datei der Palette und wird in der Workbench durch folgendes Symbol dargestellt:

Dateien werden vom FileOutput-Knoten als Folge von einem oder mehreren Datensätzen geschrieben. Die einzelnen Datensätze werden jeweils aus einer am Eingangsterminal des Knotens empfangenen Nachricht generiert.
Für jede am Eingangs- oder Dateibeendigungsterminal empfangene Nachricht können das Ausgabeverzeichnis und der Name der zu schreibenden (bzw. zu beendenden) Datei unter Verwendung von Nachrichtenelementen geändert werden. Diese Elemente, die sich standardmäßig auf Elemente in der lokalen Umgebung beziehen, können auf der Eigenschaftenregisterkarte Anforderung des Knotens angegeben werden.
Zum Erstellen von Dateien während der Verarbeitung sowie zum Verschieben von Dateien nach der Verarbeitung verwendet der FileOutput-Knoten Unterverzeichnisse des Ausgabeverzeichnisses. Alle diese Verzeichnisse beginnen mit dem Präfix mqsi. Zu diesen Verzeichnissen zählen unter anderem das Durchgangsverzeichnis mqsitransit sowie das Archivverzeichnis mqsiarchive. Die Datensätze werden nicht direkt in eine Datei im Ausgabeverzeichnis akkumuliert, sondern zunächst in eine Datei im Durchgangsverzeichnis. Erst nach Beendigung der Verarbeitung werden die Dateien aus dem Durchgangsverzeichnis in das Ausgabeverzeichnis verschoben. Wenn der Name einer Datei, die in das Ausgabeverzeichnis verschoben werden soll, mit dem Namen einer bereits im Ausgabeverzeichnis enthaltenen Datei identisch ist, kann die Datei im Ausgabeverzeichnis gelöscht, in das Archivverzeichnis 'mqsiarchive' verschoben oder zunächst umbenannt und dann in das Verzeichnis 'mqsiarchive' verschoben werden.
Sie können angeben, dass der FileOutput-Knoten im Rahmen der Verarbeitungsbeendigung Dateien auf einen fernen FTP-Server übertragen soll. Nach ihrer erfolgreichen Übertragung kann eine Datei aus dem lokalen Dateisystem gelöscht werden. Sie kann dort aber auch verbleiben, um während der weiteren Verarbeitung normal angezeigt zu werden.
Werden mehrere Datensätze geschrieben, kommt es nicht nach jedem Datensatz zu einer Verarbeitungsbeendigung. Diese findet erst statt, wenn an dem Dateibeendigungsterminal des Knotens eine Nachricht empfangen wird. Jede am Dateibeendigungsterminal eingehende Nachricht bewirkt, dass der Beendigungsprozess initiiert wird. Während dieses Prozesses wird die Datei aus dem Durchgangsverzeichnis entweder in das angegebene Ausgangsverzeichnis oder in ein Verzeichnis auf einem fernen FTP-Server verschoben.
Nicht als Fehler gilt, wenn das Durchgangsverzeichnis bei der Initiierung des Beendigungsprozesses leer ist.
Wenn Sie für die Eigenschaft Datensatzdefinition auf der Registerkarte Datensätze und Elemente den Wert Datensatz 'Gesamte Datei' angeben, erfolgt keine Verarbeitungsbeendigung, wenn am Dateibeendigungsterminal eine Nachricht empfangen wird; in diesem Fall ist die Verarbeitungsbeendigung nämlich bereits abgeschlossen.
Für jede am Eingangsterminal empfangene Nachricht, die von dem Knoten erfolgreich verarbeitet wurde, wird eine Kopie an das Ausgangsterminal weitergegeben, falls dieses angeschlossen ist. Auf diese Weise ist eine weitere Verarbeitung der Nachricht möglich.
Für jede Nachricht, die beim Dateibeendigungsterminal eingeht und vom Knoten erfolgreich verarbeitet wird, wird an das Datenendeterminal eine Kopie weitergeleitet, sofern diesem ein Nachrichtenfluss zugeordnet ist. Auf diese Weise ist eine weitere Verarbeitung nach der Beendigung der Datei möglich.
| Elementname | Elementdatentyp | Description |
|---|---|---|
| Verzeichnis | CHARACTER | Absoluter Verzeichnispfad des Ausgabeverzeichnisses in der vom Dateisystem des Brokers verwendeten Form. Auf Windows-Systemen beispielsweise beginnt der Verzeichnispfad mit dem Laufwerkbuchstabenpräfix (z. B. C:). |
| Name | CHARACTER | Dateiname der Ausgabedatei. |
| Action | CHARACTER | Mögliche Werte:
|
| Zeitmarke | CHARACTER | Der Zeitpunkt (Datum und Uhrzeit) in Form einer Zeichenfolge, zu dem der Knoten die Verarbeitung dieser Datei gestartet hat. Dieser Wert wird den Dateinamen der archivierten Dateien als Präfix vorangestellt, wenn auf der Registerkarte Grundeinstellung unter Maßnahme für Ausgabedatei die Option Zeitmarke, bestehende Datei archivieren und ersetzen angegeben ist. |
Möglicherweise müssen mehrere Nachrichtenflüsse in dieselbe Datei schreiben. Dies kann passieren, wenn es mehr als null zusätzliche Instanzen oder mehrere Flüsse mit FileOutput-Knoten gibt. Der FileOutput-Knoten lässt innerhalb einer Ausführungsgruppe und zwischen mehreren Ausführungsgruppen jeweils nur eine einzige Instanz zu, die eine Datei schreibt. Solange ein Datensatz geschrieben wird (bzw. die Verarbeitungsbeendigung erfolgt), müssen alle anderen Instanzen in der Ausführungsgruppe warten. Die Reihenfolge, in der die Instanzen Zugriff erhalten, ist nicht definiert.
Bei der Verarbeitungsbeendigung gilt, dass die erste Instanz, die Zugriff erhält, den Vorgang ausführt, während die übrigen Instanzen die Datei nicht finden können. Es handelt sich hierbei nicht um einen Fehler im Verarbeitungsablauf. Für alle Instanzen, die die Datei nicht im Durchgangsverzeichnis finden können, wird das Element 'Action' der Nachrichtenbaumstruktur 'LocalEnvironment.WrittenDestination.File' auf Finish (Beenden) gesetzt.
Nachdem Sie eine Instanz des FileOutput-Knotens in einen Nachrichtenfluss eingereiht haben, können Sie den -Knoten konfigurieren. Die Knoteneigenschaften werden in der Eigenschaftenansicht angezeigt. In dieser Ansicht sind alle obligatorischen Eigenschaften, für die Sie einen Wert eingeben müssen (d. h. Eigenschaften ohne definierten Standardwert) mit einem Stern markiert.
So konfigurieren Sie einen FileOutput-Knoten:
Der zu verwendende Pfad für das Ausgabeverzeichnis kann durch Werte in der aktuellen Nachricht überschrieben werden. Weitere Informationen hierzu finden Sie im Abschnitt zur Registerkarte 'Anforderung'.
Dateinamen werden an das Dateisystem übergeben, auf das der Broker Zugriff hat. Die Konventionen dieser Dateisysteme müssen berücksichtigt werden. So muss beispielsweise bei Dateinamen in Windows-Systemen Groß-/Kleinschreibung nicht beachtet werden, wogegen in UNIX-Systemen Dateinamen, die in der Groß- und Kleinschreibung voneinander abweichen, als verschiedene Dateinamen angesehen werden.
| Element-Datentyp | Elementattribute |
|---|---|
| CHARACTER | Absoluter oder relativer Verzeichnispfad. Verwenden Sie das entsprechende Pfadtrennzeichen ('/' oder '\') für das Dateisystem, auf dem der Broker ausgeführt wird. Abschließende Pfadtrennzeichen werden ignoriert. Relative Verzeichnispfade basieren auf dem Wert der Umgebungsvariablen 'MQSI_FILENODES_ROOT_DIRECTORY'. |
| Element-Datentyp | Elementattribute |
|---|---|
| CHARACTER | Expliziter Dateiname. Platzhalterzeichen werden für diesen Wert nicht ersetzt. |
In der folgenden Tabelle werden die Terminals des FileOutput-Knotens beschrieben.
| Terminal | Description |
|---|---|
| Eingangsterminal | Das Eingabeterminal, das eine Nachricht zur Verarbeitung durch einen Knoten annimmt. |
| Datei beenden | Das Eingabeterminal, das eine Nachricht annimmt, welche die Beendigung einer Datei auslöst. |
| Ausgang | Die am Eingangsterminal empfangene Nachricht wird an dieses Terminal weitergegeben, wenn der Datensatz erfolgreich geschrieben wurde. Die Nachricht bleibt bis auf Statusinformationen in der lokalen Umgebung unverändert. |
| Datenende | Die am Dateibeendigungsterminal empfangene Nachricht wird an dieses Terminal weitergegeben, wenn die Datei erfolgreich beendet wurde. |
| Fehlerterminal | Das Ausgabeterminal, an das die Nachricht geleitet wird, wenn während der Weitergabe der Nachricht ein Fehler auftritt. |
In den folgenden Tabellen werden die Knoteneigenschaften beschrieben. Die Spalte M zeigt an, ob die Eigenschaft obligatorisch ist (markiert mit einem Sternchen, wenn ein Wert eingegeben werden muss, weil kein Standardwert definiert ist). Die Spalte C zeigt an, ob die Eigenschaft konfigurierbar ist (Wert kann geändert werden, wenn der Nachrichtenfluss zur BAR-Datei hinzugefügt wird, um ihn einzusetzen).
| Eigenschaft | M | C | Standardwert | Description |
|---|---|---|---|---|
| Knotenname | Nein | Nein | FileOutput | Der Name des Knotens. |
| Kurzbeschreibung | Nein | Nein | Kurze Beschreibung des Knotens. | |
| Ausführliche Beschreibung | Nein | Nein | Text, der den Zweck des Knotens im Nachrichtenfluss beschreibt. |
In der folgenden Tabelle werden die Grundeinstellungseigenschaften des FileOutput-Knotens beschrieben:
| Eigenschaft | M | C | Standardwert | Description |
|---|---|---|---|---|
| Verzeichnis | Nein | Ja | None (Keinen) | Das Verzeichnis, in das der Knoten seine Dateien ablegt. |
| Dateiname oder Muster | Nein | Ja | None (Keinen) | Der bestimmte Dateiname oder ein Muster mit einem Platzhalterzeichen; definiert den Namen der zu erstellenden Datei. |
| Maßnahme für Ausgabedatei | Ja | Nein | Bestehende Datei ersetzen | Gibt an, welche Aktion bei Beendigung der Ausgabedatei erfolgen
soll. Folgende Optionen sind gültig:
|
| Doppelt vorhandene Archivdatei ersetzen | Ja | Nein | Nicht ausgewählt | Gibt an, ob Dateien im Archivverzeichnis durch gleichnamige Dateien, die dorthin verschoben werden, ersetzt werden dürfen. |
In der folgenden Tabelle werden die Anforderungseigenschaften des FileOutput-Knotens beschrieben:
| Eigenschaft | M | C | Standardwert | Description |
|---|---|---|---|---|
| Datenposition | Ja | Nein | $Body | Die Position in der Baumstruktur für Eingabenachrichten, in welcher der in die Ausgabedatei geschriebene Datensatz enthalten ist. |
| Verzeichniseigenschaft 'Position' anfordern | Ja | Ja | $LocalEnvironment/Destination/File/Directory | Die Nachrichtenelementposition, in welcher der Name des Ausgabeverzeichnisses enthalten ist. |
| Dateinameneigenschaft 'Position' anfordern | Ja | Ja | $LocalEnvironment/Destination/File/Name | Die Nachrichtenelementposition, in welcher der Name der Ausgabedatei enthalten ist. |
In der folgenden Tabelle werden die Dokument- und Elementeigenschaften des FileOutput-Knotens beschrieben:
| Eigenschaft | M | C | Standardwert | Description |
|---|---|---|---|---|
| Dokumentdefinition | Ja | Nein | Datensatz 'Gesamte Datei' | Über diese Eigenschaft wird gesteuert, wie die Datensätze in die Ausgabedatei
gestellt werden. Folgende Optionen sind gültig:
|
| Länge | Ja | Nein | 80 | Die erforderliche Länge des Ausgabesatzes. Diese Eigenschaft ist nur anwendbar, wenn unter Datensatzdefinition die Option Datensatz 'Daten mit fester Länge' angegeben ist. |
| Auffüll-Byte | Ja | Nein | X'20' | Das aus zwei Hexadezimalzeichen bestehende Byte, mit dem kurze Nachrichten aufgefüllt werden, wenn unter Datensatzdefinition die Option Datensatz 'Daten mit fester Länge' angegeben ist. |
| Begrenzer | Ja | Nein | Linienende des Brokersystems | Der zu verwendende Begrenzer, wenn unter Datensatzdefinition die Option Datensatz 'Daten mit Begrenzer' angegeben ist. Folgende Optionen sind gültig:
|
| Benutzerspezifischer Begrenzer | Nein | Nein | None (Keinen) | Die als Begrenzer dienende Bytefolge, die zu verwenden ist, wenn für die Eigenschaft Datensatzdefinition die Option Datensatz 'Daten mit Begrenzer' und für die Eigenschaft Begrenzer die Option Angepasster Begrenzer angegeben ist. |
| Begrenzertyp | Ja | Nein | Postfix | Mit dieser Eigenschaft wird angegeben, wie Begrenzer zwischen den einzelnen Datensätzen eingefügt werden, wenn unter Datensatzdefinition die Option Datensatz 'Daten mit Begrenzer' angegeben ist. Folgende Optionen sind gültig:
|
In der folgenden Tabelle werden die Validierungseigenschaften des FileOutput-Knotens beschrieben.
Eine umfassende Beschreibung dieser Eigenschaften finden Sie unter Auswertungseigenschaften.
| Eigenschaft | M | C | Standardwert | Description |
|---|---|---|---|---|
| Auswertung | Nein | Ja | Übernehmen | Durch diese Eigenschaft wird gesteuert, ob eine Auswertung stattfindet.
Gültige Werte sind:
|
| Fehlerbehebungsmaßnahme | Nein | Nein | Exception | Durch diese Eigenschaft wird gesteuert, was beim Fehlschlagen der Auswertung
geschieht.
Sie können diese Eigenschaft nur angeben, wenn Sie Auswerten auf Inhalt oder Inhalt und Wert gesetzt haben. Gültige Werte sind:
|
In der folgenden Tabelle werden die FTP-Eigenschaften des FileOutput-Knotens beschrieben:
| Eigenschaft | M | C | Standardwert | Description |
|---|---|---|---|---|
| FTP | Nein | Nein | Nicht ausgewählt | Mit dieser Eigenschaft wird festgelegt, ob der Knoten die auf der Registerkarte FTP aufgeführten FTP-Eigenschaften verwendet und Dateien auf einen FTP-Server überträgt. |
| FTP-Server und -Port | Nein | Ja | None (Keinen) | Die IP-Adresse oder der Name (und wahlweise auch die Portnummer) eines fernen FTP-Servers (z. B. ftp.server.com:21) oder der Name eines konfigurierbaren Service vom Typ 'FtpServer'. Bei Angabe des Namens eines konfigurierbaren Service können die folgenden FTP-Eigenschaften komplett oder teilweise von dem konfigurierbaren Service überschrieben werden. |
| Sicherheitsidentität | Nein | Ja | None (Keinen) | Der Name der Benutzer-ID, die für den Zugriff auf den FTP-Server verwendet wird. Diese Eigenschaft wird mit der Eigenschaft 'securityIdentity' im konfigurierbaren FTP-Server-Service überschrieben, falls definiert. |
| Serververzeichnis | Nein | Ja | "." | Das Verzeichnis auf dem FTP-Server, in das Dateien übertragen werden sollen. Wird hierfür ein relativer Pfad angegeben, bezieht sich dieser auf das Ausgangsverzeichnis nach der Anmeldung. Diese Eigenschaft wird mit der Eigenschaft 'remoteDirectory' im konfigurierbaren FTP-Server-Service überschrieben, falls definiert. |
| Übertragungsmodus | Nein | Ja | Binär | Der FTP-Übertragungsmodus für die Übertragung von Dateidaten. Folgende Optionen sind gültig:
|
| Lokale Datei nach Übertragung behalten | Nein | Nein | Nicht ausgewählt | Ist dieses Kontrollkästchen aktiviert, wird von einer Datei, die auf einen fernen FTP-Server übertragen wurde, eine lokale Kopie behalten und gemäß den Angaben zur Dateidisposition auf der Registerkarte Grundeinstellung in das Ausgabeverzeichnis gestellt. Ist dieses Kontrollkästchen nicht ausgewählt, werden von Dateien, die auf einen fernen FTP-Server übertragen wurden, keine lokalen Kopien behalten. |