Versions Compared

Key

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

...

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 .oocxpdcx, 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

...

Falls keine oder keine eindeutige Vorlage im XML für den Aufruf definiert wurde, dann erscheint der TemplatePicker. Das passiert, wenn

...

Note

WICHTIG
Der TemplatePicker wird asynchron ausgeführt. Er sollte nur verwendet werden, wenn nur genau ein Eintrag im Batch vorhanden ist.

...

Aufruf über den DocumentCreationServer Document Creation Server (DCS)

Um über den DCS ein Dokument zu erstellen, muss die Connect-API angesprochen werden. Diese kann unter {ServerAddress}/connect/api/v1/connect aufgerufen werden. Mit {ServerAddress}/connect/ kann die allgemeine Beschreibung der API eingesehen werden. Die API nimmt als Body ein Connect-XML entgegen. Die Anmeldung am Server funktioniert über die Basic Authentication mit dem Format username:password als Base64-String. Benutzername und Passwort entsprechen dem Eintrag "basicAuth" in der serverseitigen OneOffixx.config.

...

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.

InterfaceType

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
(Pfad zu XML-File)

Dateipfad auf Connector-XML

X

InterfaceType
(Zusätzliches Argument für Connector)

string
(Name des Interfaces)

Definiert das Format des Connector-XML.

KeepConnector
(Zusätzliches Argument für Connector)

-

Die Connector-Datei wird nicht automatisch gelöscht.

InterfaceVersion
(Zusätzliches Argument für Connector)

string
(Versionsnummer)

Definiert die Version des Connector-XML.

CreateConnectorResult
(Zusätzliches Argument für Connector)

-

Erstellt eine XML-Datei mit dem Resultat des Connector-Aufrufs.

CreateConnectorResultOnError
(Zusätzliches Argument für Connector)

-

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.
Der Startbildschirm wird beim ersten Start angezeigt, wenn primedocs beendet ist,
wenn es geöffnet ist wird das Fenster gschlossen.

New

guid
GUID der Vorlage

Öffnet ein Dokument in Abhängigkeit einer bestimmten Vorlage. Parameter: Template-Id als GUID.

ProfileId
(Zusätzliches Argument für New)

guid
GUID des Profils

Vorgewählte ProfileID

DLCID
(Zusätzliches Argument für New)

int
LCID-Nummer

Auswahl der Dokumentsprache

Show

-

Ob der Client angezeigt werden soll

X

DatasourceId
(Zusätzliches Argument für Show)

guid
GUID der DataSource

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

...

Bei der Installation von primedocs, wird standardmässig ein Protokoll-Handler mitinstalliertmit installiert. Der Protokoll Handler erlaubt es, dass primedocs direkt über einen Link im Browser aufgerufen werden kann.

...