iPaper verfügt über die Möglichkeit die Einstellungen der Software und aller Funktionen von außen per XML Kommandos zu steuern und zu beeinflussen. Das betrifft auch die Grund-Einstellungen beim Start von iPaper. Zusätzlich ist es damit auch möglich die Grundsettings dynamisch während der Verarbeitung der einzelnen PDF Dateien zu übersteuern. Dies kann entweder über eine extern zur Verfügung gestellte XML Datei erfolgen oder aber die XML Information wird "mitgedruckt", vor der Verarbeitung im Dokument gesucht, extrahiert und für die Steuerung der Weiterverarbeitung herangezogen. Nach dem Extrahieren der XML Information aus dem PDF lassen sich die Seiten auf welchen sich die XML Information befunden hat aus dem Ergebnisdokument entfernen und löschen.

Über Steuerbefehle können sowohl die gewünschten Verarbeitungsschritte (Aktionen) für die Weiterverarbeitung der PDF Datei gesteuert, Voreinstellungen getroffen aber auch Elemente und Funktionen des User Interfaces deaktiviert werden.

iPaper.xml

iPaper Voreinstellungen konfigurieren und verteilen

Alle Einstellungen der iPaper Anwendung sind in der Datei iPaper.xml im Standard Pfad "C:\Users\%user%\AppData\Roaming\iPaper.NET\iPaper.xml" hinterlegt - werden von dort gelesen und beim Beenden der Anwendung geschrieben.

Wird sie dort nicht gefunden dann wird:

1. Geprüft ob eine iPaper.xml im iPaper Installations-Ordner vorhanden ist

  • Falls sie dort gefunden wird, so wird sie automatisch in den Standard Pfad kopiert
  • Falls sie im Installations-Ordner nicht gefunden werden kann, dann wird 2. ausgeführt

2. Es wird geprüft ob die iPaper.xml Datei im ProgramData Verzeichnis "C:\ProgramData\iPaper.NET\iPaper.xml" vorhanden ist

  • Falls sie dort gefunden wird, so wird sie automatisch in den Standard Pfad kopiert
  • Falls die Datei dort nicht gefunden wird, so wird eine iPaper.xml Datei mit vorgegebenen (fix kodierten) Standard Einstellungen erzeugt und im Standardpfad abgespeichert.

Um Standard Einstellungen vorzugeben empfehlen wir die Variante 2.

In der iPaper.xml können absolute Pfadangaben oder System-Variablen (%APPDATA%, %PROGRAMDATA% oder %HOMEPATH%) verwendet werden. Damit lassen sich allgemeine Voreinstellungen und Aktionen erzeugen, welche universell für alle Anwender verwendbar sind.

Beachtet werden muss, dass die iPaper.xml immer beim Beenden von iPaper geschrieben / überschrieben wird. Man muss also, bevor man diese ersetzen möchte, die Anwendung beenden, sonst wird die Datei beim Beenden von iPaper wieder mit den letzten Werten aus dem User-Interface überschrieben.

Demo Briefpapiere nicht automatisch einfügen

Bei der erstmaligen Installation von iPaper werden einige Demo Briefpapiere in den Vorlagen Ordner kopiert. Nachdem diese Dateien kopiert wurden, wird das Flag "copydefstat" in der iPaper.XML Datei auf "True" gesetzt.

<copydefstat Type="System.Boolean" Value="True" />

Ist das Flag gesetzt, werden die Demo Briefpapiere nicht kopiert - auch wenn ein neuer Ordner ausgewählt wird, der noch keine Demo Briefpapiere enthält. Wird iPaper mit einer individuellen Konfigurationsdatei per Commandline (/configfile=... und /configreadonly=1) gestartet, dann kann es sehr wohl wieder vorkommen, dass die Demo Vorlagen nochmals kopiert und immer wieder eingefügt werden, da iPaper nicht in der Lage ist die Config Datei zu überschreiben und das Statusflag "copydefstat" bleibt auf "False".

Ebenso kann es vorkommen, dass eine individuelle iPaper.XML Config Datei verwendet wird, bei der das Flag "copydefstat" fehlt und die Datei nur die Definition eines anderen Briefpapier Ordners enthält. Fehlt der "copydefstat" Parameter, so wird als Default "False" angenommen und die Demo Vorlagen werden kopiert.

Batch Datei

