Page Comparison

...

In diesem Beispiel wird ein Dokument mit der Vorlage 30b55516-80b5-41d7-801b-b31d6da376ac mit dem Subject “Hello Connect”.
Nach der erfolgreichen Dokumentgenerierung wird das Dokument über den SaveAs-Command in einen Ordner abgespeichert.

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

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

Ü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>

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">
    <Result>Success</Result>
    <Details>
      <InputFile>O:\Templates\Template_Kurzmitteilung.pdcx</InputFile>
      <Input><![CDATA[
        <primedocsConnect>
        ...
        </primedocsConnect>
      ]]></Connect>
    </Details>
</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">
    <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>
    <Details>
      <InputFile>O:\Templates\Template_Kurzmitteilung.pdcx</InputFile>
      <Input><![CDATA[
        <primedocsConnect>
        ...
        </primedocsConnect>
      ]]></Connect>
    </Details>
</PrimeDocsConnectResult>

SaveAs

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.

<Command Name="SaveAs">
  <Parameters>
    <Add key="Filename">\\MyServer\share\organization\...\documentxyz.dotx</Add>
    <Add key="Overwrite">true</Add>
    <Add key="CreateFolder">true</Add>
    <Add key="CopyOnly">false</Add>
    <Add key="AllowUpdateDocumentPart">false</Add>
  </Parameters>
</Command>

...

Alle verfügbaren Commands sind hier dokumentiert: