Aufrufparameter ISEprint

  • Drucken
Details
Kategorie: ISEprint – Drucksystem
Erstellt am Freitag, 20. Januar 2012 19:23
Zuletzt aktualisiert am Dienstag, 15. August 2023 08:28
Geschrieben von Joachim Braun
Inhaltsverzeichnis

 

1. Externe Parameter 

1.1. help

Zeigt die Hilfeseite an. Weitere Parameter werden ignoriert. Diese Seite kann auch im Programm über das Hilfemenü jederzeit angezeigt werden.

1.2. cmdfilename:“Dateiname“

Gibt den Namen der Parameterdatei an. Dieser sollte mit Anführungszeichen angegeben werden, um keine Problem mit möglichen Whitespaces zu haben.

Angaben innerhalb der Parameterdatei wie z. B. Dateinamen sollten ohne Anführungszeichen angegeben werden. Je Zeile darf nur ein Befehl angegeben werden.

Pflichtangabe

2. Globaler Abschnitt

2.1. splfilename:Dateiname

Name inkl. Pfad der SPL-Datei (Eingangsdatei im ISEspool-Format).

Die letzten 20 Zeichen der Parameterdatei enthalten eine enideutige Kennung, die von ISEprint wieder entfernt wird.

Der Name der Parameterdatei kann auch einen Zeitstempel enthalten, der durch ISEprint aufgelöst wird. Dieser Zeitstempel enthält Datum und Uhrzeit in umgekehrter Reihenfolge, damit er als Sortierkriterium verwendet werden kann. Außerdem wird der Zeitstempel entsprechend formatiert, um die Lesbarkeit zu erhöhen.

Beispiel:

VK-Rechnung 10245{%}20120125113245128000.SPL

wird zu

VK-Rechnung 10245 - (2012-201-25 - 11.32.45).SPL

Aus diesem Stammdateinamen wird der Name der Datei abgeleitet, die von Der Funktion "Speichern unter" verwendet wird.

Pflichtangabe

2.2. pcldrvfilename:Dateiname

Name inkl. Pfad einer PCL-Treiberdatei zur Ergänzung bzw. zum Umdefinieren interner PCL-Befehle.

Angabe optional

2.3. pcldrvclear

Löscht den integrierten PCL-Treiber. Dieser Befehl wird vor pcldrvfilename ausgeführt, falls angegeben.

Angabe optional.

2.4. pcldrvview

Zeigt den geladenen PCL-Treiber an. Wenn dieser optionale Befehl angegeben wird, muss die Parameterdatei vollständig und fehlerfrei angegeben sein. Diese Seite kann auch im Programm über das Hilfemenü jederzeit angezeigt werden.

Angabe optional.

outfiletype:Ausgabeformat

Ausgabe- bzw. zu verarbeitendes Format. Muss immer angegeben werden. Unterstützte Werte: PDF, TXT und CLR

PDF
PDF-Dokument

TXT
Textdokument – Es wird intern nur ein Minimaltreiber mit Befehlen für Zeilen- und Seitenschaltung und Leer- und Tabulatorzeichen geladen.

CLR
Clearing – Es wird ein leerer Treiber benutzt, der als einzigen Befehl Wagenrücklauf (CR = 0D) enthält.

Dieser Befehl wird vor "pcldrvfilename" ausgeführt, falls angegeben.

Pflichtangabe

2.5. archivefilename:Dateiname

Name inkl. Pfad einer optional zu erstellenden Ausgabedatei, welche i. d. R. zu Archivierungszwecken genutzt wird.

Der Pfad muss existieren und die Berechtigungen sollten das Erstellen, Beschreiben und Lesen der Datei zulassen.

Das optional anzugebende Muster {%} im Dateinamen wird durch den bereits beim Parameter "splfilename" beschriebenen Zeitstempel ersetzt.

Angabe optional.

2.6. archivetarget:filesystem;isedoc

Gibt die Archivierungsziele an.

Es gibt zwei mögliche Ziele:

filesystem
Die zu archivierende Datei wird im Dateisystem abgelegt.

