Dokumentgenerierung starten

---

primedocs Connect kann sowohl client- als auch serverseitig verarbeitet werden.

Clientseitige Verarbeitung

Dateiendungen

Zwei Dateiendungen sind in Windows mit dem primedocs-Client bereits verknüpft:

Dateiendung	Beschreibung
.pdcx	Beinhaltet primedocs Connect-konformes XML und wird von primedocs direkt (ohne Rückfrage) ausgeführt. Die Datei wird – sofern im XML nicht anders definiert – nach der Dokumenterstellung gelöscht.
.pdck	Gleich wie .pdcx, das k steht aber für keep. Die primedoc Connect-Datei wird nach der Verarbeitung nicht gelöscht.

Erstellt man eine primedocs Connect Datei und benennt diese mit der Dateiendung .pdcx oder .pdck ist diese Datei automatisch mit primedocs verknüpft und kann normal über Windows gestartet werden.

Aufruf über Konsole

Es ist zudem möglich primedocs über die Konsole aufzurufen:

.\primedocs.exe /connect "<path to xml file>"

Alternativ funktioniert auch der Aufruf über den /URI Parameter:

.\primedocs.exe /uri "primedocs:connect=<path to xml file>&keepConnect=true"

Als path to xml file kann ein Dateipfad oder eine URL angegeben werden (siehe Abruf von URL).

warnung

WICHTIG
primedocs löscht nach der Verarbeitung automatisch die Connect-Datei. Wird das zusätzliche Argument /keepConnect übergeben, kann dieses Verhalten unterdrückt werden. Wird via Shell aufgerufen, dann muss die Dateiendung ".pdck" verwendet werden.

URI via Protokoll Handler

Bei der Installation des primedocs desktop Clients wird ein Protokollhandler registriert, welcher den Command Aufruf via URI ermöglicht. Eine vollständige Übersicht aller Protokollbefehle bietet die Referenz Protokollhandler.

Damit kann primedocs desktop auch aus einem Browser via Link aufgerufen werden.

<a href="primedocs:connect=[path to xml file]">Dokument generieren</a>

Abruf von URL

Wenn eine URL als [path to xml file] startend mit http:// oder https:// angegeben wird, ruft primedocs Desktop diese auf um von dort das Connect-File zu beziehen. Somit kann beispielsweise eine API verwendet werden für die Datenlieferung.

Damit der Aufruf der URL funktioniert muss diese zuvor in primedocs Admin (DataSourceAdminApp) unter Connect Settings über die Einstellung Connect - Remote Policies freigegeben werden. In dieser Einstellung können auch HTTP Header definiert werden für beispielsweise die Übermittlung eines Authentifizierungstokens.

Pro Policy ist nur uriStartsWith Pflicht; der Headers-Block ist optional und kann bei anonym erreichbaren Quellen weggelassen werden:

<RemoteConnectPolicies>
  <Policy uriStartsWith="https://api.example.com/connect">
    <Headers>
      <Header name="Authorization" value="Bearer 124AbC"/>
    </Headers>
  </Policy>
  <Policy uriStartsWith="https://public.example.com/connect" />
</RemoteConnectPolicies>

Da die Zeichen & und = als Separator für die Connect-Argumente verwendet werden, sollte die URL encoded werden. Beispielsweise muss die URL
https://api.example.com/connect?token=124AbC&language=de
dem Aufruf als
primedocs:connect=https%3A%2F%2Fexample.com%2Fconnect%3Ftoken%3D124AbC%26language%3Dde
übergeben werden.

Bei Verwendung einer URL wird die Einstellung keepConnect ignoriert.

TemplatePicker

Der TemplatePicker wird angezeigt, wenn:

• kein Template-Element angegeben wurde
• oder der Tag-Filter mehrere Vorlagen hervorbringen würde und AllowTemplatePicker="true" definiert wurde.

Forms-Dialog überspringen

Standardmässig wird bei einem Connect-Aufruf der Forms-Dialog angezeigt. Sollen keine Eingaben abgefragt werden, weil alle Werte bereits aus dem Connect stammen, lässt sich der Dialog über das Attribut HideDialogOnConnect="true" der FormsConfiguration unterdrücken. Die Validierung läuft dann direkt, alle anderen Aufrufwege bleiben unverändert.

---

Serverseitige Verarbeitung

primedocs Connect kann serverseitig über die Web API genutzt werden: Connect API