cnv.ConvertDocument

Dieser Job konvertiert eine oder mehrere Dokumentendateien des angegebenen Formats in eine oder mehrere PDF- oder TIFF-Dateien. Entsprechend der jeweiligen Konfigurationen sind darüber hinaus auch beliebige Ein- und Ausgabeformate möglich.

Folgende Klassen von Transformationen sind möglich:

  • Bitmapformat (JPG, TIF) → PDF

  • Singlepage TIFF → Multipage TIFF

  • ASCII-COLD (.asc) → TIFF / PDF

  • XSL:FO (.fo, .xml) → PDF

  • Office-Dokumente (.ps, .doc, .xls, .ppt, .txt, .rtf, .pdf, .ima) → PDF

Für Bitmapformate und ASCII-COLD-Dokumente lässt sich über Flags steuern, ob für jede Eingabedatei eine eigene Ausgabedatei erzeugt werden soll oder ob die einzelnen Seiten in einem Dokument zusammengefasst werden.

Die Formatangaben werden in Kleinschreibweise erwartet (z. B. pdf statt PDF).
Werden ObjectID und ObjectType übergeben, erfolgt die Konvertierung über OS RenditionPlus (___ren.bat). Als Zielformat kann dann zusätzlich SLIDE zur Vorschaugenerierung oder TXT für Texterkennung übergeben werden. Mit Height und Width kann die Größe der zu generierenden Vorschau angegeben werden.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

Flags

INT

Ja

0 = für jede Eingabedatei wird eine Ausgabedatei erstellt
1 = alle Eingabedateien werden in eine Ausgabedatei geschrieben
2 = für jede Eingabedatei wird eine Ausgabedatei erstellt; vom Server erstellte temporäre Dateien werden nicht gelöscht
3 = alle Eingabedateien werden in eine Ausgabedatei geschrieben; vom Server erstellte temporäre Dateien werden nicht gelöscht

SourceFormat

STRING

Ja

Format der Ausgangsdatei

DestinationFormat

STRING

Ja

Format, in das konvertiert werden soll

[Timeout]

INT

Nein

Maximale Zeit in Millisekunden, die eine Konvertierung über externe Programme dauern darf. Wird berücksichtigt bei XSL:FO und Office-Format-Konvertierungen.

AddAnnotations

INT

Ja

1 = öffentliche Folien werden eingebrannt

[ConvertEqualFormat]

INT

Nein

Default 0. Wenn auf 1 gesetzt, wird eine Konvertierung versucht, selbst wenn Quell- und Zielformat identisch sind (z. B. PDF → PDF/A).

[Watermark]

INT

Nein

Default 0. Wenn auf 1 gesetzt, wird ein erzeugtes PDF-Dokument mit Kopf- und Fußzeilen versehen. Aussehen und Inhalt wird über den Administrator konfiguriert. Siehe enaio® Administratorhandbuch → Registerkarte Druckkennzeichnung.

[dwObjectID]

INT

Nein

Dokument-Objekt-ID für die Benutzung in Wasserzeichen. Nur relevant, wenn Watermark=1 und die Druck-Wasserzeichen so konfiguriert sind, dass die Dokumenten-ID ausgegeben werden soll.

[ProtectPDF]

INT

Nein

Default 0. Wenn gesetzt, wird ein erzeugtes PDF-Dokument geschützt — Ausdrucken und Kopieren von Textpassagen ist dann nicht möglich.

[ObjectID]

INT

Nein

ID des Dokuments (alternativ zur Datei-Liste)

[ObjectType]

INT

Nein

Typ des Objekts (alternativ zur Datei-Liste)

[Digest]

STRING

Nein

Hashwert des Dokuments (nur bei Übergabe von ObjectID/ObjectType)

[Height]

INT

Nein

Höhe der Vorschau bei Zielformat SLIDE

[Width]

INT

Nein

Breite der Vorschau bei Zielformat SLIDE

2. Eingabedateien

Name Beschreibung

[Datei-Liste]

Pfad und Name der Dateien, die konvertiert werden sollen (alternativ zu ObjectID/ObjectType)

3. Ausgabedateien

Name Beschreibung

Datei-Liste

Pfad und Name der konvertierten Datei(en)

4. Rückgabe

(INT): 0 = Job erfolgreich, sonst Fehlercode.

Siehe auch: cnv.CreateSlide

5. Verwendung von XSL:FO

  • Für die Konvertierung von FO-Dateien (Formatting Objects) muss der Apache FOP-Prozessor installiert sein. Dieser benötigt eine Java-Laufzeitumgebung 1.6 oder höher. Der Pfad zur FOP-Batch-Datei (Windows) bzw. zum FOP-Shellskript (Linux) muss über den Enterprise-Manager in der Registry hinterlegt werden. Des Weiteren kann ein Timeout definiert werden, nach dem der Konvertierungsprozess abgebrochen wird.

  • Wird dem FOP ein XML-Dokument übergeben, muss zusätzlich ein XSLT-Dokument als zweite Datei in der Eingabedateiliste übergeben werden, mit dem das XML in ein XSL:FO-Dokument überführt werden kann.

  • Sollen Bilder in das resultierende PDF eingebunden werden, müssen diese in der XSL:FO-Datei über eine für den Applikationsserver zugängliche URL referenziert werden.

  • Es kann nur ein FO- bzw. XML-Dokument pro Job verarbeitet werden.

Beispiel: cnv.ConvertDocument mit XSL:FO (SourceFormat: XML, DestinationFormat: PDF, Flags=0)

  1. Eingabedatei — XML-Datei mit beliebigen Eingabeinformationen:

    <?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<?xml-stylesheet type="text/xsl" href="example.fo"?>
<persons>
  <person age="42">Max Mustermann</person>
  <person age="37">Denise Musterfrau</person>
</persons>

  2. Eingabedatei — XSL-Datei zur Konvertierung in eine XSL:FO-Datei:

<?xml version="1.0" encoding="ISO-8859-1"?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
                xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
  <xsl:template match="persons">
    <fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format">
      <fo:layout-master-set>
        <fo:simple-page-master page-master-name="one" page-height="29cm" page-width="21cm"
                               margin-left="2cm" margin-right="2cm">
          <fo:region-body margin-top="50pt" margin-bottom="50pt"/>
        </fo:simple-page-master>
      </fo:layout-master-set>
      <fo:block text-align="center" font-size="24pt" font-weight="bold"
                lineheight="28pt" space-after="10mm">
        <xsl:apply-templates/>
      </fo:block>
    </fo:root>
  </xsl:template>
  <xsl:template match="person">
    ...
  </xsl:template>
</xsl:stylesheet>