Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

Aktuell wird die Conversion nur für Word-Vorlagen unterstützt!

...

  • Status: Der Status kann folgende Werte beinhalten:

    • OK: Keine Fehler, die Dokumentgenerierung oder alle Commands bis zu diesem Punkt liefen erfolgreich durch.

    • Cancelled: Dieser Status tritt auf, wenn der Benutzer die Dokumentgenerierung abbricht.

    • Error: Fehler bei der Dokumentgenerierung oder falls ein vorangegangener Command fehlt schlug.

  • Input & File: Wenn primedocs über eine primedocs Connect Datei aufgerufen wird, dann enthält dieses Element den Dateipfad dieser Datei.

  • CreatedOnUtc: Zeitangabe, wann der Report erstellt wurde.

  • Message: Beinhaltet Meldungen des Reports.

Dynamische Parameter

Connect Commands können über ihre jeweiligen Attribute bzw. Elementen mit Werten ausgestattet werden, so z.B. kann man den Speicherpfad bei SaveFile angeben:

Code Block
languagexml
<SaveFile FileName="\\MyServer\share\organisation\...\Letter.docx" ...

Möchte man allerdings den Pfad oder Dateinamen dynamisch zusammenbauen, kann man über das field-Attribut auf die Felder der Dokumentgenerierung (“User”, “Forms”, “Field”, “Data” etc.) zugreifen.

Code Block
languagexml
<SaveFile field-FileName="SavePath" ...

Der Einsatz hier ist nur exemplarisch. Nicht jedes Attribut oder Element unterstützt den Zugriff auf Felder.

Grundsätzlich:

  • Attribute, welche den Zugriff auf Felder unterstützen sind in dem Stil benannt:

    • Attribut="statischer Wert" bzw. field-Attribut="FeldName"

  • Elemente, welche den Zugriff auf Felder unterstützen sind in diesem Stil benannt:

    • <Element>statischer Wert</Element> bzw. <Element field-Content="FeldName" />

Note

Der Zugriff auf die Felder funktioniert nur im OnSuccess-Fall.

Commands

Die folgende Tabelle führt alle verfügbaren Commands auf und gibt an, ob sie nur client-seitig oder server-seitig verfügbar sind sowie, ob sie nur im Erfolgsfall verwendet werden können.

...

Command

Beschreibung

Client

ServerNur im Erfolgsfall

OpenFile

Öffnet Office-Dateien mit dem Standardprozess, der in Windows für den Dateityp registriert ist.

SaveFile

Speichert das Dokument am angegebenen Zielort im angegebenen Format.

InvokeProcess

Ruft eine externe Anwendung auf. Aus Sicherheitsgründen muss der Prozess vorher konfiguriert werden.

InvokeUrl

Sendet die Datei bzw. den Report an einen HTTP/HTTPS Endpunkt. Aus Sicherheitsgründen muss die Ziel-URL vorher konfiguriert werden.

...

  • FileName: Absoluter Pfad mit Dateiendung

  • field-FileName: Alternative zu FileName um dynamische Pfade über die Felder zu ermöglichen.

  • 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.

Elemente:

  • Document oder Report: Siehe Abschnitt “Zugriff auf das Ergebnis”

Code Block
languagexml
<primedocsConnect>
  ...
  <Commands>
    <OnSuccess>
      <SaveFile FileName="\\MyServer\share\organisation\...\Letter.docx"
                Overwrite="true"
                CreateFolder="true">
        <Document />          
      </SaveFile>
    </OnSuccess>
  </Commands>
</primedocsConnect>

...

  • FileName: Absoluter Pfad mit Ziel-Dateiendung

  • field-FileName: Alternative zu FileName um dynamische Pfade über die Felder zu ermöglichen.

Code Block
languagexml
<primedocsConnect>
  ...
  <Commands>
    <OnSuccess>
      <SaveFile FileName="\\MyServer\share\organization\...\Letter.docx"
                Overwrite="true"
                CreateFolder="true">
          <Document />
      </SaveFile>
      <OpenFile FileName="\\MyServer\share\organization\...\ShortLetter.docx"/>      
    </OnSuccess>
  </Commands>
</primedocsConnect>

...

  • Name: Konfigurierter Prozessname

Elemente:

  • Arguments: Argumente für den Prozessaufruf

  • Arguments mit field-Content: Alternative zu Arguments mit statischem Wert. Erlaubt es auf Feldwerte zuzugreifen.

Der Aufruf kann optional Argumente enthalten und sieht folgendermassen aus:

Code Block
<primedocsConnect>
  ...
  <Commands>
    <OnSuccess>
      <InvokeProcess Name="OurSystemNotepad">
          <Arguments>...</Arguments>
          <!-- or -->
          <Arguments field-Content="FieldName" />
      </InvokeProcess>    
    </OnSuccess>
  </Commands>
</primedocsConnect>