PrintCustomResponse
Gruppe |
|
Funktion |
Die Klasse ermöglicht das Drucken von Dateien. |
Konfigurationsdatei |
./conf/samples/print.properties |
Diese Klasse ist veraltet (deprecated).
Sie sollte deshalb nicht mehr für Neuentwicklungen verwendet werden. Sie wird aber weiterhin für bestehende Prozesse funktionieren.
Für Neuentwicklungen prüfen Sie bitte, ob Ihre Drucker den Empfang über Protokolle wie FTP unterstützt oder die Daten anderweitig empfangen kann. Alternativ kann ein Drucker auch über die Kommandozeile mit Hilfe der Klasse SystemCallResponse angesprochen werden. Sollte dies alles nicht möglich sein, kann die Klasse durch Eingabe des vollen Klassenpfades (com.ebd.hub.datawizard.util.PrintCustomResponse) oder durch Deaktivierung der Option DisableDeprecatedClasses in der Konfigurationsdatei ./etc/startup.xml weiterhin verwendet werden. Es kann in diesem Fall aber keine Unterstützung mehr durch den Support erfolgen.
Beschreibung
Die Klasse ermöglicht das Drucken von Dateien in dem Format, das im Parameter data gewählt wird (pdf, postscript, usw. nur, wenn der konfigurierte Drucker das Drucken des gewählten Formats auch unterstützt). Wichtiger Hinweis: Diese Klasse ist nur für lokale Drucker gedacht (Drucker installiert auf Integration-Server-Rechner) und nicht für Netzwerkdrucker!
Hinweis: Die PDF-Datei kann entweder durch eine Integration Unit erzeugt werden oder sie wird als Inhaltstyp wie empfangen erwartet. Wenn ein Encoding ausgewählt werden muss, sollte raw data gewählt werden, weil es sich um Binärdaten handelt.
Hinweis: Wenn die Trace-Meldungen für Phase 6 eines Profil, das diese Klasse benutzt, aktiviert ist, dann werde alle Drucker, die für Lobster Integration sichtbar sind, in das Detail-Log eines Jobs geschrieben.
Parameterbeschreibung
Als Parameter kann entweder eine Konfigurationsdatei angeben werden oder es können die Default-Parameter überschrieben werden. Dabei werden die zusätzlichen Parameter als Key-Value-Paare mit einem Semikolon (;) getrennt angegeben. Ist ein Parameter nicht vorhanden, wird der Default-Wert verwendet.
Parametername |
Default-Wert |
Beschreibung |
color |
false |
Farbe. Erlaubte Werte sind true und false. |
copies |
1 |
Anzahl der Kopien (1…9999). |
data |
|
Drucktyp. Erlaubte Werte sind plain-text, pdf, pcl, postscript, gif, jpeg und png. |
duplex |
false |
Duplex-Unterstützung (beidseitiges Drucken). Erlaubte Werte sind true und false. |
errorcsv |
|
Relativer Pfad zu einer zusätzlichen Fehler-Datei im CSV-Format, in die bei Druckerfehler ein Eintrag geschrieben wird, wenn der Pfad mit ./ beginnt und wenn das Elternverzeichnis existiert. |
logtimes |
false |
Erweitertes Logging zum Zeitverbrauch. Zusätzlich ist Log-Konfiguration Trace Meldungen in Phase 6 erforderlich. |
mediasize |
A4 |
Seitenformat. Erlaubte Werte sind A0…A5, B4, B5, B6 und Letter. |
mediatray |
main |
Einzugsschacht. Erlaubte Werte sind top, bottom, middle, envelope und main. |
moveHorizontal |
0 |
Mit dieser Option kann das Dokument auf dem Drucker in der Horizontalen verschoben werden. Die Angaben sind in Pixel als Ganzzahl zu machen, negative Werte sind möglich. Beispiel: Mit moveHorizontal=150 wird das Dokument um 150 Pixel nach Rechts verschoben. |
orientation |
portrait |
Ausrichtung. Erlaubte Werte sind portrait und landscape. |
pdfemulate |
|
(true oder false) Bei true und data=pdf wird eine experimentelle Zusatzfunktion verwendet, mit der PDF-Dokumente als Graphik gerendert werden. Diese Option ist dazu gedacht, PDF-Dateien, die vom selben Lobster Integration erzeugt wurden (es werden insbesondere nur die Schriftarten unterstützt, die in dieser Java-Runtime verfügbar sind), auf einem einfachen (preiswerten), nicht-PDF-fähigen Drucker auszudrucken. Wichtiger Hinweis: Bei true fallen bei enthaltenen Grafiken im PDF eine hohe Rechenleistung und entsprechend lange Verarbeitungszeit an (für die Umwandlung der PDF-Grafiken in die für den Printer-Spooler erforderlichen Grafiken). |
printer |
|
Name des Druckers, der aufgerufen werden soll. Der Default-Drucker des Systems kann mit dem Wert §default§ definiert werden. Ist die System-Property hub.datawizard.emptyPrintnameException auf false, dann führt ein nicht gesetzter Wert bei printer dazu, dass kein Fehler geworfen wird, aber es wird auch nicht gedruckt. Ist die System-Property auf true, dann bewirkt ein leerer Wert für printer einen Fehler. |
quality |
normal |
Druckqualität. Erlaubte Werte sind draft, normal und high. |
scale |
100 |
Mit dieser Option kann das Dokument skaliert werden. Mögliche Werte: 10-200. Beispiel: scale=50 verkleinert das Dokument auf 50%. |
Beispiel
#
# sample file for print response
#
# Supported keys are: quality, copies, mediasize, orientation, mediatray, color, printer, data
#
# quality = draft | normal | high
# default is normal
#
# copies = 1...9999
# default is 1
#
# mediasize = A0...A5, B4, B5, B6, Letter
# default is A4
#
# orientation = portrait | landscape
# default is portrait
#
# mediatray = top | bottom | middle | envelope | main
# default is main
#
# color = true | false
# default is false
#
# printer = name of printer to use
#
# data = plain-text | pdf | pcl | postscript | gif | jpeg | png
Eintrag in Fehler-Datei errorcsv
Zur individuellen Behandlung von Drucker-Problemen kann man im Fehlerfall einen Eintrag in eine CSV-Datei schreiben lassen, die beispielsweise durch ein anderes Profil abgeholt und verarbeitet wird. Pro Fehler-Job entsteht ein Eintrag mit einer festen CSV-Struktur, wie nachfolgend beschrieben. Dazu muss die Property errorcsv den relativen Pfad zu dieser Datei enthalten, der mit ./ beginnen muss. Das Elternverzeichnis muss existieren. Wenn die Datei nicht existiert, wird sie erzeugt. Wenn sie bereits existiert, wird der neue Eintrag als CSV-Zeile angehängt. Wenn der Eintrag geschrieben werden konnte und zusätzlich in der Log-Konfiguration für Phase 6 die Option Custom aktiviert ist, wird in das Job-Log eine Meldung eingefügt, die den Dateipfad der errorcsv-Datei enthält.
Format der CSV-Zeile der Datei errorcsv
"printerName", "timestamp", "JobNr", "PosOfResponse", "[messageList]", "Exception", "ProfileName" |
Hinweis: Alle tatsächlichen Feldwerte werden, wie oben gezeigt, mit doppelten Anführungszeichen ausgegeben.
Durch Auswertung dieser Datei in einem anderen Profil ist eine individuelle Benachrichtigung der Druckerverantwortlichen und gegebenenfalls eine automatische Suspendierung der Jobs bei Unverfügbarkeit oder Fehler in einem Printer möglich. Das entsprechende Auswertungsprofil muss vom Anwender selbst entwickelt werden.
Hinweis: Wenn diese Datei erzeugt wird, sollte sie auch von einem Profil verarbeitet und gelöscht werden, weil sonst auf Dauer die Datei ständig anwächst.