isedoc
Die zu archivierende Datei wird in der Dokumentverwaltung ISEdoc abgelegt. Falls der Wert "filesystem" nicht angegeben wurde, wird die in "archivfilename" für die Archivierung angegebene Datei gelöscht.

Die einzelnen Werte müssen durch ein Semikolon getrennt sein. Deren Reihenfolge ist beliebig.

Angabe optional.

2.7. isedoc:ISEdoc-Parameterdatei

Parameterdatei für den Aufruf von ISEdoc

Wenn in "archivetarget" der Wert "isedoc" enthalten ist, muss dieser Parameter angegeben sein.

2.8. outblocktoarchive:Blocknummer

Gibt an, welches der drei möglichen zu erstellenden Dokumente zu archivieren ist.

Mögliche Werte: 1, 2, 3

Angabe optional

2.9. outblocktoview:Blocknummer

Gibt an, welches der drei möglichen zu erstellenden Dokumente anzuzeigen ist.

Wird dieser Parameter nicht angegeben, so wird der erste Block verwendet.

Mögliche Werte: 1, 2, 3

Angabe optional

2.10. outblocktoemail:Blocknummer

Gibt an, welches der drei möglichen zu erstellenden Dokumente über E-Mail versendet werden kann.

Wird dieser Parameter nicht angegeben, so wird der E-Mail-Versand deaktiviert.

Mögliche Werte: 1, 2, 3

Angabe optional

2.11. outblocktorawprint:Blocknummer

Wenn dieser Parameter angegeben wurde, enthält der entsprechende Ausgabeblock die notwendigen Daten, um einen Rohdruck zu realisieren. In diesem Fall wird keine PDF-Datei erstellt, sondern eine Druckerdetei, die für einen festgelegten Zieldrucker bestimmt ist.

Um das zu realisieren, wird das Ziel (Drucker oder Datei) im entsprechenden Parameter "prtname_n" und der Treiber für die Übersetzung in Druckerrohdaten im entsprechenden Parameter "pdfpar_n" übergeben.

Wenn der Parameter "prtname_n" einen gültigen Drucker enthält, wird die RAW-Datei an die entsprechende Windows-Warteschlange überegeben.

Enthält der Parameter dagegen einen Dateinamen, so erstellt ISEprint eine Datei mit dem übergebenden Dateinamen. Will man eine bereits erstellte RAW-Datei nicht überschreiben, so sollte der Dateiname den Platzhalter für Zeitstempel – {%} – enthalten. In diesem Fall werden auch Millisekunden für den Zeitstempel verwendet, um Kopien nicht zu überschreiben.

Ein so gekennzeichneter Block kann nicht angezeigt wohl aber archiviert werden.

Mögliche Werte: 1, 2, 3

Angabe optional

Anmerkung: Die Paketbefehle lauten:

<PaketRaw> Daten für den RAW-Drucker </PaketRaw>

<PaketNormal> Daten für normale Drucker </PaketNormal>

Ein Befehl kann sich über mehrere Zeilen erstrecken.

Es können mehrere Befehle in einer Zeile angegeben werden.

Es ist nicht erlaubt, Befehle zu verschachteln.

2.12. noprint

Unterbindet die Möglichkeit des Druckens. Das Dokument kann nur angezeigt werden.

Angabe optional

2.13. directprint

Gibt an, dass der Ausdruck direkt zu erfolgen hat. Es findet keine Bildschirmanzeige statt.

Angabe optional

 

2.14. saveaspath:Pfadname

Enthält einen Pfad für die Funktionen "Speichern" oder "Speichern unter", der als Vorschlag für die Speicherung des angezeigten Dokumentes verwendet wird. Fehlt dieser Parameter, so zeigen die Speicherfunktionen auf das verwendete temporäre Verzeichnis – i. d. R der der gleiche Ort, wo sich die SPL-Datei befindet.

Angabe optional

2.15. help2

Zeigt nach der Auswwertung der Parameterdatei alle Parameter mit ihren Werten an. Kann nur über die Parameterdatei übergeben werden. Diese Seite kann auch im Programm über das Hilfemenü jederzeit angezeigt werden.

Angabe optional

2.16. loglevel:Protokolltiefe (n = 1 oder 2)

