Converter Parameter

Mit dem Webservice "Converter" kann die Konvertierung von diversen Formaten in das PDF-Format vorgenommen werden.

 

Optional kann für den Konvertierungsvorgang auch noch die Parameter-Struktur für die Webservices "Pdfa" und "Signature" angegeben werden. Diese werden dann direkt nachfolgend ausgeführt.

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<operation xmlns="http://schema.webpdf.de/1.0/operation">
<converter pages="*"
            accessPassword="xyz"
            compression="true"
            dpi="300"
            embedFonts="true"
            jpegQuality="90"
            reduceResolution="true"

            fileExtension="">
  <html adjustFonts="true"
        baseURL="http://www.webpdf.net/"
        downloadImages="true"/>
  <mail adjustFonts="true"
        attachmentMode="embed"
        downloadImages="true"

        ignoreMissingBodyChunk="false"/>
  <officeBridge/>
  <sharePointBridge/>
  <page bottom="20"
        height="297"
        left="20"
        right="20"
        metrics="mm"
        top="20"
        width="210"/>
  <signature>
     ...
  </signature>
  <pdfa>
     ...
  </pdfa>
  <report contentProblems="true"
          fontAliasUsage="true"
          fontIsMissing="true"/>
  <template language="en"
</converter>
</operation>

{
"converter": {
  "pages": "*",
  "accessPassword": "xyz",
  "compression": true,
  "dpi": 300,
  "embedFonts": true,
  "jpegQuality": 90,
  "reduceResolution": true,

  "fileExtension": "xyz",
  "html": {
    "adjustFonts": true,
    "baseURL": "http://www.webpdf.net/",
    "downloadImages": true

   },
  "mail": {

    "adjustFonts": true,

    "attachmentMode": "embed",

    "downloadImages": true,

    "ignoreMissingBodyChunk": false
   },
  "officeBridge": {},
  "sharePointBridge": {},
  "page": {
    "bottom": 20,
    "height": 297,
    "left": 20,
    "right": 20,
    "metrics": "mm",
    "top": 20,
    "width": 210
   },
  "signature": {
     ...
   },
  "pdfa": {
     ...
   },
  "report": {
    "contentProblems": true,
    "fontAliasUsage": true,
    "fontIsMissing": true
   },
  "template": {
    "language": "en"

   }
 }
}

 

 

converter-Element

 

Führt die Konvertierung eines Dokument durch.

 

 
<converter pages="*"
          accessPassword="xyz"
          compression="true"
          dpi="300"
          embedFonts="true"
          jpegQuality="90"
          reduceResolution="true"
          fileExtension="">
            ...
</converter>

{
"converter": {
  "pages": "*",
  "accessPassword":"xyz",
  "compression":true,
  "dpi":300,
  "embedFonts":true,
  "jpegQuality":90,
  "reduceResolution":true,

   "fileExtension": "xyz",
   ...
 }
}

 

pages (Default: "")

Ein Text, der den Seitenbereich für den Export definiert. Dabei sind einzelne Seiten oder Bereiche definierbar. Ist der Text leer, so wird die gesamte Datei exportiert (Bsp.: "1-10" oder "1,2,5-10")

 

accessPassword (Default: "")

Mit dem Parameter kann ein Passwort angegeben werden, das zum Öffnen des Ausgangsdokument verwendet wird, wenn dieses geschützt ist.

 

hint

Diese Option wird aktuell nur für Microsoft Office 97-2003 Binärdokumente und Microsoft Office 2007 Dokumente unterstützt. Es werden nur die Standard-Passwortverfahren unterstützt. Verschlüsselungen auf Basis von digitalen Zertifikaten werden nicht unterstützt.

 

compression (Default: true)

Wenn "true", dann werden die Daten-Objekte im PDF-Dokument komprimiert (Zlib-Kompression). Dies reduziert die Größe des Dokuments.

 

dpi (Default: 300)

Gibt die DPI-Auflösung (Punkte pro Zoll) von Grafiken an.

 

embedFonts (Default: false)

Wenn "true", dann werden Schriften in das erstellte PDF-Dokument eingebettet.

 

hint

Sind auf dem Konvertierungssystem die Originalschriften nicht vorhanden, ist es möglich, das Ersatzschriften eingebunden werden.

 

hint

Wollen Sie nach der Konvertierung das PDF-Dokument noch nach PDF/A umwandeln, dann sollten Sie keine Einbettung der Schriftarten aktivieren, sondern dies dem Webservice "Pdfa" überlassen.

 

jpegQuality (Default: 90)

