Versions Compared

Key

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

...

BatchCommands Batch-Commands werden auf der höchsten Ebene ausgeführt, nachdem alle Document-Commands der einzelnen Entries ausgeführt wurden.

...

Verfügbarkeit aller Commands

Command

Beschreibung

Document

Batch

Client

Server

DefaultProcess

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

ConvertToDocument

Konvertiert Office-Vorlagen (.dotx, etc.) in Office-Dokumente (.docx, etc.)

ConvertToPdf

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

✓*

Print

Sendet das Dokument an den Standarddrucker

SaveAs

Speichert das Dokument am angegebenen Zielort im angegebenen Format

✓*

UpdateFieldsOnOpen

Aktualisiert Felder und das Inhaltsverzeichnis (Fields / ToC) im Dokument

Merge

Verbindet mehreren Office-Dokumente zu einem

CreateConnectorResult

Erstellt eine primedocs-Connector-Result-Datei

BindCustomXML

Bindet alle CustomControls mit den jeweiligen Daten

InvokeProcess

Ruft ein bestimmtes, im primedocs-Dashboard registriertes Programm auf

*mit gewissen Einschränkungen

...

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:

...

Code Block
languagexml
<Command Name="DefaultProcess">
    <Parameters>
        <Add key="Start">true</Add>
    </Parameters>
</Command>

...

ConvertToDocument

Dieser Befehl gilt nur für Word-Dokumente. primedocs verwaltet und generiert Word-Vorlagen (.dotx). Um nach dem Generieren des Dokuments ein Word-Dokument (.docx) zu erhalten, wird dieser Befehl benötigt. Fehlt diese Angabe und wird das Ergebnis als .docx-Datei gespeichert, zeigt Word eine Fehlermeldung an.

Code Block
<Command Name="ConvertToDocument" />

...

ConvertToPdf

Verfügbarkeit: primedocs Server & primedocs Client

...

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

...

Print

Das Dokument wird an den Standarddrucker gesendet:

Code Block
<Command Name="Print" />

...

SaveAs

Note

CAUTION
Auf dem Server kann dieser Command nicht dazu verwendet werden, ein Word-Dokument zu einem PDF zu konvertieren! Verwenden Sie dazu ConvertToPdf.

...

HINWEIS
In früheren Versionen konnte zusätzlich der Parameter Type angegeben werden. Dieser wird nicht mehr benötigt, da eine Typumwandlung implizit über die Dateiendung der Zieldatei abgeleitet wird.

...

UpdateFieldsOnOpen

Dieser Befehl gilt nur für Word-Dokumente und speichert im Dokument die Information, dass Office die Felder, (z. B. Inhaltsverzeichnisse oder Verknüpfungen) beim Öffnen aktualisieren soll. Im Normalfall erscheint für den Benutzer beim Öffnen des Dokuments direkt die Frage, ob die Felder aktualisiert werden sollen:

...

HINWEIS
Es wird empfohlen, das Command zusammen mit ConvertToDocument (bzw. für den PDF-Output mit ConvertToPdf zu benutzen, da Word beim Öffnen einer ".dotx"-Datei ebenfalls das Inhaltsverzeichnis nicht richtig darstellt.

...

Merge

Das Merge-Command gilt nur für Word-Dokumente und kann zum Zusammenführen von mehreren Dokumenten verwendet werden. Das zusammengeführte Dokument kann anschliessend wieder als ein einzelnes weiterverwendet werden. Der Befehl steht nur als BatchCommand zur Verfügung.

...

Das Ergebnis des Merge-Commands ist immer ein Word-Dokument (.docx).

...

CreateConnectorResult

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

...

Code Block
languagexml
<?xml version="1.0" encoding="utf-8"?>
<OneOffixxConnectResult 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.oocx</InputFile>
      <Input><![CDATA[
        <OneOffixxConnectBatch>
        ...
        </OneOffixxConnectBatch>
      ]]></Connect>
    </Details><Result>Success</Result>
</OneOffixxConnectResult>

...

Code Block
languagexml
<?xml version="1.0" encoding="utf-8"?>
<OneOffixxConnectResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <InputFile>O:\Templates\Template_Kurzmitteilung.oocx</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 primedocs.Core.Connect.Commands.SaveAs.Execute()
       ...
    </Message>
    <Details>
      <InputFile>O:\Templates\Template_Kurzmitteilung.oocx</InputFile>
      <Input><![CDATA[
        <OneOffixxConnectBatch>
        ...
        </OneOffixxConnectBatch>
      ]]></Connect>
    </Details>
</OneOffixxConnectResult>

...

BindCustomXML

Dieses Command gilt nur für Word-Dokumente. primedocs legt alle Daten als sogenannte “CustomXML-Daten” im Dokument ab und Office lädt beim Öffnen des Dokuments diese Daten und schreibt die Werte in die jeweiligen ContentControls.

...

HINWEIS
Es gibt vereinzelt Fälle in welchen Office bzw. der Open XML-Client nicht die richtigen Werte lädt oder die Felder leer bleiben, weil z. B. eine ältere Version von Office genutzt wird oder weil der Open XML-Client diese Funktionalität nicht implementiert hat.
In solchen Fällen kann das BindCustomXML-Command helfen, da primedocs bereits bei der Dokumentgenerierung die Daten nicht nur im CustomXML ablegt sondern weil es gleichzeitig die Daten in den ContentControls aktualisiert.

...

InvokeProcess

Im Dashboard müssen die zulässigen Applikationen zuerst whitelisted werden. Die Konfiguration dafür kann unter Settings → Connect Settings → InvokeProcess - Configuration gefunden werden und sieht ansatzweise wie folgt aus:

...