Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core workflow 3.0 > Übersicht vorhandener Knoten


Knoten „Dokument signieren“ verwenden

Hinweis: Diese Dokumentation bezieht sich auf die aktuellste Version des Plugins agorum core insign. Aktualisieren Sie das hier beschriebene Plugin, um die Dokumentation verwenden zu können.

Interne ID: agorum.insign.sign

Mit diesem Knoten können Sie Dokumente an den Signaturanbieter inSign übergeben, um die Dokumente von einer oder mehreren Personen elektronisch signieren zu lassen.

Der Workflow-Knoten für das Signieren von Dokumenten mit inSign ermöglicht es Benutzern, elektronische Signaturen in einen automatisierten Prozess zu integrieren. Sobald ein Dokument zur Signatur bereitsteht, sendet der Knoten es an inSign, wo die Signaturanforderung erzeugt wird. Der Empfänger erhält eine Benachrichtigung und kann das Dokument online einsehen und signieren.

Sie haben verschiedene Möglichkeiten anzugeben, an welcher Stelle des Dokuments sich ein Signaturfeld befindet und wer signieren soll. Diese Angaben können entweder komplett in inSign erfolgen oder durch den Workflow-Knoten über die Parameter Empfänger und Parameter mitgegeben werden.

Nach erfolgreicher Signatur wird das Dokument durch einen agorum core insign-Worker von inSign heruntergeladen und als neue Version an das Objekt angefügt. Die Aufgabe des Knotens ist daher nur, die inSign-Session zu erstellen. Die weitere Überprüfung des Dokumentstatus in inSign erfolgt nicht durch den Workflow-Knoten, sondern durch einen Worker.

Es gibt einen weiteren Knoten, um inSign-Sessions bzw. Signaturanfragen abzubrechen.

 

Aussehen des Knotens

Verhaltensweise


Erreicht das System den Knoten im Workflow, prüft das System die vorhandenen Angaben und erstellt auf Basis der Angaben eine inSign-Session mit den Dokumenten der Eingangsvariablen. Die Dokumente können in inSign durch die Empfänger unterschrieben werden.

Endpoints


Standard Veränderbar? Weitere Endpoints möglich?
Default (Inlet) Nein, kann nur ausgeblendet werden. nein, nicht nötig
Default (Outlet) Nein, kann nur ausgeblendet werden. nein, nicht nötig

Parameter


Sie sehen ein Beispiel für mögliche Parameterangaben im folgenden Screenshot:

 

Mögliche Parameterangaben für den sign-Knoten

Weitere Beispiele für Angaben für Empfänger und Parameter finden Sie in der Beschreibung der Bibliothek.

Parameter Beschreibung Beispiel
Name Mit diesem Parameter geben Sie den Namen des Signiervorgangs anDieser Name wird unter anderem in der durch inSign versendeten E-Mail an die Empfänger verwendet. Sie müssen einen Namen angeben. Testsignaturvorgang
Benutzer Sie können einen Benutzer in der Liste auswählen, in dessen Kontext die Signatur durchgeführt werden soll. Wenn Sie keinen Benutzer explizit angeben, wird der Benutzer verwendet, der den Workflow ausführt. Die Angabe ist also optional.  
Empfänger

Geben Sie optional diejenigen an, die das Dokument elektronisch signieren sollen. Die hier angegebenen E-Mail-Empfänger werden mit dem Dokument an inSign übermittelt. inSign verschickt E-Mails mit der Aufforderung zur elektronischen Signatur an die angegebenen E-Mail-Adressen.

Sie können über die Datenfelder die POST-Anfrage zusammenstellen, die an inSign geschickt wird. Für die Anfrage benötigen Sie mindestens das Objekt externUsers mit den E-Mail-Adressen der Empfänger als Schlüssel-Wert-Paare. Daneben stehen Ihnen weitere Angaben zur Verfügung, über die Sie den Inhalt der E-Mail und die Reihenfolge der Unterschriften steuern können. Die Dokumentation aller möglichen Felder finden Sie hier.

Wenn Sie die Empfänger als Expression angeben, muss das Ergebnis der Expression den Namen des Signiervorgangs beinhalten.

{
    "externUsers": [
      {
        "recipient": "test.user1@agorum.com",
        "sendEmails": true,
        "roles": [
          "Role1"
        ]
      },
      {
        "recipient": "test.user2@agorum.de",
        "sendEmails": true,
        "roles": [
          "Role2"
        ]
      }
    ],
    "inOrder": true
 }
Parameter

Sie können optional weitere Parameter zu den zu unterschreibenden Dokumenten und weitere Angaben für die inSign-Session mitgeben. Mit diesen Parametern können Sie die POST-Anfrage erweitern.

Mit den zusätzlichen Parametern können Sie etwa über das Objekt documents angeben, an welcher Stelle im Dokument die Empfänger unterschreiben sollen. Dazu haben Sie verschiedene Möglichkeiten: 

  • Sie können die geeignete Position über eine Textsuche (textsearch) angeben. Wenn Sie diese Möglichkeit verwenden, empfiehlt es sich, diesen Text nur einmal im Dokument zu verwenden und ggf. als weißen Text zu positionieren. Sonst werden die Unterschriften eventuell nicht richtig positioniert.
  • Sie können die Position für die Unterschrift durch Angabe der Koordinaten (x0, y0) auf der PDF-Seite (page, Wert 0-basierend) und der Breite (w) und Höhe (h) des Unterschriftenfelds genau angeben.

Die Dokumentation aller möglichen Parameter finden Sie hier.

Wenn Sie den Parameter als Expression angeben, muss das Ergebnis der Expression den Namen des Signiervorgangs beinhalten.

{
    "documents": [
      {
        "scanSigTags": false,
        "signatures": [
          {
            "role": "Role1",
            "id": "1",
            "textsearch": "Unterschrift Partei A",
            "required": true
          },
          {
            "role": "Role2",
            "id": "2",
            "textsearch": "Unterschrift Partei B",
            "required": true
          }
        ]
      }
    ]
 }
Eingangsvariable

Mit der Eingangsvariablen geben Sie das PDF-Dokument an, das in inSign signiert werden soll.

Der Parameter Eingangsvariable enthält ein Array von Elementen, die mit diesem Knoten verarbeitet werden sollen. Wird die Variable leer gelassen, werden automatisch die Attachments des Workflows genommen. Diese Attachments sind in der internen Variable sys_acw_attachments vorhanden.

Für die generelle Schreibweise von Variablen im Editor oder als Expression siehe Schreibweise von Variablen.

documentToBeSigned
Datenvariable

Die Datenvariable beinhaltet die Session-Informationen, die von inSign zurückgegeben werden. Das sind die Session-ID und der Session-Link.

Im Editor geben Sie den Namen der Workfllow-Variablen an, in der der Link und die Session-ID abgespeichert werden.

Wenn Sie den Parameter als Expression angeben, muss das Ergebnis der Expression den Namen der Variable beinhalten.

Für die generelle Schreibweise von Variablen im Editor oder als Expression siehe Schreibweise von Variablen.

sessionInfo

Beispiel für den Wert:

  "sessionInfo": {
    "inSignLink": "https://connect.test.getinsign.show/index?sessionid=094ffeeaffe1936a921e19d",
    "inSignSessionId": "094ffeeaffe1936a921e19d"
  },
Rechte Siehe Rechte auf Knoten vergeben  

Tipp: Verwenden Sie die Variablenauswahl, um einen Überblick über alle nutzbaren Variablen zu erhalten.