generateDocument (Client)

Code

DocumentUtils.generateDocument(String templateName, boolean showWizard, String documentSubject [,String outputFormat])

Beschreibung

Startet die Einzelbrieferstellung. Das erstellte Dokument wird an die aktuelle Entität gehängt. Funktioniert nur mit Entitäten, die dies unterstützen (z.B. Aktivität).

Die Eingabeprameter

• templateName - muss den internen Namen der Dokumentenvorlage enthalten.

• showWizard - entscheidet, ob ein Wizard, der zur Eingabe eines Betreffs auffordert, angezeigt wird.

• documentSubject - enthält den Betreff für das Dokument. Wenn ein Wizard angezeigt wird, stellt dies die Vorbelegung dar, wird kein Wizard angezeigt, ist dies der finale Betreff. Daher MUSS in diesem Fall ein Betreff angegeben sein.

• outputFormat - [optional]
  Ist ein optionaler Parameter und beschreibt das Ausgabeformat des zu generierenden Dokuments. Dieser Parameter wirkt sich nur auf native Dokumentvorlagen aus! Bei COM-Dokumentvorlagen wird das Ausgabeformat durch die Word-Installation vorgegeben.
  Mögliche Parameter doc, docm, docx, pdf. Die verfügbaren Formate stehen als Konstanten in der Klasse DocumentUtils zur Verfügung, z.B. DocumentUtils.DOC_SAVEFORMAT_PDF
  Wird der Parameter nicht übergeben, so wird das in der Dokumentvorlage hinterlegte Ausgabeformat verwendet. 

• Verwendung
  Diese Methode steht im Maskenskripting nur im WindowsClient zur Verfügung! Alternative: Im serverseitigen Scripttask kann diese Methode immer verwendet werden.

• Rückgabewert IDocumentResult
  Das gelieferte IDocumentResult enthält niemals den Primärschlüssel des erstellten Dokuments, da die Erstellung asynchron zur Scriptausführung erfolgt!

• Ausgabeformat
  Folgende Bedingungen müssen erfüllt sein, wenn ein Format angegeben wird.

  • Die Option steht nur für Dokumentvorlagen basierend auf der Generierungsvariante NATIVE zur Verfügung.
    Basiert die Dokumentvorlage auf COM oder MIXED, so wird das Ausgabeformat durch die Word-Installation vorgegeben. Das eingetragene Ausgabeformat bleibt in diesem Fall unberücksichtigt!

  • Es gelten die bekannten Einschränkungen bei der Generierung von Nicht-Worddokumenten (siehe Administration Dokumentvorlagen)

Beispiele

DocumentUtils.generateDocument("Blanko (Beispiel)", true, "Telefonat");
DocumentUtils.generateDocument("Blanko NATIVE (Beispiel)", true, "Besuch", "pdf");