...
Zwei Dateiendungen sind in Windows mit dem primedocs-Client bereits verknüpft:
Dateiendung | Beschreibung |
---|---|
.pdcx | Beinhaltet 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 Connect-Datei wird nach der Verarbeitung nicht gelöscht. |
.oocx | Legacy: gleich wie .pdcx |
.oock | Legacy: gleich wie .pdck |
...
Clientseitiger Aufruf über Konsole
...
Falls keine oder keine eindeutige Vorlage im XML für den Aufruf definiert wurde, dann erscheint der TemplatePicker. Das passiert, wenn
keine Template-Id und kein Tag-Filter gesetzt sind
oder der Tag-Filter mehr als ein Resultat zurückgibt.
...
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
ACHTUNG |
...
Resultat
Über Commands können einzelne Dokumente (oder im Fall der Batch-Verarbeitung das Endresultat als Ganzes) konvertiert oder gespeichert werden. Im Fall des Server-Aufrufs wird bei erfolgreicher Ausführung als Response auf den API-Call immer das fertige Dokument zurückgeliefert. Bei nicht erfolgreicher Verarbeitung wird der Server, abhängig von der Schwere des aufgetretenen Fehlers, einen 400-Bad-Request
oder einen 500-Internal-ServerError
Statuscode zurückgeben. Aus Sicherheitsgründen werden bei dieser Response in den meisten Fällen keine Details mitgeliefert. Diese müssen im Server Log der Connect-API eingesehen werden (über das Dashboard, oder direkt auf dem Dateisystem des Servers).
Im Fall der Batch-Verarbeitung muss das Merge-Command auf Batch-Ebene zwingend angegeben werden. Ist dies nicht angegeben, so wird der Server mit Statuscode 400-Bad-Request
und der Fehlermeldung, dass das Merge-Command angegeben werden muss, antworten.
...
HINWEIS
Die Gross-/Kleinschreibung wird beim Argumentnamen ignoriert.
Mögliche Argumente sind:
Argument | Typ | Beschreibung |
---|---|---|
ActivateAddIn | string | Aktiviert das angegebene (ProgID) primedocs-AddIn. |
Clean | - | primedocs beenden und den Cache löschen |
Connector | string | Dateipfad auf Connector-XML |
CreateConnectorResult | - | Erstellt eine XML-Datei mit dem Resultat des Connector-Aufrufs. |
CreateConnectorResultOnError | - | Erstellt eine XML-Datei mit dem Resultat des Connector-Aufrufs beim Auftreten eines Fehlers. |
DatasourceId | guid | ID der Datenquelle, die verwendet werden soll |
DLCID | int | Auswahl der Dokumentsprache |
ForceRestart | int | Neustart erzwingen |
Help | - | Zeigt die Hilfe an. |
Hidden | - | Startet primedocs ohne die Shell zu zeigen. Die Anwendung wird nicht sichtbar gestartet. Der Startbildschirm wird beim ersten Start angezeigt. |
string | Definiert das Format des Connector-XML. | |
InterfaceVersion | string | Definiert die Version des Connector-XML. |
KeepConnector | - | Die Connector-Datei wird nicht automatisch gelöscht. |
New | guid | Öffnet ein Dokument in Abhängigkeit einer bestimmten Vorlage. Parameter: Template-Id als GUID. |
OutputUrl | string | Speicherpfad für Dokumente, die im SharePoint gespeichert werden sollen |
ProfileId | guid | Vorgewählte ProfileID |
Show | - | Ob der Client angezeigt werden soll |
Shutdown | - | primedocs beenden |
Silent | - | Unterdrückt den Startbildschirm. |
Uri | string | Windows Protocol URI. Beispiel: primedocs:hidden. |
ValidateConnector | - | Die Connector-Datei wird vor dem Ausführen validiert. |
Argument | Parameter | Beschreibung | Windows-Befehle (WIN+ R) | HTML-Link | Shell |
---|---|---|---|---|---|
Clean | - | primedocs beenden und den Cache löschen | ✓ | ✓ | ✓ |
Connector | string | Dateipfad auf Connector-XML | ✓ | X | ✓ |
InterfaceType | string | Definiert das Format des Connector-XML. | |||
KeepConnector | - | Die Connector-Datei wird nicht automatisch gelöscht. | |||
InterfaceVersion | string | Definiert die Version des Connector-XML. | |||
CreateConnectorResult | - | Erstellt eine XML-Datei mit dem Resultat des Connector-Aufrufs. | |||
CreateConnectorResultOnError | - | Erstellt eine XML-Datei mit dem Resultat des Connector-Aufrufs beim Auftreten eines Fehlers. | |||
Hidden | - | Startet primedocs ohne die Shell zu zeigen. Die Anwendung wird nicht sichtbar gestartet. | ✓ | ✓ | ✓ |
New | guid | Öffnet ein Dokument in Abhängigkeit einer bestimmten Vorlage. Parameter: Template-Id als GUID. | ✓ | ✓ | ✓ |
ProfileId | guid | Vorgewählte ProfileID | |||
DLCID | int | Auswahl der Dokumentsprache | |||
Show | - | Ob der Client angezeigt werden soll | ✓ | X | ✓ |
DatasourceId | guid | ID der Datenquelle, die verwendet werden soll | |||
Shutdown | - | primedocs beenden | ✓ | ✓ | ✓ |
Silent | - | Unterdrückt den Startbildschirm. | ✓ | ✓ | ✓ |
Help | - | Zeigt die Hilfe an. | X | X | ✓ |
ActivateAddIn | string | Aktiviert das angegebene (ProgID) primedocs-AddIn. | |||
Uri | string | Windows Protocol URI. Beispiel: primedocs:hidden. | |||
ValidateConnector | - | Die Connector-Datei wird vor dem Ausführen validiert. | |||
ForceRestart | int | Neustart erzwingen | |||
OutputUrl | string | Speicherpfad für Dokumente, die im SharePoint gespeichert werden sollen |
...
Aufruf über den Protokoll-Handler
...
Code Block | ||||
---|---|---|---|---|
| ||||
<a href="primedocs:show">Zeige/Öffne primedocs Client</a> <br /> <a href="primedocs:hidden">Verstecke primedocs Client</a> <br /> <a href="primedocs:new=1d93046c-b3a2-4e96-ab5f-5b9b60afa86e">Öffne Vorlage mit ID 1d93046c-b3a2-4e96-ab5f-5b9b60afa86e</a> <br /> <a href="primedocs:clean">Cache zurücksetzen</a> <br /> |