CIB doXiview - Beschreibung der Start Parameter

Dokument aktualisieren

CIB doXiview bietet verschiedene Wege, Dokumente im Quell-Repository zu aktualisieren. Oft ist es dazu auch notwendig, die integrierende Anwendung über die Aktualisierung zu informieren. Wie und wo ein Dokument abgelegt oder aktualisiert werden soll, wird über den Parameter documentVersionUpdateMode bestimmt. Abhängig von dem gesetzten Wert, sind ggf. weitere Parameter notwendig.

Name des Integrators
Ablage im webstore
E-Mail Versand
Ablage per HTTP


Name des Integrators

Der Parameter integratorName legt den Namen der integrierenden Anwendung fest. Er wird verwendet, um dem Benutzer aussagekräftigere Benachrichtigungen anzuzeigen.

Parameter

Erlaubte Werte

integratorName

Der Name des Integrators. Erforderlich, falls der Modus auf email oder camunda gesetzt ist.


Ablage im webstore

Die Aktualisierung über den webstore Dienst ist die einfachste Art, ein Dokument zu aktualisieren. CIB doXiview legt die neue Dokument-Version im webstore ab, und übergibt der integrierenden Anwendung die generierte webstoreID. Der Integrator kann diese ID nutzen, um das neue Dokument abzuholen.

Parameter

Erlaubte Werte

documentVersionUpdateMode

webstore


E-Mail Versand

Das aktualisierte Dokument kann auch per E-Mail versendet werden.

Parameter

Erlaubte Werte

documentVersionUpdateMode

email

documentVersionUpdateMail

Eine, oder mehrere E-Mail Adressen (getrennt durch Komma oder Semikolon), an welche neue Dokumentversionen gesendet werden sollen.

documentVersionUpdateSubject

Der Betreff der E-Mail

 

Ablage per HTTP

Das aktualisierte Dokument kann per http POST direkt an einen festgelegten Server gesendet werden. Optional können zusätzliche HTTP Header Felder definiert werden, welche beim Speichern der neuen Dokumentversion mit der Anfrage gesendet werden.
Somit können beispielsweise Authentifizierungs-Informationen übertragen werden.

Parameter

Erlaubte Werte

documentVersionUpdateMode

http, camunda

documentVersionUpdateUrl

Ein HTTP(S)-URL an dem die neue Dokumentversion gesendet wird.

httpParameters

Eine Komma separierte Liste mit HTTP-header Feldern als Key-Value Paare („key:value, key:value, ...“)