Wenn dieser Parameter angegeben wird, erzeugt ISEprint eine Protokolldatei im temporären Verzeichnis des angemeldeten Benutzers. Der Name der Protokolldatei entspricht dem Namen der Parameterdatei, allerdings ist deren Dateierweiterung ".LOG".

Die Protokolldatei enthält im ersten Teil alle übergebenden Parameter ohne jegliche Änderung. Nach dem Verarbeiten der Parameterdatei werden alle Parameter erneut in die Protokolldatei geschrieben, um einen Vergleich mit den Übergebenden ziehen zu können.

Darüber hinaus werden die Ergebnisse anderer Programmstellen in diese Datei festgehalten, um eine eventuelle Fehlersuche zu erleichtern. Die Anzahl von Protokolleinträgen hängt von der übergebenden Protokolltiefe ab. Je größer die übergebnde Zahl, umso mehr Einträge werden in die Protokolldatei geschrieben.
 

3. Ausgabeabschnitte

Die Ausgabeabschnitte werden nicht extra gekennzeichnet. Die Parameter der jeweiligen Abschnitte geben an, zu welchem Abschnitt diese gehören. Dazu wird hinter dem Parametername die Abschnittsnummer, durch einen Unterstrich getrennt, angegeben.

3.1. prtname_n:Windows-Druckername oder Zielordner (n = 1, 2 oder 3)

Gibt entweder den Namen eines Windowsdruckers oder Ordners auf einem Datenträger an. Fehlt diese Angabe, so wird der jeweilige Ausgabeausschnitt deaktiviert. Das kann z. B. sinnvoll sein, wenn der jeweilige Ausgabeausschnitt lediglich für die Angabe von Anzeigeparametern (siehe pdfpar_x) verwendet werden soll.

ISEprint überprüft, ob diese Angabe sich auf einen Drucker oder einen Ort auf einem Datenträger handelt. Falls es sich um einen Drucker handelt, sendet ISEprint beim Drucken die Daten zum angegebenen Drucker. Ansonsten kopiert ISEprint die Daten in den angegebenen Ordner.

Ist einer der Blöcke durch die Angabe von "outblocktorawprint" für den Rohdruck vorgesehen, so enthält dieser Parameter entweder einen Druckernamen (lokalen Windowsdrucker oder Druckerfreigabe) oder gar einen Dateinamen.

Angabe optional

3.2. prtcopies_n:Kopienanzahl (n = 1, 2 oder 3)

Gibt die Anzahl von Kopien an. Hat nur eine Auswirkung, wenn auch prtname_x angegeben wurde. Ansonsten wird diese Angabe ignoriert.

Standardwert: 0

Angabe optional

3.3. pdfpar_n:PDF-Parameter (n = 1, 2 oder 3)

Parameter für den internen PDF-Konverter und die Druckengine (Adobe bzw. Sumatra).

PDF-Konverter

Ist einer der Blöcke durch die Angabe von "outblocktorawprint" für den Rohdruck vorgesehen, so enthält dieser Parameter den vollständigen Dateinamen zu einer Treiberdatei, die für die Übersetzung in das Rohformat des Zieldruckers zu verwenden ist. Fehlt dieser Parameter oder er ist leer, so wird ein leerer Treiber verwendet.

Druckengine

Wir "missbrauchen" diesen Parameter für die Übermittlung zusätzlicher Anweisungen an die Druckengine. So kann Sumatra mitgeteilt werden, das Papier aus dem zweiten Fach zu ziehen.

Nur der Befehl "-print-settings" wird unterstützt (siehe Sumatra-Beschreibung). Beachten Sie hierbei, dass das Argument für die Kopienanzahl nicht verwendet werden darf – dieser muss immer von der Anwendung (ISEntial) mit übergeben werden.

Die Übermittlung dieser Anweisungen werden eingeschlossen in einem Block vorgenommen:

Sumatra

[S]eine oder mehrere Anweisungen[/S]

Beispiel:

[S]-print-settings "1-3,5,8-10,odd,fit,bin=2"[/S]

Druckt die Seiten 1, 3, 5, 9 (d. h. die ungeraden Seiten aus den Bereichen 1-3, 5-5 und 8-10) und skaliert sie so, dass sie in den bedruckbaren Bereich des Papiers passen.

