Ein "OneOffixxConnectBatch" umfasst einen oder mehrere "OneOffixxConnect" bzw. "Entries". Das "OneOffixxConnectBatch" Element kann "Settings" und "Commands" enthalten, welche sich global auf alle "Entries" auswirken bzw. gesonderte Funktionalitäten (wie z. B. das Zusammenfassen von Dokumenten) ermöglichen.

Das "OneOffixxConnect" (die Connect-Datei) beschreibt konkret einen Dokumentgenerierungs- bzw. Dokumentänderungsaufruf. Vorlage-Auswahldaten, also die betreffende Vorlage oder Sprache, werden über die "Arguments" gesetzt. Dokument-Daten können über die verschiedenen Dokumentfunktionen übergeben werden. Die Dokumentfunktionen werden hierbei über die "id" des "Function" Elements identifiziert.

Die “primedocsConnectBridge” ist ein optionales Element, um webfähige primedocs-Vorlagen mit dem klassischen Connect-Aufruf anzusprechen. Weitere Informationen dazu finden Sie unter dieser Seite: primedocsConnectBridge

<OneOffixxConnectBatch>
  <Settings />
  <Commands />
  <Entries>
    <OneOffixxConnect>
      <Arguments />
      <Function id="x" />
      <Function id="y" />
      ...
      <primedocsConnectBridge />
  </OneOffixxConnect>
  </Entries>
</OneOffixxConnectBatch>

Namespace

Der Namespace für OneOffixx Connect lautet

http://schema.oneoffixx.com/OneOffixxConnectBatch/1

wobei die hinterste Nummer der Major-Version entspricht. Die Minor Version steht in den Globale Settings (Key="Version" Value ="XXX").

OneOffixx Connect Batch

Enthält eine Batch-Liste mit OneOffixx Connect Strukturen. Ein OneOffixx Connect entspricht einem OneOffixx Dokument.

Globale Settings

//OneOffixxConnectBatch/Settings

Diese Struktur enthält eine Key/Value Liste mit Globalen Settings. Diese Settings werden während der Verarbeitung in die OneOffixx Connect Struktur kopiert.

OneOffixx kennt die folgenden Settings:

<?xml version="1.0" encoding="UTF-8"?>
<OneOffixxConnectBatch xmlns="http://schema.oneoffixx.com/OneOffixxConnectBatch/1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Settings>
    <Add key="KeepConnector">true</Add>
    <Add key="CreateConnectorResult">false</Add>
    <Add key="CreateConnectorResultOnError">true</Add>
  </Settings>
  <Entries>
    …
  </Entries>
</OneOffixxConnectBatch>

Diese Settings haben die gleiche Funktion wie die entsprechenden Kommandozeilenparameter. Falls angegeben, überschreiben sie die Kommandozeilenparameter.

HINWEIS
Nur bei der Angabe einer TemplateId wird ein Result-File nach der Generierung erstellt. Wenn das Result-File auch bei Tag-Angaben erstellt werden soll, gibt es die Möglichkeit, über den "CreateConnectorResult"-Command zu gehen.

Globale Befehle

Diese Struktur enthält Befehle, welche die ganze Dokumentliste betreffen (z. B. Merge Document).

Entries

Entries entspricht einer Liste mit Dokumenten bzw. mit Connect-Aufrufen.

OneOffixx Connect

Die OneOffixx Connect Struktur entspricht einem Dokument. Jedes Dokument kann mit Argumenten, Befehlen und Dokumentfunktionen ausgestattet werden.

Dokumentfunktionen ("Function" im XML) reichern das Dokument mit Daten an und sind optional. Jede Funktion wird über ihre eindeutige ID identifiziert.

Über "Commands" kann das generierte Dokument weiterverarbeitet und so z. B. an einen bestimmten Speicherort abgelegt werden.

Validierung

Um eine Connect-Datei zu validieren bzw. zu prüfen, kann der Prozessaufruf mit dem Parameter "/ValidateConnector" benutzt werden. Beispielaufruf:

Es ist zu beachten, dass hierbei die Connect-Datei nicht verarbeitet, sondern geprüft wird. Im produktiven Betrieb empfiehlt sich eine ständige Validierung aus Performancegründen nicht.

XSD

Nachfolgend das vollständige XSD, das auch bei der Validierung genutzt wird:

primedocs: technische Dokumentation

XML-Schema