Gibt die Qualität (in Prozent) der JPEG-Grafiken im PDF-Dokument an.

 

reduceResolution (Default: false)

Wenn "true", dann wird die DPI-Auflösung von Grafiken reduziert. Der Wert der Reduzierung wird über "dpi" eingestellt.

 

fileExtension (Default: "")

Wenn Sie hier eine Endung für die Datei angeben (z.B. "doc"), die aktuell verarbeitet werden soll, dann wird die automatische Erkennung des Dateiformats deaktiviert. In der Regel erkennt webPDF das Dateiformat nicht über die Dateiendung, sondern führt eine Erkennung an Hand des Dateiinhaltes durch. webPDF untersucht die Datei und ordnet so die Datei einem entsprechenden "mime-type" zu, um dann den entsprechenden Dateikonverter zu wählen.

 

hint

Sie sollten nur in seltenen Ausnahmefällen eine Dateiendung setzen, denn damit wird die automatische Erkennung komplett deaktiviert. Wenn Sie z.B. eine Endung angeben, für die webPDF keinen "mime-type" hat, dann schlägt die Konvertierung fehl.

 

 

html-Element

 

Die Einstellungen finden nur bei HTML- (z.B. Web-Seiten) oder HTML-basierten Dokumenten (z.B. E-Mails) eine Anwendung.

 

<html adjustFonts="true"
    baseURL="http://www.webpdf.net/"
    downloadImages="true"/>

"html":{
    "adjustFonts":true,
    "baseURL":"http://www.webpdf.net/",
    "downloadImages":true
   }

 

adjustFonts (Default: false)

Wenn "true", dann werden automatisch die Schriftangaben "Arial", "Helvetica" und "Sans-Serif" in HTML-Dokumenten und E-Mails (die auf HTML basieren) durch die Schriftart "Arial Unicode MS" ersetzt. Dies verbessert das Schriftbild in der PDF-Ausgabe.

 

baseURL (Default: "")

Definiert die URL, die als Basis für alle URL's im HTML-Dokument verwendet wird, die nicht als absolut definiert sind.

 

downloadImages (Default: false)

Wenn "true", dann werden automatisch die Bilder einer E-Mail oder eines HTML-Dokuments herunter geladen. Diese Option (kann) die Konvertierung erheblich verlangsamen, wenn viele Bilder enthalten sind oder z.B. E-Mail-Dokumente konvertiert werden, wo die Bilder nicht mehr abrufbar sind.

 

 

mail-Element

 

Die Einstellungen finden nur bei bei Mail-Dokumenten eine Anwendung. Es werden die E-Mail Format "MIME" (eml; RFC-822) und und Outlook (msg) unterstützt.

 

<mail adjustFonts="true"
    attachmentMode="embed"
    downloadImages="true"

    ignoreMissingBodyChunk="false"/>

"mail": {

  "adjustFonts": true,

  "attachmentMode": "embed",

  "downloadImages": true,

  "ignoreMissingBodyChunk": false
 }

 

adjustFonts (Default: false)

Wenn "true", dann werden automatisch die Schriftangaben "Arial", "Helvetica" und "Sans-Serif" in HTML-Dokumenten und E-Mails (die auf HTML basieren) durch die Schriftart "Arial Unicode MS" ersetzt. Dies verbessert das Schriftbild in der PDF-Ausgabe.

 

attachmentMode (Default: embed)

Legt fest, wie Anhänge in E-Mails verarbeitet werden

embed = im Originalformat einbetten

remove = Anhänge entfernen

 

downloadImages (Default: false)

Wenn "true", dann werden automatisch die Bilder einer E-Mail oder eines HTML-Dokuments herunter geladen. Diese Option (kann) die Konvertierung erheblich verlangsamen, wenn viele Bilder enthalten sind oder z.B. E-Mail-Dokumente konvertiert werden, wo die Bilder nicht mehr abrufbar sind.

 

ignoreMissingBodyChunk (Default: false)

Wenn diese Option aktiviert ist, dann wird bei Outlook Mails (msg) kein Fehler ausgelöst (Konvertierung abgebrochen), wenn kein Body-Element in der Dateistruktur vorhanden ist. Dies hat allerdings nicht mit dem leeren Inhalt einer Mail zu verwechseln.

 

 

officeBridge-Element

 

Legt fest, ob für die Konvertierung von Word, Excel und PowerPoint-Dokumenten die "Office Bridge" verwendet werden soll. Wenn das Element gesetzt ist (und die Office Bridge aktiviert) wird das Dokument über das auf dem Server installierte Office konvertiert.

 

<officeBridge/>

"officeBridge":{},

 

 