Adobe (wird noch nicht unterstützt)

[A]eine oder mehrere Anweisungen[/A]

Angabe optional
 

4. E-Mail-Versand

Der E-Mail-Versand kann nicht vom Anwender beeinflusst werden. Wird ISEprint z. B. SMTP als Übertragungsweg übermittelt, kann der Anwender nicht einen anderen Übertragungsweg wie z. B. "Exchange Web Services", MAPI oder Outlook-Fernsteuerung auswählen.

4.1. email_tp:Transferprotokoll

Gibt den das Transferprotokoll an. Fehlt diese Angabe oder der angegebene Parameter ist falsch, ist der E-Mail-Versand deaktiviert. Folgende Werte sind erlaubt:

SMTP
Simple Mail Transfer Protocol

EWS
Exchange Web Services

OL
Outlook-Fernsteuerung

MAPI
Messaging Application Programming Interface

Pflichtangabe

4.2. email_dbcs:Datenbankverbindungszeichenkette

Enthält die notwendigen Angaben, um eine E-Mail über das angegebene Transferprotokoll versenden zu können.

Angabe optional. Wenn angegeben, dann muss auch der Parameter email_dbcommid einen gültigen Wert besitzen.

4.3. email_dbcommid:Kommunikations-ID für Zugriff in Datenbank

Eindeutige ID je E-Mail für die Speicherung in der Datenbank. Wird von ISEntial erzeugt und mit der laufenden Nummer "1" in der Datenbank abgelegt. Weitere von ISEprint erzeugte Einträge behalten die ID bei, erhöhen jedoch die laufende Nummer je Vorgang um eins.

Angabe optional. Wenn angegeben, dann muss auch der Parameter email_dbcs einen gültigen Wert besitzen.

4.4. email_dbnowriteprot

Dieser Parameter schaltet die Protokollierung in der Datenbank ab, sofern er angegeben wird.

Angabe optional

4.5. email_cs:Verbindungszeichenkette

Enthält die notwendigen Angaben, um eine E-Mail über das angegebene Transferprotokoll versenden zu können.

Pflichtangabe

4.6. email_from:Absender

Bezeichnet den Absender der E-Mail.

Pflichtangabe

4.7. email_to:Empfänger

Eine oder mehrere durch Semikolon getrennte E-Mail-Adressen, an die die E-Mail primär gesendet wird. Jedem Adressaten werden auch alle anderen E-Mail-Adressen mitgeteilt.

Pflichtangabe

4.8. email_cc:Weitere Empfänger

Eine oder mehrere durch Semikolon getrennte E-Mail-Adressen, an die eine Kopie der E-Mail gesendet wird. Beim Schreiben einer E-Mail wird dieses Feld verwendet, um Kopien an einen oder mehrere Empfänger zu senden. Mit einem Eintrag in diesem Feld wird gleichzeitig symbolisiert, dass diese E-Mail sich nicht direkt an diesen Benutzer wendet, sondern lediglich "zur Beachtung" bzw. "zur Kenntnisnahme" an ihn versendet wurde. Die Einträge im CC-Feld werden (im Gegensatz zum BCC-Feld) bei allen Empfängern angezeigt und sind somit bekannt.

Angabe optional

4.9. email_bcc:Empfänger der Blindkopie

Die Empfänger von E-Mails an eine oder mehrere durch Semikolon getrennte E-Mail-Adressen, die im so genannten BCC-Feld (von englisch: Blind Carbon Copy, dt. sinngemäß Blindkopie) aufgeführt wurden, erhalten eine Kopie der jeweils gesendeten E-Mail, ohne dass ihre Adresse für die anderen angegebenen Empfänger sichtbar wird. Durch die Adressierung im BCC kann die Privatsphäre der Empfänger von Rund-Mails gewahrt und sie z. B. vor der Adressen-Sammlung von bösartigen Diensten wie z. B. Spambots geschützt werden.

Angabe optional

4.10. email_sendnotify:Empfänger der Lesebestätigung