Eine iPaper.NET Batch Datei ist ein XML Dokument, welches ein oder mehrere Aktions Gruppen beinhaltet. Jede Aktions Gruppe beinhaltet eine Liste von Aktionen, die auf eine Datei angewandt werden sollen. Die XML Dokumenten Spezifikation (z.B. <?xml version="1.0" encoding="utf-8" ?>) kann auch vor dem <batch> Element geschrieben werden. Ein <action> Element sollte zumindest den Typ der Aktion und alle anderen erforderlichen Parameter der Aktion enthalten. iPaper.NET implementiert die folgenden Standard Aktionen: stationery (Briefpapier), email, saveas, autoprint und run. Eine Batch Datei kann einen settings Bereich enthalten, der nur vom iPaper.NET Client verwendet wird.

Der settings Bereich hat folgende Eigenschaften:

deleteactionpagestrue oder false
autopreviewtrue oder false
askoptionstrue oder false
display-statustrue oder false
allowaddremovetrue oder false
allowchangeordertrue oder false
allowimporttrue oder false
disable-advancedtrue oder false
pdfa-level0 - deaktiviert
1 - PDF/A-1b
3 - PDF/A-3b
pdfa-convert-imagetrue oder false (konvertiert das Dokument in ein PDF Image, falls die Konvertierung fehlschlägt)
pdfa-conver-image-res150, 200, 300 (Renderauflösung)
pdfa-zugferdtrue oder false
pdfa-zugferd-filePfad der ZUGFeRD XML Datei, falls nicht existent wird der Datei Dialog angezeigt um eine valide Datei zu wählen
pdfa-zugferd-deletetrue oder false (löscht die ZUGFeRD XML Datei nach der Bearbeitung

Stationery Aktion (Briefpapier)

Die stationery Aktion hinterlegt das PDF Dokument mit einem Briefpapier.
Es gibt keine Variablen, die in der stationery Aktion verwendet werden können.

Das stationery Element hat folgende Eigenschaften:

nameName des Briefpapiers oder custom
sub-typecolor, bw und logo
filepath

Der vollständige Pfad der Briefpapier Datei (nur erforderlich, falls der Briefpapiername custom ist

opacityEin Integer Wert zwischen 0-100. 100(%) bedeutet undurchsichtig, 0(%) bedeutet vollständig transparent (nur notwendig falls der Briefpapiername custom ist)
offsetx, halignHorizontaler Offset und Ausrichtung
offsety, valignVertikaler Offset und Ausrichtung
usesecondEin boolescher Wert der angibt, ob die zweite Seite des Briefpapiers für alle Seiten, ab der zweiten, des Zieldokuments, verwendet werden soll
overlayEin boolescher Wert, der festlegt ob das Zieldokument mit dem Briefpapier überlagert werden soll

Benutzer Interface deaktivieren

Folgende Optionen können für das iPaper.NET Client Benutzerinterface deaktiviert werden (sieh disable-options Bereich in der XML):

formDie Einstellungen für die Briefpapierauswahl
use2ndpageDie Option für die Verwendung der zweiten Seite der Briefpapierdatei
overlayDie Option für die Überlagerung
positionPositionierungs Einstellungen
printer-marginsRänder Einstellungen für den Druck
differentorientationOption "Briefpapier nicht anwenden - bei Seiten mit anderer Ausrichtung"
pagerangeEinstellungen für den Seitenbereich

E-Mail Aktion (SMTP)

Die email Aktion versendet das Dokument als Anhang per E-Mail. Die email Aktion ermöglicht es, alle Eigenschaften einer E-Mail Nachricht zu definieren, z.B.: eine Liste von Empfängern, Betreff, Inhalt, Signatur, eine Liste von Anhängen und SMTP Server Einstellungen.

Betreff

Das subject Element kann Fixtext oder auch Variablen enthalten.

Empfänger Sammlung (recipients)

Die Empfänger sollte zumindest einen Empfänger (recipient) des Typs "to" enthalten.

Das recipient Element hat folgende Eigenschaften:

typeDer Empfänger Typ kann "from", "to", "cc" und "bcc" sein
displaynameDer Anzeigename des Empfängers (ist kein Anzeigename angegeben, wird die E-Mail Adresse als Anzeigename verwendet)
addressDie E-Mail Adresse des Empfängers

Inhalt und Signatur

Das body (Inhalt) Element hat folgende Eigenschaften:

formatEntweder "html" oder "text"
templateDer Inhalt der Nachricht, kann Fixtext und Variablen enthalten

Das signature Element hat folgende Eigenschaften:

enabled"true" oder "fase"
format"html" oder "text"
encoding"UTF8" oder "ASCII"
templateDer Inhalt der Signatur, kann Fixtext und Variablen enthalten

Der endgültige E-Mail Nachrichtentyp (Text oder HMTL) wird basierend auf dem body und signature Bereich festgelegt. Wenn eines dieser Elemente das Format "html" hat, ist das endgültige Format des Textes HTML, andernfalls wird der Text als Klartext angezeigt.

Attachments Sammlung

Die attachments Sammlung sollte zumindest ein attachment beinhalten. Der Dateipfad des Anhangs sollte auf die Variable %FILE% festgelegt werden. Die Variable %FILE% gibt den Dateipfad des Dokuments an, der vom aktuellen Batch / Aktion verarbeitet wird.

Das attachment Element hat folgende Eigenschaften:

displaynameDer Anzeigename des Dateianhangs
filepathVollständiger Pfad des Dateianhangs oder %FILE%

Variablen

Die email Aktionsspezifikation ermöglicht es eine Liste von Variablen zu definieren, die im Betreff, im Text und in der Signatur der E-Mail verwendet werden können. Die Variablen Sammlung kann eine oder mehrere Variablen enthalten.

Ein variable Element hat folgende Eigenschaften:

name

Name der Variable (ohne das %-Zeichen), auf solch eine Variable kann (wo zulässig) verwiesen werden, indem der Name zwischen %-Zeichen eingeschlossen wird

valueWert der Variable

Es gibt auch eingebaute Variablen, die verwendet werden können:

%WSNAME%Name der Arbeitsstation
%NTUSER%Aktueller Benutzer
%DATE%Aktuelles Datum
%TIME%Aktuelle Zeit
%ATT_DISPLAY[n]%Der Anzeigename des Attachments an der Position [n] (z.B.: %ATT_DISPLAY1%, %ATT_DISPLAY2%, ...)
%ATT_PATH[n]%Pfad des Attachments an der Position [n] (z.B.: %ATT_PATH1%, %ATT_PATH2%, ...)
%RECIP_DISPLAY[n]%Anzeigename des Empfängers an der Position [n] (z.B.: %RECIP_DISPLAY1%, %RECIP_DISPLAY2%, ...)
%RECIP_ADDR[n]%E-Mail Adresse des Empfängers an der Position [n] (z.B.: %RECIP_ADDR1%, %RECIP_ADDR2%, ...)
%FILENAME%Name der aktuell bearbeiteten Datei ohne Dateiendung
%FILEEXT%Dateiendung der aktuell bearbeiteten Datei
%FILE%Vollständiger Pfad der aktuell bearbeiteten Datei

Folgende Optionen können im iPaper.NET Client Benutzer Interface deaktiviert werden (sieh disable-options Bereich in der XML):

from, to, cc, bccDie E-Mail Adressfelder "From", "To", "Cc" und "Bcc"
subjectBetreff Feld
bodyDas Body (Inhalt) Feld
signatureSignatur Einstellungen
attachmentAttachment (Anhang) Einstellungen
email-settingsE-Mail Einstellungen

SaveAs Aktion (Speichern Unter)

Die saveas Aktion speichert die verarbeitete Datei in einen Ordner.

Die saveas Aktion hat folgende Eigenschaften:

folderPfad für den Ziel-Ordner (kann auch Variablen enthalten)
filenameZiel-Dateiname (kann auch Variablen enthalten)
overwritetrue oder false

Folgende Optionen können im iPaper.NET Client Benutzer Interface deaktiviert werden (sieh disable-options Bereich in der XML):

fileDer vollständige Pfad der ausführbaren Datei, der sowohl Variablen als auch Umgebungsvariablen enthalten kann
shellexectrue oder false, weist den Batch an, die shellexecute Methode des Betriebssystems, der externen ausführbaren Datei zu verwenden
commandlineDie CommandLine, die an die externe ausführbare Datei weitergegeben werden soll (kann auch Variablen enthalten)
waittrue oder false, ein boolescher Wert, der angibt ob der Batch auf die ausführbare Datei warten soll
timeoutDas Timeout in Sekunden (dieser Parameter wirkt nur wenn wait auf true gesetzt ist)

Folgende Optionen können im iPaper.NET Client Benutzer Interface deaktiviert werden (sieh disable-options Bereich in der XML):

exe-fileDie Steuerelemente für die Auswahl ausführbarer Dateien
command-lineCommandLine Steuerelemente
wait

Die "Warte" Option

shell-execute

Die "shell execute" Option

timeoutDie Timeout Steuerelemente

Metadata Aktion

Die metadata Aktion wendet PDF Dokument Metadaten auf das Ausgabedokument an.

Die metadata Aktion hat folgende Eigenschaften:

enabledtrue oder false
displaynameAnzeigename der Aktion
meta-titleDas "Titel" Feld der Metadaten des PDF Dokuments
meta-subjectDas "Thema" Feld der Metadaten des PDF Dokuments
meta-authorDas "Verfasser" Feld der Metadaten des PDF Dokuments
meta-keywordsDas "Stichwörter" Feld der Metadaten des PDF Dokuments
meta-keeptrue oder false, ein boolescher Wert, der festlegt ob die originalen Metadaten erhalten werden sollen

Folgende Optionen können im iPaper.NET Client Benutzer Interface deaktiviert werden (sieh disable-options Bereich in der XML):

titleTitel
subjectLabel, Textbox, Variablenauswahl
authorLabel, Textbox, Variablenauswahl
keywordsLabel, Textbox, Variablenauswahl
keep-metadataDie "Vorhandene PDF Profil-Informationen erhalten" Checkbox

Folgende Variablen können verwendet werden:

%ORIG_TITLE%Das "Titel" Feld des Original Dokuments
%ORIG_SUBJECT%Das "Thema" Feld des Original Dokuments
%ORIG_AUTHOR%Das "Verfasser" Feld des Original Dokuments
%ORIG_KEYWORDS%Das "Stichwörter" Feld des Original Dokuments
%DATE%Aktuelles Datum (yyyyMMdd)
%TIME%Aktuelle Zeit (HHmmss)
%WSNAME%Name der Arbeitsstation
%NTUSER%Name des angemeldeten Windows Benutzers
%FILENAME%Name des verarbeiteten Dokuments

Security Aktion (Schutz)

Die security Aktion schützt das PDF Dokument.

Die security Aktion hat folgende Eigenschaften:

typesecurity
enabledtrue oder false
displaynameAnzeigename der Aktion
enable-open-passwordtrue oder false
open-passwordDas zum Öffnen des Dokuments erforderliche Passwort; Wenn dieser Parameter nicht angegeben oder eine leere Zeichenfolge ist, wird enable-open-password automatisch auf false gesetzt
enable-perm-passwordtrue oder false
perm-passwordDas Passwort, mit dem die Sicherheitseinstellungen des Dokuments geändert werden können; Wenn dieser Parameter nicht angegeben oder eine leere Zeichenfolge ist, wird das enable-perm-password automatisch auf false gesetzt; Wenn das Berechtigungspasswort nicht festgelegt ist werden die folgenden Einstellungen ignoriert
printing-allowed0 - Kein Drucken erlaubt
1 - Nur niedrige Auflösung
2 - Drucken erlaubt
changes-allowed

0 - Keine Änderungen erlaubt
1 - Einfügen, Löschen und Seiten drehen erlaubt
2 - Formularfelder ausfüllen und Signieren erlaubt
3 - Kommentieren, Formularfelder ausfüllen und Signieren erlaubt
4 - Alles außer Seiten entnehmen erlaubt

copy-allowed0 - Kopieren nicht erlaubt
1 - Für Zugänglichkeit Inhalt kopieren erlaubt (Screen-Readers, etc.)
2 - Vollständig erlaubt

Einstellungen und Funktionen der iPaper.xml deaktivieren

Die Anwendung ermöglicht das Deaktivieren von Einstellungen und Funktionen der iPaper Benutzeroberfläche, mithilfe der iPaper.xml Konfigurationsdatei.

Die folgenden Einstellungen und Funktionen können im options Bereich, der iPaper.xml Konfigurationsdatei deaktiviert werden:

Deaktivieren der Befehle des Aktionslisten Editors

allowaddremovetrue oder false; wenn false gewählt ist, werden die "Neue Aktion..." und "Gewählte Aktion entfernen" Buttons deaktiviert
allowchangeordertrue oder false; wenn false gewählt ist, werden die "Hinauf" und "Hinunter" Kommandos deaktiviert
allowimporttrue oder false; wenn false gewählt ist, wird der "Import" Button deaktiviert

Ausblenden der Aktion und Allgemeine Einstellungen Seite im Konfigurationsfenster des iPaper.NET Client

hide-actions-tabtrue oder false; wenn true gewählt ist, zeigt die Anwendung den Aktionslisten Editor nicht an (Tab "Aktionen")
hide-general-tabtrue oder false; wenn true gewählt ist, wird die Seite "Allgemeine Einstellungen" im Konfigurationsfenster des iPaper.NET Clients ausgeblendet
hide-dropzone-tabtrue oder false; wenn true gewählt ist, wird die Seite "DropZone Ordner" im Konfigurationsfenster des iPaper.NET Clients ausgeblendet

Briefpapier Einstellungen deaktivieren

disable-formtrue oder false; wenn true gewählt ist, wird die Briefpapier Auswahl deaktiviert
disable-2ndpagetrue oder false; wenn true gewählt ist, wird die Option "Wiederhole die letzten x Seiten des Briefpapiers für die Folgeseiten" deaktiviert
disable-overlaytrue oder false; wenn true gewählt ist, wird die Option "Überlagern" deaktiviert
disable-statfoldertrue oder false; wenn true gewählt ist, kann der Briefpapier Ordner nicht vom Benutzer geändert werden
disable-newstattrue oder false; wenn true gewählt ist, wird der "Neu..." Button deaktiviert und der Benutzer ist nicht in der Lage neues Briefpapier hinzuzufügen
disable-autorefrtrue oder false; wenn true gewählt ist, wird das Kommando "Automatische Aktualisierung" deaktiviert
disable-differentorientationtrue oder false; wenn true gewählt ist, wird die Option "Briefpapier nicht anwenden - bei Seiten mit anderer Ausrichtung" deaktiviert
disable-attnametrue oder false; wenn true gewählt ist, wird der Attachment Name deaktiviert
disable-autoprevtrue oder false; wenn true gewählt ist, wird die "Automatische Voransicht" Option deaktiviert
disable-pagerangetrue oder false; wenn true gewählt ist, werden die Einstellungen für den Seitenbereich deaktiviert
disable-positiontrue oder false; wenn true gewählt ist, werden die Einstellungen für Position und Ausrichtung deaktiviert
disable-pagemarginstrue oder false; wenn true gewählt ist, werden die Seitenränder deaktiviert
disable-printermarginstrue oder false; wenn true gewählt ist, werden die Einstellungen für die Seitenränder deaktiviert

Konfigurieren der Standardeinstellungen von iPaper.xml für Briefpapiere

Die Anwendung ermöglicht es, Standardwerte für die neu hinzugefügten Briefpapiere zu definieren.

Der general Bereich enthält folgende Werte:

secondpage-defaulttrue oder false (default: true)
overlay-defaulttrue oder false (default: false)
horz-align-defaultleft, center, right (default: center)
vert-align-defaulttop, center, bottom (default: center)
horz-offset-defaultein Integer Wert, der den horizontalen Offset enthält (default: 0)
vert-offset-defaultein Integer Wert, der den vertikalen Offset enthält (default: 0)
use-pagemargins-defaulttrue oder false (default: false)
margin-left-defaultein Integer Wert, der den linken Seitenrand enthält (default: 0)
margin-right-defaultein Integer Wert, der den rechten Seitenrand enthält (default: 0)
margin-top-defaultein Integer Wert, der den oberen Seitenrand enthält (default: 0)
margin-bottom-defaultein Integer Wert, der den unteren Seitenrand enthält (default: 0)

Die neuen Briefpapiere verwenden diese Werte als Standard, wenn sie der Briefpapier Sammlung hinzugefügt werden.

Briefpapier Ordner

Der general Bereich der iPaper.xml erlaubt es den Standard Ordner für Briefpapier Dateien zu definieren.

stationeryfoldervollständiger Pfad des Briefpapier Ordners; Der Pfad kann auch Umgebungsvariablen enthalten (z.B.: %userprofile%, %homedrive%, etc.)
Tags:
Erstellt von Gregor Herdy am 13/07/2018, 11:59
XKey Wiki 2018