sharePointBridge-Element

 

Legt fest, ob für die Konvertierung des Word-Dokuments die "SharePoint Bridge" verwendet werden soll. Wenn das Element gesetzt ist wird das Word-Dokumente über den SharePoint-Dienst konvertiert (wenn die SharePoint Bridge aktiviert ist).

 

<sharePointBridge/>

"sharePointBridge":{},  

 

 

page-Element

 

Definiert das Seitenformat für die Ausgabedatei. Ist dieses Element vorhanden, dann werden evtl. im Dokument gesetzte Einstellungen (z.B. Word-Dokument) für die Seite überschrieben. Nicht alle Dokumente, die von webPDF konvertiert werden können, unterstützen ein Seitenformat.

 

<page bottom="20"
    height="297"
    left="20"
    right="20"
    metrics="mm"
    top="20"
    width="210"/>

"page":{
"bottom":20,

"height":297,
"left":20,
"right":20,
"metrics":"mm",
"top":20,
"width":210
},

 

bottom (Default: 20)

top (Default: 20)

left (Default: 20)

right (Default: 20)

Randeinstellungen (in Millimeter) für die Ausgabe im PDF-Format.

 

height (Default: 297)

Papierhöhe (in Millimeter) für die Ausgabe im PDF-Format.

 

width (Default: 210)

Papierbreite (in Millimeter) für die Ausgabe im PDF-Format.

 

metrics (Default: "mm")

Maßeinheit für die Angaben. Zum jetzigen Zeitpunkt können nur "mm" angegeben werden.

 

 

pdfa-Element

 

Sie können die für den PDF/A-Service beschriebene Parameterstrukur verwenden und in das Element einfügen.

 

<pdfa>
     ...
</pdfa>

"pdfa":{
     ...
},

 

hint

Wenn dieses Element gesetzt ist, wird automatisch an den Anschluss der Konvertierung der Webservice "Pdfa" aufgerufen.

 

 

signature-Element

 

Sie können die für den Signature-Service beschriebene Parameterstruktur verwenden und in das Element einfügen.

 

<signature>
     ...
</signature>

"signature":{
     ...
},  

 

hint

Wenn dieses Element gesetzt ist, wird automatisch an den Anschluss der Konvertierung der Webservice "Signature" aufgerufen.

 

 

report-Element

 

Ermöglicht bei textbasierten Dokumenten (z.B. Word) eine erweitertes Fehler-Reporting zu aktivieren.

 

<report contentProblems="true"
      fontAliasUsage="true"
      fontIsMissing="true"/>

"report": {
"contentProblems": true,
"fontAliasUsage": true,
"fontIsMissing": true
}

 

contentProblems (Default: false)

Wenn "true", dann wird ein Fehler (ERR_CONVERTER_CONTENT_PROBLEMS) ausgelöst, wenn während der Konvertierung ein Problem mit einem Inhalt aufgetreten ist. Zu den Problemen zählt folgendes:

- Unicode-Auflösung von Zeichen nicht möglich

- vertikaler Textfluss

- nicht unterstützte Texteffekte

- nicht unterstützte Grafikkomprimierung

- nicht unterstützter Farbraum

- ein eingebundenes Unterdokument das nicht konvertiert wurde

- Tabellen mit "rechts-nach-links" Ausrichtung im Inhalt

- das Dokument enthält mathematische Formeln

 

fontAliasUsage (Default: false)

Wenn "true", dann wird ein Fehler (ERR_CONVERTER_FONT_ALIAS_USED) ausgelöst, wenn eine Schriftart (Font) bei der Konvertierung nicht gefunden wurde und stattdessen ein Ersatz (Alias) Font verwendet wurde.

 

fontIsMissing (Default: false)

Wenn "true", dann wird ein Fehler (ERR_CONVERTER_FONT_IS_MISSING) ausgelöst, wenn eine Schriftart (Font) bei der Konvertierung nicht gefunden wurde.

 

 

template-Element

 

Ermöglicht die Definition der Einstellungen für Dateiformate, für deren Konvertierung ein Template benötigt wird. Die Einstellungen gelten aktuell für die folgenden Dateiformat:

 

MIME Mail (eml)

Outlook Mail (msg)

iCalender (ics) / vCalendar (vcs)

vCard (vcf)

 

language (Default: "")

Ein ISO 639-1 konformer Sprachcode bestehend aus 2 Buchstaben. Sofern vorhanden, wird über die hier gewählte Sprache ein lokalisiertes Template gewählt. Wenn nicht definiert, wird die Sprache verwendet, mit der webPDF ausgeführt wird.