E-Mail-Adresse für den Empfang einer Lesebestätigung. Fehlt diese Angabe oder sie ist leer, so wird keine Lesebestätigung angefordert.

Angabe optional

4.11. email_replyto:Antwortadresse

Eine oder mehrere durch Semikolon getrennte E-Mail-Adressen, an die eine Antwort auf die E-Mail geschickt werden soll (falls unterschiedlich zum From-Feld).

Angabe optional

4.12. email_subject:Betreff

Der Betreff stellt eine Beziehung des Senders und/oder des Empfängers zu einer Sache, erforderlichen Aktion oder zu einem Ereignis her. Es ist für den Empfänger eine wichtige Kurzinformation über den Inhalt der Mail und sollte daher nicht fehlen. In Anbetracht der steigenden Anzahl unerwünschter E-Mails wächst die Bedeutung des Betreff-Felds, denn oft lassen sich unerwünschte Nachrichten bereits am Betreff erkennen.

Fehlt dieser, erzeugt ISEprint automatisch einen Standardbetreff.

Angabe optional

4.13. email_header:Headertext

Der übergebene Text wird unverändert in den Header-Bereich der E-Mail eingefügt. Der Text kann mehrzeilig sein.

Anwendungsbeispiel:

email_header:X-ISENTIAL-HEADER: Einkauf

Angabe optional

4.14. email_body:Nachrichtentext

Nachrichtentext. Fehlt dieser, erzeugt ISEprint automatisch einen Standardtext.

Jede auszugebende Zeile im Nachrichtentext muss mit dieser Anweisung eingeleitet werden. Somit können auch umfangreichere Texte mit übergeben werden.

Sollen führende Leerzeilen (bevor es überhaupt ein Text ausgegeben wird) ausgegeben werden, so müssen diese ein Leerzeichen enthalten. Ansonsten werden diese unterdrückt.

E-Mails können mit HTML-Tags formatiert werden. Verschickt werden automatisch eine HTML- und eine Textversion.

Lokal einzubettende Bilder müssen wie folgt formatiert werden:

<img src='cid:Pfad_zur_Bilddatei/Bilddatei'/>

Beispiele:

<img src='cid:C:/Bilder/Image1.png'/>

<img src='cid://SERVER/Bilder/Image1.jpg'/>

Einfache Apostrophe und cid: sind zwingend notwendig. Ansonsten können auch https-Referenzen verwendet werden:

<img src='https://example.com/Image1.png'/>

Angabe optional

4.15. email_attachment:Dateianlage

Gibt den vollständigen Pfad einer Dateianlage an. UNC-Namen sind erlaubt. Die Angabe einer Dateianlage erfolgt ohne Anführungszeichen, auch wenn der Pfad Leerzeichen enthält.

Es können beliebig viele Dateianlagen angegeben werden. Jede Dateianlage muss mit dieser Anweisung eingeleitet werden.

Anlage löschen '|'
Ist das erste Zeichen im Dateinamen oder Pfad einer Anlage ein senkrechter Strich ('|'), so wird die Anlage nach Programmende gelöscht.

PDF-Anlagen zusammenführen '<'
Erscheint als erstes Zeichen im Dateinamen oder Pfad einer PDF-Anlage das Zeichen '<', so wird diese Anlage mit der vorherigen zusammengeführt. Falls die Anlage zum Löschen vorgesehen ist (wie im vorherigen Abschnitt beschrieben) und das Löschzeichen '|' trägt, sollte das Zeichen '<' an zweiter Stelle im Dateinamen oder Pfad stehen.

Angabe optional

4.16. email_namemaindoc:Alternativer Dateiname des Hauptdokumentes der Anlage

Alternativer Name des Hauptdokumentes. Ersetzt den Standardnamen des PDF-Hauptdokumentes. Werden mehrere Dateinamen angegeben, so wird das Hauptdokument mehrfach unter den angegebenen Namen als Dateianlage der E-Mail beigefügt.

Wenn nichts angegeben wird, was der Normalfall sein dürfte, wird der Name des PDF-Hauptdokumentes nicht ersetzt. Werden dagegen mehrere Namen angegeben, so sind diese analog zum Befehl "email_attachment" voneinander zu trennen.

Angabe optional