Kurzbeschreibung
Der FileWriterService erlaubt es Dateien auf einem definierten Pfad abzulegen. Die Datei wird aus dem Message-Context-Element B3P_OBJ_MESSAGE gelesen. Der Ablagepfad wird konfiguriert. Der Dateiname kann automatisch generiert werden.
Einrichtung
Die FileWriterService wird als (passiver) Service eingerichtet. Dabei müssen die folgenden Einstellungen am Service vorgenommen werden:
- Klasse
org.b2bbp.services.outbound.file.FileWriterService - Typ
FILE - Status
STP
Der Service muss über eine Action aufgerufen werden. Hierfür kann z.B. eine SetPropertyAction verwendet werden. Die Service-Id ist als ActionProperty B3P_USED_SERVICE_ID zu setzen.
Message Context Eigenschaften (Erforderlich)
Die nachfolgenden Message Context Variablen müssen gesetzt sein, entweder am Service selbst oder an der aufrufenden Action.
| Property / Eigenschaften | Beschreibung | Werte |
|---|---|---|
| folder | Pfad zum Ordner, in dem die Datei abgelegt werden soll | Ordner-Pfad gemäß Betriebssystem |
Message Context Eigenschaften (Optional)
Die nachfolgenden Message Context Variablen können gesetzt sein, entweder am Service selbst oder an der aufrufenden Action (jeweils mit Nachrichtenkontext überschreiben aktiviert)
| Property / Eigenschaften | Beschreibung | Werte |
|---|---|---|
| B3P_FILE_NAME | Dateiname der Datei, die abgelegt werden soll. | Dateiname mit Dateityp |
| B3P_SKIP_FILEWRITING | Falls true gesetzt wird das Schreiben der Datei unterbunden | true / false |
| B3P_IGNORE_FOLDER | Wenn diese Property auf true gesetzt ist, dann kann man in der Message Context Variable B3B3P_FILE_NAME auch den gesamten Pfad (inkl. Ordner) angeben und die Variable folder ist nicht zu setzen.. | true / false |
| B3P_WRITE_SEVERAL_FILES | Wenn diese Property auf true gesetzt ist, wird im Dateinamen nach mehrern Pfaden gesucht (mit Semikolon getrennt) und in alle diese Pfade wird dann ein Duplikat der Nachricht geschrieben | true / false |
| B3P_FILE_NAMER_CLASS | Enthält den Klassennamen der Klasse, die den Dateinamen in FileWriterService bestimmt | Z.B. org.b2bbp.services.outbound.file.EcountFileNamer |
| USE_FILE_NAMER_ONLY_FOR_FOLDER | Bei benutzen B3P_FILE_NAMER_CLASS könnte man trotzdem definierte Property B3P_FILE_NAME einschalten | true / false |
Global Properties (Optional)
Wenn die Global Property org.b2bbp.services.outbound.file.FileWriterService.LOG_LEVEL auf den Wert 1 gesetzt ist, wird die abgelegte Datei in fachlichen Belegen und technischen Details angezeigt.