Dokument teilen (Sharing Cases)

Ein Dokument, welches in signoSign/Universal gespeichert ist, kann mit der Sharing Case Funktion mit externen Personen geteilt werden. Die Person muss nicht in signoSign/Universal registriert sein.

Was ist ein Sharing Case

Ein Sharing Case ist ein dauerhaft gespeichertes Element in der Datenbank. Es kann erstellt, bearbeitet und gelöscht werden. Ein Sharing Case ist mit einem Dokument verknüpft. Pro Dokument können beliebig viele Sharing Cases erstellt werden.

Existiert ein Sharing Case für ein Dokument, so kann das Dokument ohne Authentifizierung im signoSign/Universal Viewer geöffnet, bearbeitet und gespeichert werden. Der Zugriff kann optional durch ein Passwort geschützt werden.

Ein Sharing Case hat folgende Attribute:

Attribut	Typ	Beschreibung
accessId	`string`	Der Identifier des Sharing Case, der in der URL mit dem Parameter s angegeben wird. Der Identifier muss Systemweit eindeutig sein.
documentId	`string`	Der Identifier des Dokuments, welches mit dem Sharing Case verknüpft ist.
password	`string`	Das optionale Passwort, dass eingegeben werden muss, wenn der Sharing Case geöffnet wird. Dieses kann nicht gleichzeitig mit der tanAddressee verwendet werden.
emailAddressee	`string`	Eine optionale E-Mail-Adresse, an die der Link zum Sharing Case geschickt werden soll.
smsAddressee	`string`	Eine optionale Telefonnummer, an die eine SMS mit dem Link zum Sharing Case geschickt werden soll.
comment	`string`	Ein optionaler Freitext, der den Sharing Case beschreibt.
tanAddressee	`string`	Eine optionale Authentifizierungsmethode, die entweder eine E-Mail oder eine SMS enthält. Diese kann nicht gleichzeitig mit dem password verwendet werden.
documentConfiguration	`object`	Eine optionale Konfiguration für Dokumente, die in den signoSign/Universal Viewer geladen werden.

Sharing Case erstellen

Der signoSign/Universal Viewer bietet einen Toolbar Button, mit dem ein Sharing Case für das geöffnete Dokument erstellt werden kann. Die Sichtbarkeit des Buttons wird mit der Einstellung web.sharingButtonVisibility festgelegt. Der Button wird deaktiviert dargestellt, wenn die Sharing Case Funktion mit der Einstellung persistence.documentSharing deaktiviert ist.

Mit der REST-API Ressource sharingcases können Sharing Cases erstellt, bearbeitet und gelöscht werden. Auch die vom signoSign/Universal Viewer erstellten Sharing Cases können bearbeitet werden.

Sharing Case öffnen

Ein Sharing Case wird mit einer speziellen URL geöffnet. Die URL kann beliebig oft aufgerufen werden und ist bis zum Löschen oder Abschluss des Sharing Case gültig.

Die URL zum Sharing Case ist über die REST-API abrufbar und berücksichtigt bei der Generierung die ssmPublicUrl-Einstellung.

Aufbau der Sharing Case URL

Aufgrund von eventuellen Änderungen am Aufbau der URL wird immer empfohlen die URL über die REST-API abzurufen. Soll die REST-API jedoch kein Bestandteil einer Integration sein, ist hier der Aufbau der URL dokumentiert. Es wird darauf hingewiesen, dass es bei einer solchen Integration zu Migrationsaufwänden bei Updates kommen kann.

URL Format:
[HOST]/signoSignUniversal/webvieweropen?action=sharedviewer&u=[USERNAME]&s=[ACCESSID]

URL Parameter:

Parameter	Beschreibung
u	Der Name des registrierten signoSign/Universal Benutzers, mit dem das Dokument geöffnet wird. Der Benutzer muss Zugriff auf das Dokument haben. Beispiel: `u=john_doe`
s	Die `accessId`, die beim Erstellen des Sharing Case festgelegt wurde. Beispiel: `s=myAccessId_1`

Sharing Case abschließen

Ein Sharing Case gilt als abgeschlossen, wenn der Empfänger das Dokument entweder fertiggestellt oder abgelehnt hat. Sobald der Empfänger das Dokument öffnet, kann er es über eine Schaltfläche "Fertigstellen" abschließen. Einzige Voraussetzung ist, dass alle Pflichtfelder unterschrieben sind. Enthält das Dokument keine Pflichtfelder, kann der Empfänger das Dokument auch ohne Signatur abschließen. Sofern die aktuelle Konfiguration dies vorsieht, kann ein Empfänger ein Dokument auch unter Angabe eines Grundes ablehnen.

Sofern SMTP-Einstellungen hinterlegt wurden und der Benutzername des teilenden Benutzers einer gültigen E-Mail-Adresse entspricht, wird der Benutzer mit einer entsprechenden E-Mail über den Abschluss des Vorgangs informiert.

Sharing Case ablehnen

Die Ablehnung von Dokumenten kann entweder global über die Konfiguration oder für bestimmte Dokumente über einen entsprechenden Dokumententyp aktiviert werden.

Sharing Case zwischenspeichern

Es ist möglich, dem Empfänger eines geteilten Dokuments die Möglichkeit zu geben, das Dokument zu einem späteren Zeitpunkt weiter zu bearbeiten. Dazu wird das Dokument nicht abgeschlossen, sondern zwischengespeichert. Das Zwischenspeichern kann entweder global über die Konfiguration oder für bestimmte Dokumente über einen entsprechenden Dokumententyp aktiviert werden.