Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 6 Next »


Nach der eigentlichen Dokumentgenerierung können Commands aufgerufen werden.

Verfügbare Commands

Command

Beschreibung

Client

Server

DefaultProcess

Startet den Standardprozess, der in Windows für den Dateityp registriert ist

ConvertToPdf

Konvertiert Vorlagen oder Dokumente (.dotx/.docx) in PDF (.pdf)

SaveAs

Speichert das Dokument am angegebenen Zielort im angegebenen Format

CreateConnectResult

Erstellt eine primedocs-Connect-Result-Datei


DefaultProcess (Client-Only)

Dieser Befehl startet den DefaultProcess, der in Windows für den generierten Dateityp registriert ist. Dieser Aufruf funktioniert nur über den Client.

Möglicher Parameter:

  • Start: True/False, bei False wird der Prozess nicht gestartet.

<primedocsConnect>
  ...
  <Commands>
    <OnSuccess>
      <DefaultProcess Start="true" />
    </OnSuccess>
  </Commands>
</primedocsConnect>

CreateConnectResult (Client-Only)

Über dieses Command wird nach Abschluss der gesamten Dokumenterstellung eine Datei im XML-Format mit einer Zusammenfassung erstellt.

<primedocsConnect>
  ...
  <Commands>
    <OnSuccess>
      <CreateConnectResult />
    </OnSuccess>
  </Commands>
</primedocsConnect>

Speicherort

Die Datei wird im gleichen Ordner erstellt wie das aufrufende Connect nach diesem Namensschema:

result_{Datei-Name-der-Connect-Datei}_{DateTime.Now:yyyyMMddHHmmssfff}.xml

Der Inhalt der Datei sieht im Erfolgsfall etwa so aus:

<?xml version="1.0" encoding="utf-8"?>
<PrimeDocsConnectResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <InputFile>O:\Templates\Template_Kurzmitteilung.pdcx</InputFile>
    <Result>Success</Result>
</PrimeDocsConnectResult>

Im Fehlerfall steht in der Datei zusätzlich eine Fehlermeldung inkl. StackTrace von primedocs (sofern möglich):

<?xml version="1.0" encoding="utf-8"?>
<PrimeDocsConnectResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <InputFile>O:\Templates\Template_Kurzmitteilung.pdcx</InputFile>
    <Result>Error</Result>
    <Message>System.UnauthorizedAccessException: Der Zugriff auf den Pfad "c:\temp" wurde verweigert.
       bei System.IO.__Error.WinIOError(Int32 errorCode, String maybeFullPath)
       bei System.IO.FileStream.Init(String path, FileMode mode, FileAccess access, Int32 rights, Boolean useRights, ...)
       bei System.IO.FileStream..ctor(String path, FileMode mode, FileAccess access, FileShare share)
       bei ...
    </Message>
</PrimeDocsConnectResult>

SaveAs (Client-Only)

Speichert das Dokument am angegebenen Zielort. Der neue Dateispeicherort wird für alle folgenden Befehle berücksichtigt (z. B. im DefaultProcess).

Möglicher Parameter:

  • Filename: Absoluter Pfad mit Dateiendung

  • Overwrite: True/False; gibt an, ob eine bestehende Datei überschrieben werden soll.

  • CreateFolder: True/False; gibt an, ob Ordner, die im Filename angegeben sind, erstellt werden sollen.

  • AllowUpdateDocumentPart: True/False; bei "True" wird der primedocs Document Part als "SavedDocument" anstatt "NewDocument" markiert.

  • CopyOnly: True/False; wird diese Einstellung getroffen, wird das Dokument im aktuellen Stand als Kopie abgespeichert. Im Client-Anwendungsfall wird die Datei trotzdem z. B. weiterhin als "Vorlage (.dotx)" behandelt und im Temp-Ordner erstellt und von dieser Datei Microsoft Word geöffnet.

<primedocsConnect>
  ...
  <Commands>
    <OnSuccess>
      <SaveAs Filename="\\MyServer\share\organization\...\documentxyz.docx"
              Overwrite="true"
              CreateFolder="true"
              CopyOnly="true" />
    </OnSuccess>
  </Commands>
</primedocsConnect>

ConvertToPdf (Client & Server)

Dieser Befehl gilt nur für Word Office-Dokumente. primedocs konvertiert das Dokument direkt in ein PDF.

<primedocsConnect>
  ...
  <Commands>
    <OnSuccess>
      <ConvertToPdf />
    </OnSuccess>
  </Commands>
</primedocsConnect>

Nicht alle Open XML bzw. Microsoft Word Features sind bei der PDF-Konvertierung über diesen Command unterstützt. Als Alternative gibt es im Client die Möglichkeit über den SaveAs-Command das installierte Microsoft Office für die PDF-Konvertierung zu benutzen.

HINWEIS
Werden eigene Schriftarten im Dokument verwendet, müssen diese Schriftarten auch auf dem Server installiert werden.


  • No labels