--- version: "v4.0.5" language: "de" --- # signoAPI Java (Windows & Linux) Das signoAPI Java enthält Software-Komponenten zur Anzeige, Signierung und Bearbeitung von PDF-Dokumenten. Dieses Dokument bietet den Einstieg in die API, indem alle Informationen zu den technischen Möglichkeiten und Anforderungen beschrieben sind. * [Schnittstellenbeschreibung](https://docs.signotec.com/de/signoapi-java-windows-linux/latest/signoapi-java-schnittstellenbeschreibung.md) * [Systemvoraussetzungen](https://docs.signotec.com/de/signoapi-java-windows-linux/latest/signoapi-java-systemvoraussetzungen.md) * [Allgemeine Hinweise](https://docs.signotec.com/de/signoapi-java-windows-linux/latest/signoapi-java-allgemeine-hinweise.md) * [Dokumente anzeigen](https://docs.signotec.com/de/signoapi-java-windows-linux/latest/signoapi-java-dokumente-anzeigen.md) * [Dokumente signieren](https://docs.signotec.com/de/signoapi-java-windows-linux/latest/signoapi-java-dokumente-signieren.md) * [Dokumente bearbeiten](https://docs.signotec.com/de/signoapi-java-windows-linux/latest/signoapi-java-dokumente-bearbeiten.md) --- version: "v4.0.5" language: "de" --- # signoAPI Java - Allgemeine Hinweise ## Major Upgrades Dieses Kapitel enthält wichtige Informationen zum Update zwischen Major Versionen der signoAPI Java. Es beschreibt die Änderungen, durch die ein Projekt nach dem Update der API nicht mehr kompilierbar ist. **Version 3.x auf 4.x** * Veraltete (`@Deprecated`) Methoden und Klassen entfernt. Entfernen Sie deren Verwendung *vor* dem Upgrade der API. * Minimale Java Version erhöht von JavaSE 7 auf JavaSE 8. * Die Bibliotheken `signopdf-viewer.jar`, `signopdf-signer.jar` und `signopdf-utilities.jar` wurden zu `signopdf-lib.jar` zusammengefasst. * Doppelte Klasse `de.signotec.pdf.signer.dto.RectangleDTO` entfernt. Stattdessen wird `de.signotec.pdf.utilities.dto.RectangleDTO` verwendet. * Doppelte Klasse `de.signotec.pdf.utilities.enums.SubFilter` entfernt. Stattdessen wird `de.signotec.pdf.signer.enums.SubFilter` verwendet. * Klasse `de.signotec.pdf.utilities.dto.SignatureFieldDTO.SignatureStatus` entfernt. Stattdessen wird `de.signotec.pdf.signer.enums.FieldStatus` verwendet. * Bibliothek iText wurde durch Apache PDFBox ersetzt. * Feature Multi-Signatur-Fenster (nur signotec Alpha Pads) wurde entfernt. * Die Methoden `SignoPdfSignerSTPad.initSignature()` mit Array-Parametern wurden entfernt. Wechseln Sie auf die Methoden ohne Array-Parameter. * Der Rückgabewert der Methoden `SignoPdfSignerSTPad.confirmSignature()` wurde von `int[]` auf `int` geändert. **Version 2.x auf 3.x** Enthält Major Update der signoPAD-API von 8.x auf 9.x. Siehe Kapitel „Major Upgrades" in Datei „signoPAD-API Java Dokumentation DE.pdf" im Auslieferungspaket. * Veraltete (`@Deprecated`) Methoden und Klassen entfernt. Entfernen Sie deren Verwendung *vor* dem Upgrade der API. * Minimale Java Version erhöht von JavaSE 6 auf JavaSE 7. * Klasse `de.signotec.pdf.signer.Base64` entfernt. Stattdessen wird `org.bouncycastle.util.encoders.Base64` verwendet. * Klasse `de.signotec.pdf.viewer.DocumentInfoDTO` verschoben nach `de.signotec.pdf.viewer.dto.DocumentInfoDTO`. * Klasse `de.signotec.pdf.viewer.PrinterDTO` verschoben nach `de.signotec.pdf.viewer.dto.PrinterDTO`. * Exception `de.signotec.pdf.signer.exceptions.InvalidParameterException` und `de.signotec.pdf.utilities.exception.InvalidParameterException` entfernt. Stattdessen wird `java.lang.IllegalArgumentException` verwendet. * Exception `de.signotec.pdf.signer.exceptions.NotImplementedException` entfernt. Stattdessen wird `java.lang.UnsupportedOperationException` verwendet. * Exception `de.signotec.pdf.signer.exceptions.NoCapturingException` entfernt. Stattdessen wird `java.lang.IllegalStateException` verwendet. * Exception `de.signotec.pdf.utilities.exception.SignoPdfUtilititesException` umbenannt in `SignoUtilitiesException`. * Exception `de.signotec.pdf.viewer.exceptions.CouldNotSaveException` entfernt. Stattdessen wird `java.io.IOException` verwendet. * Methoden werfen jetzt auch Java Standard-Exceptions inkl. Unchecked Exceptions: * `java.lang.IllegalArgumentException` bei ungültigen Parametern * `java.lang.IllegalStateException` wenn eine Funktion im aktuellen Status nicht ausgeführt werden kann (z.B. wenn ein Unterschriftenprozess beendet werden soll, der zuvor nicht gestartet wurde) * `java.lang.UnsupportedOperationException` wenn die Funktion von dem Signaturgerät oder der Fassade (signoPAD-API Java) nicht unterstützt wird * `java.io.IOException` bei I/O Fehlern * `java.security.SignatureException` bei Verarbeitung von biometrischen Daten und Fehlern in Kryptographie Funktionen * Methodenparameter vom Typ `java.io.InputStream` und `java.io.OutputStream` werden von der API nicht mehr geschlossen. ## Lizenzschlüssel Die signoAPI Java wird im unregistriertem Zustand ausgeliefert. In diesem Zustand sind einige Funktionen mit einem Demostempel versehen (z.B. Wasserzeichen „signotec Demo" in PDFs). Um den vollen Funktionsumfang der signoAPI nutzen zu können, ist es notwendig einen Lizenzschlüssel bei der signotec GmbH zu erwerben. Es existieren dabei zwei unterschiedliche Arten von Lizenzschlüsseln: 1. **Hardwaregebundene Einzelplatzlizenzen:** Bei der Installation wird ein Autorisationsschlüssel (Software Code) generiert. Dieser ist an bestimmte Komponenten der Hardware gebunden und ist immer nur für einen Rechner gültig (Einzelplatz). Mittels des mitgelieferten Programms `license-tool/license-tool.exe` kann nach Erwerb einer Einzelplatzlizenz ein Lizenzschlüssel beantragt und eingetragen werden. Ist ein gültiger Lizenzschlüssel vorhanden, so wird dieser in der Registry des Computers hinterlegt und alle Komponenten der signoAPI Java sind damit vom Demostempel befreit. 2. **Hardwareunabhängige Unternehmenslizenzen:** Diese sind nicht an einen Rechner/Arbeitsplatz gebunden und der Schlüssel wird nicht in der Registry hinterlegt. Stattdessen muss der Lizenzschlüssel vor Verwendung der Komponente per Methode `SignoViewer.setSerialKey()`, `SignoPdfSigner.setSerialKey()` bzw. `SignoPdfUtils.setSerialKey()` gesetzt werden. ## Einschränkungen der Demo-Version Bei Verwendung der signoAPI Java als Demo-Version wird auf jeder Seite eines geladenen Dokumentes ein Wasserzeichen eingeblendet, das auf den Demo-Modus hinweist. Außerdem ist das Laden und Anzeigen von Dokumenten, die durch ein Kennwort geschützt sind, in der Demo-Version nicht möglich. Wird ein Dokument mit der Demo-Version des signoAPI Java signiert, wird ein entsprechendes Wasserzeichen hinter der Unterschrift eingebettet. Wird mit der Demo-Version der signopdf-utilities Bibliothek ein Unterschriftenfeld mit der Methode `addSignatureField()` erzeugt, wird an den Feldnamen `_signotec_demo` angehängt. ## Keystores und Zertifikate Die mitgelieferten Keystores `signing.ks` und `encryption.ks` sowie das Zertifikat `encryption.cer` sind nur zu Demonstrationszwecken enthalten. Sie haben alle das Passwort `password`. Das Erzeugen eigener Keystores und Zertifikate ist mit dem Java-Keytool möglich. ## Sicherheitskritische Daten Passwörter und private Schlüssel gehören zu den sicherheitskritischen Daten und müssen mit besonderer Sorgfalt behandelt werden. Bei Verwendung dieser API sollten Sie neben den gängigen Sicherheitsstandards folgendes beachten: * **Für Passwörter nur überschreibbare Datenstrukturen verwenden.** Die signoAPI Java verwendet den Datentyp `char[]`. Die Daten eines unveränderlichen Typs wie `String` können nicht gezielt überschrieben bzw. gelöscht werden und verbleiben u.U. sehr lange im Arbeitsspeicher. * **Passwörter unmittelbar nach Verwendung löschen.** Um das Zeitfenster für das Auslesen von Passwörtern aus dem Arbeitsspeicher so kurz wie möglich zu halten, sollten sie sofort nach Verwendung überschrieben werden. Die signoAPI Java bietet dafür eine entsprechende Methode. * **Private Schlüssel unmittelbar nach Verwendung löschen.** Seit Java 8 sollten Schlüssel, die das `Destroyable` Interface implementieren, mit der Methode `destroy()` im Speicher überschrieben/unkenntlich gemacht werden, sobald sie nicht mehr benötigt werden. --- version: "v4.0.5" language: "de" --- # signoAPI Java - Dokumente anzeigen Eine Hauptkomponente ist die Klasse `de.signotec.pdf.viewer.SignoViewer`. Es handelt sich hierbei um ein visuelles Steuerelement auf Basis eines JPanel zur Anzeige von PDF Dokumenten. Es bietet eine flexibel einstellbare Toolbar mit Navigations-, Zoom- und Druckfunktion. **Diese Komponente wird nicht mehr gepflegt und wird in zukünftigen Releases entfernt!** --- version: "v4.0.5" language: "de" --- # signoAPI Java - Dokumente bearbeiten Eine weitere Hauptkomponente ist die Klasse `de.signotec.pdf.utilities.SignoPdfUtils`, mit der Dokumente bearbeitet werden können. Im Funktionsumfang enthalten ist: * das Einfügen von Signaturfeldern und Bildern * das Flatten von Signaturfeldern * das Suchen nach Text für die Positionierung von Signaturfeldern --- version: "v4.0.5" language: "de" --- # signoAPI Java - Dokumente signieren Eine weitere Hauptkomponente ist die Klasse `de.signotec.pdf.signer.SignoPdfSigner` mit ihren abgeleiteten Klassen `de.signotec.pdf.signer.SignoPdfSignerSTPad` und `de.signotec.pdf.signer.SignoPdfSignerCustom`. Es handelt sich hierbei um Klassen, die Methoden für das Auslesen von Informationen über Signaturfelder in PDF-Dokumenten sowie für das Signieren dieser Felder bieten. ## SignoPdfSigner Die Klasse `SignoPdfSigner` sollte nur verwendet werden, wenn keine Verzahnung mit der zur Verfügung stehenden signoPAD-API gewünscht ist, z. B. weil die Erfassung der Unterschrift auf einem anderen System als das Signieren des Dokuments stattfinden soll (Client/Server-Lösung). Wenn die Erfassung und das Signieren auf demselben System stattfinden soll, sollte aus Sicherheitsgründen immer die Klasse `SignoPdfSignerSTPad` verwendet werden. Mit der Methode `SignoPdfSigner.signDocument()` wird das geladene Dokument digital signiert. Eine Ausgabe des Dokumentes ist nicht nötig, wenn weitere Signaturen erfasst werden sollen. Sie kann mehrfach für ein `SignoPdfSigner`-Objekt aufgerufen werden. ### Verschlüsseln im Signaturgerät Wenn ein Pad angeschlossen ist, in dem ein öffentlicher Schlüssel für die Verschlüsselung gespeichert ist, können die biometrischen Daten im Gerät verschlüsselt werden. Somit ist auf dem PC kein öffentlicher RSA-Schlüssel nötig und die biometrischen Daten werden bereits vor der Übertragung an den PC verschlüsselt. Diese Technologie wird momentan nur unter Windows unterstützt. Java public void signDocument(String fieldName, SigningDTO signData, PrivateKey signingKey, Certificate[] signingCertChain, String bioCertRef, String bioData, SignatureImageDTO image, SignatureDeviceDTO deviceData) ### Verschlüsseln und Signieren der biometrischen Daten im Signaturgerät Wenn ein Pad angeschlossen ist, in dem ein öffentlicher Schlüssel für die Verschlüsselung und ein Schlüsselpaar für die Signierung gespeichert sind, können die biometrischen Daten im Gerät verschlüsselt und signiert werden. Somit ist auf dem PC kein öffentlicher RSA-Schlüssel nötig und die biometrischen Daten werden bereits vor der Übertragung an den PC verschlüsselt. Außerdem kann später die Integrität der biometrischen Daten verifiziert werden. Diese Technologie wird momentan nur unter Windows unterstützt. Java public void signDocument(String fieldName, SigningDTO signData, PrivateKey signingKey, Certificate[] signingCertChain, String bioCertRef, HashType padSignatureType, RSAScheme padSignatureScheme, byte[] padSignature, X509Certificate padSigningCert, String bioData, SignatureImageDTO image, SignatureDeviceDTO deviceData) ### Verschlüsseln im PC Wenn die biometrischen Daten nicht im Signaturgerät verschlüsselt werden, wird die Verschlüsselung beim Aufruf der `signDocument()` Methode durchgeführt. Dafür wird auf dem PC ein Zertifikat mit öffentlichem RSA-Schlüssel benötigt. Diese Funktionalität wird von allen Signaturgeräten unterstützt. Java public void signDocument(String fieldName, SigningDTO signData, PrivateKey signingKey, Certificate[] signingCertChain, X509Certificate bioCert, String bioData, SignatureImageDTO image, SignatureDeviceDTO deviceData) ## SignoPdfSignerSTPad Die Klasse `de.signotec.pdf.signer.SignoPdfSignerSTPad` dient zum Erfassen der Unterschrift mit einem signotec Signierpad oder einem Pen Display und benötigt ein Objekt vom Typ `de.signotec.stpad.api.SigPadApi`. Die Verwendung dieser Klasse ist der empfohlene Weg zur Erfassung einer Unterschrift, da mit ihr alle fortschrittlichen Funktionen der signotec LCD Signature Pads genutzt werden können. Mit der Methode `SignoPdfSignerSTPad.initSignature()` wird das Erfassen der Unterschrift gestartet. Die Methode `startSignature()` des im Konstruktor übergebenen `SigPadApi`-Objektes wird an dieser Stelle ausgelöst. Ist das angegebene Signaturfeld nicht vorhanden, wird es neu erzeugt. In diesem Fall müssen die Angaben `Rectangle` und `Page` des `SigningDTO`-Objektes gesetzt sein. ### Signieren und Verschlüsseln im Signaturgerät Wenn ein Pad angeschlossen ist, in dem ein privater Schlüssel für die Signierung und ein öffentlicher Schlüssel für die Verschlüsselung gespeichert ist, kann das Gerät für die digitale Signierung des Dokuments und für die Verschlüsselung der biometrischen Daten verwendet werden. Somit sind auf dem PC keinerlei RSA-Schlüssel nötig und die biometrischen Daten werden bereits vor der Übertragung an den PC verschlüsselt. Die Technologie wird nur unter Windows und nur von signotec Pads bei Verwendung der SigPadFacade unterstützt. Java public void initSignature(String fieldName, SigningDTO signData) ### Signieren im Signaturgerät, Verschlüsseln im PC Wenn ein Pad angeschlossen ist, in dem ein privater Schlüssel für die Signierung gespeichert ist, kann das Dokument im Gerät digital signiert werden. Somit ist auf dem PC kein privater RSA-Schlüssel nötig. Die Technologie wird nur unter Windows und nur von signotec Pads bei Verwendung der SigPadFacade unterstützt. Java public void initSignature(String fieldName, SigningDTO signData, X509Certificate bioCert) ### Signieren im PC, Verschlüsseln im Signaturgerät Wenn ein Pad angeschlossen ist, in dem ein öffentlicher Schlüssel für die Verschlüsselung gespeichert ist, können die biometrischen Daten im Gerät verschlüsselt werden. Somit ist auf dem PC kein öffentlicher RSA-Schlüssel nötig und die biometrischen Daten werden bereits vor der Übertragung an den PC verschlüsselt. Die Technologie wird nur unter Windows und nur von signotec Pads bei Verwendung der SigPadFacade unterstützt. Java public void initSignature(String fieldName, SigningDTO signData, PrivateKey signingKey, Certificate[] signingCertChain) ### Signieren und Verschlüsseln im PC Diese Funktionalität wird von allen Signaturgeräten unterstützt. Um sie verwenden zu können, müssen auf dem PC ein privater Schlüssel für die Signierung und ein öffentlicher Schlüssel für die Verschlüsselung zur Verfügung stehen. Java public void initSignature(String fieldName, SigningDTO signData, PrivateKey signingKey, Certificate[] signingCertChain, X509Certificate bioCert) ## SignoPdfSignerCustom Mit der Klasse `SignoPdfSignerCustom` können Dokumente mit benutzerdefinierten Signaturen signiert werden. Die Signatur kann bspw. selbst erstellt werden oder durch einen Fernsignatur-Anbieter durchgeführt werden. Die Verwendung der Klasse ist in zwei Schritte unterteilt: 1. Das Dokument wird mit Methode `prepareDocument()` für die Signatur vorbereitet. Das Ergebnis ist ein Hash, der signiert werden muss. Der verwendete Hash-Algorithmus kann durch `getDocumentHashAlgorithm()` abgefragt werden. 2. Die Signatur des signierten Hash wird mit Methode `signDocument()` im vorbereiteten Dokument gespeichert. Nach jedem Schritt kann das Dokument mit `writeDocument()` gespeichert werden. Schritt 2 kann auch ohne die signoAPI Java durchgeführt werden, indem die Signatur in einem reservierten Bereich des Dokuments eingefügt wird. Die Position des Bereiches kann mit Methode `getSignatureOffset()` bestimmt werden. Die Größe des Bereiches wird mit `setSignatureLength()` festgelegt. --- version: "v4.0.5" language: "de" --- # signoAPI Java - Schnittstellenbeschreibung Die Schnittstellenbeschreibung für Programmierer enthält technische Informationen zu den einzelnen Java Klassen. Die Dokumentation im JavaDoc Format befindet sich im Ordner `doc/javadoc` des Auslieferungspakets. --- version: "v4.0.5" language: "de" --- # signoAPI Java - Systemvoraussetzungen ## Betriebssysteme Die signoAPI Java Komponenten sind grundsätzlich unter Windows und Linux lauffähig. Bitte beachten Sie hierzu auch den folgenden Abschnitt „Zusätzliche Komponenten". ### **Linux** #### OpenSSL (libssl) Bei Verwendung der SigPadFacade muss die Bibliothek [OpenSSL](https://www.openssl.org/) (libssl) in Version 3.0 im System installiert sein. #### libusb Bei Verwendung von HID/WinUSB-Geräten wird außerdem eine im System installierte libusb ab Version 1.0.16 benötigt. Außerdem müssen ggf. noch die Berechtigungen für libusb angepasst werden, um signotec Pads ansprechen zu können. Hierzu muss der MODE für USB auf `0666` geändert werden: Bash # libusb device nodes SUBSYSTEM=="usb", ENV{DEVTYPE}=="usb_device", MODE="0666" Anschließend muss udev neugestartet werden: Bash udevadm control --reload-rules In Debian befindet sich diese Einstellung in der Datei `/lib/udev/rules.d/50-udev-default.rules` bzw. `/lib64/udev/rules.d/50-udev-default.rules`. Bei anderen Distributionen kann sich die Einstellung an einem anderen Ort befinden. ## Zusätzliche Komponenten In den folgenden Tabellen sind die Abhängigkeiten dieses APIs aufgeführt: | Abhängigkeit | Bemerkung | |-------------------------------------------|-------------------------------------------------------------------------------------------------------| | lib/bcpkix-jdk18on.jar | - | | lib/bcprov-jdk18on.jar | - | | lib/bcutil-jdk18on.jar | - | | lib/commons-logging.jar | - | | lib/fontbox.jar | - | | lib/graphics2d.jar | - | | lib/jna.jar, lib/jna-platform.jar | - | | lib/jpdfnotes.jar | - | | lib/pdfbox.jar | - | | lib/pdfbox-io.jar | - | | lib/rhino.jar | Nur wenn die Validierung der Formularfelder aktiv ist. | | lib/signopdf-lib.jar | signoAPI Java Bibliothek | | lib/stlic-lib.jar | - | | lib/stpad-lib.jar | signoPAD-API Java Bibliothek | | lib/jni4net.j.jar, lib/jwinpointer-se.jar | Nur bei Verwendung der `PenDisplayFacade` aus der signoPAD-API Java mit der Bibliothek `JWinPointer`. | | lib/jpen.jar | Wenn ein Pen Display verwendet wird. | | lib/jpen.dll | Wenn ein Pen Display unter Windows verwendet wird. | | lib/libjpen.so | Wenn ein Pen Display unter Linux verwendet wird. | | lib/batik/\*.jar | Wenn SVG formatierte Signaturbilder verwendet werden. | | lib/swt/\*.jar | Nur bei Verwendung des SWT Controls `SignatureWidget`. | ## JRE Abhängigkeiten Die signoAPI Java Komponenten benötigen die Java Runtime Environment (JRE) ab Version 1.8. Es werden sowohl die 32 Bit als auch die 64 Bit Version unterstützt. Die folgende Tabelle enthält Internet-Adressen unter denen Java heruntergeladen werden kann. | Version | Download-Adresse | |---------|----------------------------------------------------------------------------------| | Java 8 | | | Java 11 | | | Java 17 | | Alle nicht standardmäßig in der JRE vorhandenen Komponenten werden mitgeliefert. --- version: "v4.0.5" language: "en" --- # signoAPI Java (Windows & Linux) The signoAPI Java contains software components for displaying, signing, and editing PDF documents. This document provides an introduction to the API by describing all information about the technical capabilities and requirements. * [Interface Description](https://docs.signotec.com/en/signoapi-java-windows-linux/latest/signoapi-java-interface-description.md) * [System Requirements](https://docs.signotec.com/en/signoapi-java-windows-linux/latest/signoapi-java-system-requirements.md) * [General Notes](https://docs.signotec.com/en/signoapi-java-windows-linux/latest/signoapi-java-general-notes.md) * [View Documents](https://docs.signotec.com/en/signoapi-java-windows-linux/latest/signoapi-java-view-documents.md) * [Sign Documents](https://docs.signotec.com/en/signoapi-java-windows-linux/latest/signoapi-java-sign-documents.md) * [Edit Documents](https://docs.signotec.com/en/signoapi-java-windows-linux/latest/signoapi-java-edit-documents.md) --- version: "v4.0.5" language: "en" --- # signoAPI Java - Edit Documents Another main component is the class `de.signotec.pdf.utilities.SignoPdfUtils`, which can be used to edit documents. The feature set includes: * inserting signature fields and images * flattening signature fields * searching for text to position signature fields --- version: "v4.0.5" language: "en" --- # signoAPI Java - General Notes ## Major Upgrades This chapter contains important information about updating between major versions of signoAPI Java. It describes the changes that make a project no longer compilable after updating the API. **Version 3.x to 4.x** * Removed deprecated (`@Deprecated`) methods and classes. Remove their usage *before* upgrading the API. * Minimum Java version increased from JavaSE 7 to JavaSE 8. * The libraries `signopdf-viewer.jar`, `signopdf-signer.jar`, and `signopdf-utilities.jar` have been merged into `signopdf-lib.jar`. * Duplicate class `de.signotec.pdf.signer.dto.RectangleDTO` removed. Use `de.signotec.pdf.utilities.dto.RectangleDTO` instead. * Duplicate class `de.signotec.pdf.utilities.enums.SubFilter` removed. Use `de.signotec.pdf.signer.enums.SubFilter` instead. * Class `de.signotec.pdf.utilities.dto.SignatureFieldDTO.SignatureStatus` removed. Use `de.signotec.pdf.signer.enums.FieldStatus` instead. * Library iText has been replaced by Apache PDFBox. * Multi-signature window feature (signotec Alpha Pads only) has been removed. * The `SignoPdfSignerSTPad.initSignature()` methods with array parameters have been removed. Switch to the methods without array parameters. * The return value of the `SignoPdfSignerSTPad.confirmSignature()` methods has been changed from `int[]` to `int`. **Version 2.x to 3.x** Contains a major update of the signoPAD-API from 8.x to 9.x. See the chapter "Major Upgrades" in the file "signoPAD-API Java Documentation DE.pdf" in the delivery package. * Removed deprecated (`@Deprecated`) methods and classes. Remove their usage *before* upgrading the API. * Minimum Java version increased from JavaSE 6 to JavaSE 7. * Class `de.signotec.pdf.signer.Base64` removed. Use `org.bouncycastle.util.encoders.Base64` instead. * Class `de.signotec.pdf.viewer.DocumentInfoDTO` moved to `de.signotec.pdf.viewer.dto.DocumentInfoDTO`. * Class `de.signotec.pdf.viewer.PrinterDTO` moved to `de.signotec.pdf.viewer.dto.PrinterDTO`. * Exception `de.signotec.pdf.signer.exceptions.InvalidParameterException` and `de.signotec.pdf.utilities.exception.InvalidParameterException` removed. Use `java.lang.IllegalArgumentException` instead. * Exception `de.signotec.pdf.signer.exceptions.NotImplementedException` removed. Use `java.lang.UnsupportedOperationException` instead. * Exception `de.signotec.pdf.signer.exceptions.NoCapturingException` removed. Use `java.lang.IllegalStateException` instead. * Exception `de.signotec.pdf.utilities.exception.SignoPdfUtilititesException` renamed to `SignoUtilitiesException`. * Exception `de.signotec.pdf.viewer.exceptions.CouldNotSaveException` removed. Use `java.io.IOException` instead. * Methods now also throw Java standard exceptions including unchecked exceptions: * `java.lang.IllegalArgumentException` for invalid parameters * `java.lang.IllegalStateException` when a function cannot be executed in the current state (e.g. when a signature process is to be terminated that was not previously started) * `java.lang.UnsupportedOperationException` when the function is not supported by the signature device or the facade (signoPAD-API Java) * `java.io.IOException` for I/O errors * `java.security.SignatureException` when processing biometric data and errors in cryptography functions * Method parameters of type `java.io.InputStream` and `java.io.OutputStream` are no longer closed by the API. ## License Keys The signoAPI Java is delivered in an unregistered state. In this state, some functions are marked with a demo stamp (e.g. watermark "signotec Demo" in PDFs). To use the full functionality of the signoAPI, it is necessary to purchase a license key from signotec GmbH. There are two different types of license keys: 1. **Hardware-bound single-user licenses:** During installation, an authorization key (software code) is generated. This is bound to specific hardware components and is always valid for one computer only (single user). Using the supplied program `license-tool/license-tool.exe`, a license key can be requested and entered after purchasing a single-user license. If a valid license key is present, it is stored in the computer's registry and all components of the signoAPI Java are freed from the demo stamp. 2. **Hardware-independent enterprise licenses:** These are not bound to a computer/workstation and the key is not stored in the registry. Instead, the license key must be set before using the component via the method `SignoViewer.setSerialKey()`, `SignoPdfSigner.setSerialKey()`, or `SignoPdfUtils.setSerialKey()`. ## Limitations of the Demo Version When using the signoAPI Java as a demo version, a watermark indicating the demo mode is displayed on every page of a loaded document. Additionally, loading and displaying documents protected by a password is not possible in the demo version. When a document is signed with the demo version of signoAPI Java, a corresponding watermark is embedded behind the signature. When a signature field is created with the demo version of the signopdf-utilities library using the `addSignatureField()` method, `_signotec_demo` is appended to the field name. ## Keystores and Certificates The supplied keystores `signing.ks` and `encryption.ks` as well as the certificate `encryption.cer` are included for demonstration purposes only. They all have the password `password`. Creating your own keystores and certificates is possible with the Java Keytool. ## Security-Critical Data Passwords and private keys are security-critical data and must be handled with particular care. When using this API, you should observe the following in addition to common security standards: * **Use only overwritable data structures for passwords.** The signoAPI Java uses the data type `char[]`. The data of an immutable type like `String` cannot be specifically overwritten or deleted and may remain in memory for a very long time. * **Delete passwords immediately after use.** To keep the time window for reading passwords from memory as short as possible, they should be overwritten immediately after use. The signoAPI Java provides a corresponding method for this. * **Delete private keys immediately after use.** Since Java 8, keys that implement the `Destroyable` interface should be overwritten/erased in memory using the `destroy()` method as soon as they are no longer needed. --- version: "v4.0.5" language: "en" --- # signoAPI Java - Interface Description The interface description for developers contains technical information about the individual Java classes. The documentation in JavaDoc format is located in the `doc/javadoc` folder of the delivery package. --- version: "v4.0.5" language: "en" --- # signoAPI Java - Sign Documents Another main component is the class `de.signotec.pdf.signer.SignoPdfSigner` with its derived classes `de.signotec.pdf.signer.SignoPdfSignerSTPad` and `de.signotec.pdf.signer.SignoPdfSignerCustom`. These are classes that provide methods for reading information about signature fields in PDF documents and for signing these fields. ## SignoPdfSigner The class `SignoPdfSigner` should only be used if no integration with the available signoPAD-API is desired, e.g. because the signature capture should take place on a different system than the document signing (client/server solution). If the capture and signing are to take place on the same system, the class `SignoPdfSignerSTPad` should always be used for security reasons. The method `SignoPdfSigner.signDocument()` digitally signs the loaded document. Output of the document is not necessary if additional signatures are to be captured. It can be called multiple times for a `SignoPdfSigner` object. ### Encryption in the Signature Device If a pad is connected that has a public key for encryption stored in it, the biometric data can be encrypted in the device. This means no public RSA key is needed on the PC and the biometric data is encrypted before being transmitted to the PC. This technology is currently only supported on Windows. Java public void signDocument(String fieldName, SigningDTO signData, PrivateKey signingKey, Certificate[] signingCertChain, String bioCertRef, String bioData, SignatureImageDTO image, SignatureDeviceDTO deviceData) ### Encryption and Signing of Biometric Data in the Signature Device If a pad is connected that has a public key for encryption and a key pair for signing stored in it, the biometric data can be encrypted and signed in the device. This means no public RSA key is needed on the PC and the biometric data is encrypted before being transmitted to the PC. In addition, the integrity of the biometric data can be verified later. This technology is currently only supported on Windows. Java public void signDocument(String fieldName, SigningDTO signData, PrivateKey signingKey, Certificate[] signingCertChain, String bioCertRef, HashType padSignatureType, RSAScheme padSignatureScheme, byte[] padSignature, X509Certificate padSigningCert, String bioData, SignatureImageDTO image, SignatureDeviceDTO deviceData) ### Encryption on the PC If the biometric data is not encrypted in the signature device, the encryption is performed when the `signDocument()` method is called. For this, a certificate with a public RSA key is required on the PC. This functionality is supported by all signature devices. Java public void signDocument(String fieldName, SigningDTO signData, PrivateKey signingKey, Certificate[] signingCertChain, X509Certificate bioCert, String bioData, SignatureImageDTO image, SignatureDeviceDTO deviceData) ## SignoPdfSignerSTPad The class `de.signotec.pdf.signer.SignoPdfSignerSTPad` is used to capture signatures with a signotec signature pad or a pen display and requires an object of type `de.signotec.stpad.api.SigPadApi`. Using this class is the recommended way to capture a signature, as it allows all advanced features of the signotec LCD signature pads to be used. The method `SignoPdfSignerSTPad.initSignature()` starts the signature capture. The method `startSignature()` of the `SigPadApi` object passed in the constructor is triggered at this point. If the specified signature field does not exist, it is created. In this case, the `Rectangle` and `Page` specifications of the `SigningDTO` object must be set. ### Signing and Encryption in the Signature Device If a pad is connected that has a private key for signing and a public key for encryption stored in it, the device can be used for digitally signing the document and encrypting the biometric data. This means no RSA keys of any kind are needed on the PC and the biometric data is encrypted before being transmitted to the PC. This technology is only supported on Windows and only by signotec pads when using the SigPadFacade. Java public void initSignature(String fieldName, SigningDTO signData) ### Signing in the Signature Device, Encryption on the PC If a pad is connected that has a private key for signing stored in it, the document can be digitally signed in the device. This means no private RSA key is needed on the PC. This technology is only supported on Windows and only by signotec pads when using the SigPadFacade. Java public void initSignature(String fieldName, SigningDTO signData, X509Certificate bioCert) ### Signing on the PC, Encryption in the Signature Device If a pad is connected that has a public key for encryption stored in it, the biometric data can be encrypted in the device. This means no public RSA key is needed on the PC and the biometric data is encrypted before being transmitted to the PC. This technology is only supported on Windows and only by signotec pads when using the SigPadFacade. Java public void initSignature(String fieldName, SigningDTO signData, PrivateKey signingKey, Certificate[] signingCertChain) ### Signing and Encryption on the PC This functionality is supported by all signature devices. To use it, a private key for signing and a public key for encryption must be available on the PC. Java public void initSignature(String fieldName, SigningDTO signData, PrivateKey signingKey, Certificate[] signingCertChain, X509Certificate bioCert) ## SignoPdfSignerCustom With the class `SignoPdfSignerCustom`, documents can be signed with custom signatures. The signature can, for example, be created by the application itself or performed by a remote signing provider. The usage of the class is divided into two steps: 1. The document is prepared for signing with the `prepareDocument()` method. The result is a hash that must be signed. The hash algorithm used can be queried using `getDocumentHashAlgorithm()`. 2. The signature of the signed hash is stored in the prepared document using the `signDocument()` method. After each step, the document can be saved with `writeDocument()`. Step 2 can also be performed without the signoAPI Java by inserting the signature into a reserved area of the document. The position of the area can be determined with the `getSignatureOffset()` method. The size of the area is specified with `setSignatureLength()`. --- version: "v4.0.5" language: "en" --- # signoAPI Java - System Requirements ## Operating Systems The signoAPI Java components can generally be run on Windows and Linux. Please also refer to the following section "Additional Components". ### **Linux** #### OpenSSL (libssl) When using the SigPadFacade, the [OpenSSL](https://www.openssl.org/) (libssl) library in version 3.0 must be installed on the system. #### libusb When using HID/WinUSB devices, a libusb version 1.0.16 or later must also be installed on the system. Additionally, the permissions for libusb may need to be adjusted to be able to communicate with signotec pads. For this, the MODE for USB must be changed to `0666`: Bash # libusb device nodes SUBSYSTEM=="usb", ENV{DEVTYPE}=="usb_device", MODE="0666" Afterwards, udev must be restarted: Bash udevadm control --reload-rules In Debian, this setting is located in the file `/lib/udev/rules.d/50-udev-default.rules` or `/lib64/udev/rules.d/50-udev-default.rules`. On other distributions, the setting may be located in a different place. ## Additional Components The following tables list the dependencies of this API: | Dependency | Note | |-------------------------------------------|---------------------------------------------------------------------------------------------------| | lib/bcpkix-jdk18on.jar | - | | lib/bcprov-jdk18on.jar | - | | lib/bcutil-jdk18on.jar | - | | lib/commons-logging.jar | - | | lib/fontbox.jar | - | | lib/graphics2d.jar | - | | lib/jna.jar, lib/jna-platform.jar | - | | lib/jpdfnotes.jar | - | | lib/pdfbox.jar | - | | lib/pdfbox-io.jar | - | | lib/rhino.jar | Only if form field validation is active. | | lib/signopdf-lib.jar | signoAPI Java library | | lib/stlic-lib.jar | - | | lib/stpad-lib.jar | signoPAD-API Java library | | lib/jni4net.j.jar, lib/jwinpointer-se.jar | Only when using the `PenDisplayFacade` from the signoPAD-API Java with the `JWinPointer` library. | | lib/jpen.jar | When a Pen Display is used. | | lib/jpen.dll | When a Pen Display is used on Windows. | | lib/libjpen.so | When a Pen Display is used on Linux. | | lib/batik/\*.jar | When SVG-formatted signature images are used. | | lib/swt/\*.jar | Only when using the SWT control `SignatureWidget`. | ## JRE Dependencies The signoAPI Java components require the Java Runtime Environment (JRE) version 1.8 or later. Both 32-bit and 64-bit versions are supported. The following table contains internet addresses from which Java can be downloaded. | Version | Download URL | |---------|----------------------------------------------------------------------------------| | Java 8 | | | Java 11 | | | Java 17 | | All components not included by default in the JRE are provided with the delivery package. --- version: "v4.0.5" language: "en" --- # signoAPI Java - View Documents A main component is the class `de.signotec.pdf.viewer.SignoViewer`. This is a visual control based on a JPanel for displaying PDF documents. It offers a flexibly configurable toolbar with navigation, zoom, and print functionality. **This component is no longer maintained and will be removed in future releases!** --- version: "2025-04-11.1" language: "de" --- # Onlinelizenzierung Dieses Dokument beschreibt, wie die signotec Software online lizenziert und temporär offline verwendet werden kann. Zudem wird beschrieben, wie bestehende Aktivierungen verwaltet, freigeben und automatisch neu zugeordnet werden können, z. B. beim Austausch eines Computers. * [Begriffsbestimmungen](https://docs.signotec.com/de/online-licence/latest/begriffsbestimmungen.md) * [Lizenzarten und Terminalserver](https://docs.signotec.com/de/online-licence/latest/lizenzarten-und-terminalserver.md) * [Lizenzierung der Software](https://docs.signotec.com/de/online-licence/latest/lizenzierung-der-software.md) * [Lizenzverteilung per Datei](https://docs.signotec.com/de/online-licence/latest/lizenzverteilung-per-datei.md) * [Lizenzierung bei aktivem Proxy](https://docs.signotec.com/de/online-licence/latest/lizenzierung-bei-aktivem-proxy.md) * [Übertragung/Übernahme einer Lizenz](https://docs.signotec.com/de/online-licence/latest/uebertragung-uebernahme-einer-lizenz.md) * [FAQ zur Onlinelizenzierung](https://docs.signotec.com/de/online-licence/latest/faq-zur-onlinelizenzierung.md) --- version: "2025-04-11.1" language: "de" --- # Begriffsbestimmungen Im Rahmen der signotec Lizenzen werden unterschiedliche Begrifflichkeiten verwendet. Die nachfolgende Tabelle beinhaltet eine Definition dieser Begriffe. | **Begriff** | **Definition** | |-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Online-Lizenz / Onlinelizenz | Der Begriff „Online-Lizenz" oder "Onlinelizenz" beschreibt Lizenzen, welche von signotec ausgestellt und regelmäßig online überprüft werden. | | Lizenz / Lizenzschlüssel | Die Lizenz bzw. der Lizenzschlüssel beschreibt eine Buchstaben- und Zahlenkombination zur Aktivierung der signotec Software. | | Aktivierung | Eine Lizenz kann ‚n' „Aktivierungen" umfassen. Eine Aktivierung wird dabei immer an den ausführenden PC („Client") oder Benutzer gekoppelt. Im Terminalserver ist dies das Endgerät oder der Benutzer, welcher sich mit dem Server verbindet und die Software remote verwendet. | | Client | Der „Client" ist der Computer, mit dem die Software genutzt wird. | | Benutzer | Ein „Benutzer" ist ein Anwender, welcher die Software verwendet. Technisch wird der Benutzername immer mit dem „[ReferencedDomainName](https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-lookupaccountnamea)" verknüpft. Bei einem Domänenbenutzer ist dies der Name der Domäne. Bei einem lokalen Benutzer wird der Computername genutzt. | | Offlinenutzung / Offline-Nutzung | Die „Offlinenutzung" bedeutet, dass die aktivierte Lizenz temporär offline (ohne Internetverbindung) verwendet werden kann. | | Lizenz freigeben (Lizenzfreigabe) | Die „Freigabe" einer Lizenz beschreibt den Prozess, wie eine Aktivierung manuell zurückgesetzt wird, um diese auf einem anderen PC zu nutzen. | | Lizenz übernehmen (Lizenzübernahme) | Die „Übernahme" einer Lizenz bzw. Aktivierung beschreibt einen automatisierten Prozess, bei dem alle Aktivierungen einer Lizenz (automatisch) zurückgesetzt und neu zugeordnet werden. | | Softwarepflege (AMS) | Die „Softwarepflege" ist eine Option für Lizenzen, die kostenfreie Versionsupdates und bevorzugten technischen Support ermöglicht. | --- version: "2025-04-11.1" language: "de" --- # FAQ zur Onlinelizenzierung ## Woran ist die Lizenz/Aktivierung gebunden? Im Standard ist eine Aktivierung immer an den Computer des Benutzers (Client) gebunden. In der Regel ist dies Ihr lokaler PC oder Laptop. Dies gilt auch für Terminalserver- und Citrix-Umgebungen. Der angemeldete Benutzer spielt keine Rolle. Die Lizenz ist also an die Hardware gebunden und nicht an den Benutzer. Sofern eine Lizenz sowohl lokal installiert als auch remote auf dem Terminalserver mit demselben Rechner (Client) genutzt werden soll, sind zwei Aktivierungen innerhalb der Lizenz erforderlich! Alternativ kann eine Aktivierung auch benutzerspezifisch erfolgen. In diesem Fall wird die Aktivierung an den angemeldeten Benutzer gebunden. Der Benutzer kann die Software dann auf unterschiedlichen Computern verwenden, ohne dass mehrere Aktivierungen erforderlich sind. Mehr Informationen sind im Bereich [Lizenzarten und Terminalserver](https://docs.signotec.com/de/online-licence/latest/lizenzarten-und-terminalserver.md)enthalten. ## Kann ich die Lizenz mit demselben PC sowohl lokal als auch remote nutzen? Sofern die Software sowohl lokal als auch remote auf einem Terminalserver genutzt werden soll, muss eine benutzerspezifische Lizenzierung gewählt werden. Außerdem muss die Anmeldung am lokalen Rechner und am Terminalserver mit dem identischen Domänenbenutzer erfolgen. Ist dies nicht der Fall, sind zwei Aktivierungen innerhalb der Lizenz erforderlich. Mehr Informationen sind im Bereich [Lizenzarten und Terminalserver](https://docs.signotec.com/de/online-licence/latest/lizenzarten-und-terminalserver.md)enthalten. ## Wie werden Aktivierungen gezählt, wenn die Software auf mehreren Terminalservern installiert wird? Wenn die Software auf mehreren Terminalservern (bspw. im Lastenausgleich) installiert wird, so kann derselbe Lizenzschlüssel auf allen Servern hinterlegt werden. Die Aktivierungen werden auch serverübergreifend pro Computer (Client) oder pro Benutzer gezählt. Derselbe Client bzw. Benutzer ist demnach auf allen Servern lizenziert und darf die Software nutzen. ## Wofür brauche ich die Softwarepflege (AMS)? Mit einer Softwarepflege (AMS) erhalten Kunden kostenlos und dauerhaft alle neuen Updates der Software. Zusätzlich steht bei Problemen der technische Support von signotec kostenfrei und priorisiert zur Verfügung. ## Kann ich eine vorhandene Lizenz erweitern oder benötige ich eine neue? Alle signotec Online Lizenzen können „on the fly" erweitert werden. Sofern z.B. weitere Aktivierungen gekauft werden, wird die bestehende Lizenz in der Regel einfach erweitert, so dass derselbe Lizenzschlüssel weiterverwendet werden kann, ohne die Lizenz austauschen zu müssen. Dies gilt auch für die Freischaltung von optionalen Features und Plug-Ins. ## Wie erfahre ich, wie viele Aktivierungen ich noch frei habe? Um Ihren Lizenzstatus zu überprüfen, navigieren Sie in der Benutzeroberfläche der Software zu den Lizenzinformationen. Dort werden Ihnen alle relevanten Details zu Ihrer Lizenz angezeigt. Oder kontaktieren Sie uns unter [lizenz@signotec.de](mailto:lizenz@signotec.de). ## Warum ist das automatische Übernehmen einer Lizenz pro PC nur einmal möglich? Dies ist ein technischer Schutz, um die unerlaubte Nutzung der Software zu verhindern. ## Kann ich eine Lizenz auch länger als 60 Tage am Stück offline nutzen? Dies ist leider nicht möglich. Die Lizenz muss einmal alle 60 Tage online überprüft werden. Dazu muss das System nur wenige Augenblicke mit dem Internet verbunden sein. ## Kann eine Lizenz auch offline aktiviert werden? Ja, sofern der PC vollständig offline arbeitet, kann die Aktivierung im Einzelfall auch manuell ohne Internetverbindung erfolgen. Dies wird jedoch nur empfohlen, wenn das System dauerhaft offline ist. Bitte kontaktieren Sie uns in diesem Fall unter [lizenz@signotec.de](mailto:lizenz@signotec.de). --- version: "2025-04-11.1" language: "de" --- # Lizenzarten und Terminalserver ## Geräte-spezifische Lizenzen Standardmäßig ist die signotec Software an den Client gekoppelt, der die Software ausführt. Ein Client kann z. B. ein PC oder Laptop sein. In einer Terminalserver-Umgebung ist der Client der Rechner, der sich mit dem Terminalserver verbindet und die Software remote nutzt. Diese Lizenzvariante ist für alle Plattformen verfügbar (z.B. Windows, Android und Apple iOS). ![image-20240625-065230.png](https://docs.signotec.com/__attachments/a_b5f69aa67b871dcbada6b44da9d3dd0eb17f6d17a08f3def9a19a2bf4e142b64/image-20240625-065230.png?cb=2c1eb070d3c153011844a678bff4b4f1) Geräte-spezifische Aktivierung Gerätespezifische Lizenzen erlauben die Nutzung der Software durch ++mehrere Benutzer++ über ++einen (denselben) Computer++. Wenn eine Lizenz sowohl lokal auf einem Computer als auch auf dem Terminalserver genutzt wird, handelt es sich um zwei getrennte Aktivierungen! Die Lizenz kann wahlweise lokal oder auf dem Terminalserver verwendet werden. ## Benutzer-spezifische Lizenzen Alternativ zur gerätespezifischen Lizenzierung können für Windows-basierte Systeme (insbesondere Terminalserver) auch benutzerspezifische Lizenzen vergeben werden. Bei dieser Lizenzvariante ist die Aktivierung nicht an den Client, sondern an den angemeldeten Benutzer gebunden. ![image-20240625-065216.png](https://docs.signotec.com/__attachments/a_58b71a3a82e3159624b49a8c0524c09aeef1726f7059cdbb708b468c1905bfe5/image-20240625-065216.png?cb=0f1abcc27813954ceb6342688098956b) Benutzer-spezifische Aktivierung Benutzerspezifische Lizenzen erlauben die Nutzung der Software durch ++einen Benutzer++ auf ++mehreren Computern++. Bei der benutzerspezifischen Lizenzierung wird der Benutzername immer mit dem „[ReferencedDomainName](https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-lookupaccountnamea)" verknüpft. Bei einem Domänenbenutzer ist dies der Name der Domäne. Bei einem lokalen Benutzer ist dies der Computername. Das Verfahren eignet sich daher insbesondere für Domänen und Terminalserver, nicht jedoch für lokale Benutzerkonten. ## Terminalserver Wird die signotec Software auf einem Terminalserver eingesetzt, so wird für jeden Client bzw. Benutzer, der sich mit dem Server verbindet und die Software verwendet, eine Aktivierung benötigt. Werden in der Infrastruktur mehrere Terminalserver eingesetzt (z. B. durch Lastverteilung), so wird für jeden Client bzw. Benutzer nur eine Lizenz/Aktivierung benötigt. Diese Aktivierung ist unabhängig vom zugrunde liegenden Terminalserver. Eine Aktivierung erfolgt immer nur dann, wenn die Software tatsächlich gestartet und ein Lizenzschlüssel hinterlegt wird. Geräte oder Benutzer auf dem Terminalserver, die die Software nicht nutzen, sind für die Lizenzierung irrelevant. Eventuelle Zugriffsbeschränkungen auf die Software liegen in der Verantwortung des Systemadministrators. Mehr Informationen sind im Abschnitt [Lizenzverteilung per Datei](https://docs.signotec.com/de/online-licence/latest/lizenzverteilung-per-datei.md)enthalten. Für die gerätespezifische Lizenzierung in Terminalserver-Umgebungen muss der Client-Name statisch vergeben werden. Eine dynamische oder zufällige Generierung von Client-Namen wird nicht unterstützt. Als Alternative steht die benutzerspezifische Lizenzierung zur Verfügung. --- version: "2025-04-11.1" language: "de" --- # Lizenzierung bei aktivem Proxy Für die automatische Lizenzierung wird eine aktive Internetverbindung benötigt, und es muss eine Verbindung zum signotec-Lizenzservice möglich sein. Die Lizenzierung kann dabei auch erfolgen, wenn die Internetverbindung über einen Proxyserver hergestellt wird. Die Software nutzt automatisch den in Windows konfigurierten Proxyserver, sodass in der Regel ++keine++ besonderen Einstellungen oder Anpassungen erforderlich sind. Unterstützt werden sowohl manuell konfigurierte HTTP-, SOCKS4- und SOCKS5-Proxyserver als auch automatische Proxy-Konfigurationen mittels PAC- oder WPAD-Dateien. ## Ablauf der Lizenzierung Die Software überträgt den eingegebenen oder hinterlegten Lizenzschlüssel sowie aktuelle Geräteinformationen über eine REST-API (`HTTPS(443)`) an den Lizenzserver (`https://licence.signotec.com`). Der Server antwortet mit einer XML-Struktur (`application/octet-stream`). Diese enthält je nach Ergebnis eine positive oder negative Rückmeldung. Im Falle einer erfolgreichen Lizenzvalidierung werden die XML-Informationen als Datei lokal auf dem Computer gespeichert. Standardmäßig erfolgt die Ablage im Verzeichnis `%ProgramData%\signotec\Licenses`. Wenn dort keine Schreibrechte bestehen, wird alternativ das Verzeichnis `%AppData%\signotec\Licenses`verwendet. ## Fehlerbehebung / Ausnahmeregel Schlägt die Lizenzierung trotz aktiver Internetverbindung fehl, liegt dies vermutlich daran, dass die Kommunikation mit dem Lizenzserver oder der Empfang der Lizenzdaten blockiert wird -- beispielsweise, weil der Proxy oder die Firewall die Datenübertragung als unerlaubten Download interpretiert. In diesem Fall muss die Kommunikation explizit als Ausnahme in den Sicherheitseinstellungen des Proxys oder der Firewall freigegeben werden. Dies erfolgt durch den zuständigen Systemadministrator. **Falls die automatische Lizenzierung nicht funktioniert, obwohl eine Internetverbindung besteht, prüfen Sie bitte Folgendes:** * Ist der Proxyserver korrekt in Windows konfiguriert und wird der verwendete Proxy von der signotec Software unterstützt (`HTTP, SOCKS4, SOCKS5, PAC, WPAD`)? * Wird die Verbindung zur URL `https://licence.signotec.com` (Port 443, HTTPS) zugelassen? * Blockiert eine Firewall oder der Proxyserver den Download und das Speichern von XML-Daten (Content-Type`application/octet-stream`)? * Ist für den verwendeten Benutzer Schreibzugriff auf folgendes Verzeichnis vorhanden? * `%ProgramData%\signotec\Licenses `bzw. alternativ `%AppData%\signotec\Licenses` Sollte generell keine Internetverbindung oder Ausnahme möglich sein, muss eine manuelle Offline-Lizenzierung durchgeführt werden. Bitte kontaktieren Sie uns in diesem Fall unter [lizenz@signotec.de](mailto:lizenz@signotec.de). --- version: "2025-04-11.1" language: "de" --- # Lizenzierung der Software ## Erhalt des Lizenzschlüssels Der Lizenzschlüssel wird in der Regel zusammen mit der Rechnung bzw. nach Zahlung übermittelt. Alternativ kann der Lizenzschlüssel unter Angabe der Kunden- und Rechnungsnummer per E-Mail an [lizenz@signotec.de](mailto:lizenz@signotec.de) anfordert werden. Die Bereitstellung dauert in der Regel nicht länger als 3 Stunden. Der Lizenzschlüssel hat das folgende Format bestehend aus Zahlen und Buchstaben: > XXXXXXXX--XXXX--XXXX--XXXX--XXXXXXXXXXXX ## Aktivierung der Software In der Benutzeroberfläche des Lizenzbereichs der Software befindet sich ein Eingabefeld zur Eingabe des Lizenzschlüssels, woraufhin die Lizenz automatisch online überprüft und die Installation freigeschaltet wird. Anschließend werden alle Lizenzdetails (z.B. Firmenname und Anzahl der maximal möglichen Aktivierungen) angezeigt. Für die Aktivierung der Software muss das System mit dem Internet verbunden sein. ## Überprüfung und Offlinenutzung Nach erfolgreicher Aktivierung kann die Software bis zu 60 Tage lang offline (ohne Internetverbindung) genutzt werden. Nach Ablauf dieser Frist kann die Software erst wieder verwendet werden, wenn sie für eine erneute Lizenzprüfung mit dem Internet verbunden wurde. Der Zeitpunkt der letzten Lizenzprüfung sowie der Zeitraum der möglichen Offline-Nutzung können den Lizenzdetails innerhalb der Software entnommen werden. Die Software versucht täglich, die Lizenz automatisch online zu überprüfen und zu aktualisieren. Bei erfolgreicher Prüfung werden die Lizenzdetails aktualisiert und die maximale Offline-Nutzungsdauer auf 60 Tage zurückgesetzt. Sofern die Lizenz manuell überprüft oder aktualisiert werden soll, um z.B. eine gekaufte Erweiterung sofort nutzen zu können oder den Offline-Nutzungszeitraum zurückzusetzen, ist in den Lizenzdetails der Software eine entsprechende Aktualisierungsfunktion enthalten. ## Versionsupdates mit und ohne Softwarepflege Die Lizenzdetails enthalten die Information, ob die Lizenz Softwarepflege beinhaltet und wenn ja, wie lange diese gültig ist. Solange die Softwarepflege aktiv ist, können alle neuen Versionen kostenlos installiert werden. Der Lizenzschlüssel muss bei einem Update nicht ausgetauscht werden. Ein Update der Software ++ohne++ aktive Softwarepflege führt dazu, dass die Software nicht mehr genutzt werden kann. Bei Lizenzen ohne Softwarepflege sind der Lizenzschlüssel und die zugehörigen Installationsdateien sorgfältig aufzubewahren. Ältere Softwareversionen werden von signotec nicht mehr zur Verfügung gestellt. --- version: "2025-04-11.1" language: "de" --- # Lizenzverteilung per Datei Wenn eine größere Anzahl von Computern (Clients) aktiviert werden soll, besteht die Möglichkeit, eine Lizenzdatei mit dem Lizenzschlüssel zentral in einem Ordner abzulegen. Die Software aktiviert sich dann automatisch beim Start auf den entsprechenden Rechnern (Clients). ## Name und Aufbau der Lizenzdatei Um den Lizenzschlüssel als Datei zu verteilen, muss eine leere Textdatei mit der Endung ".licx" und folgendem Inhalt erstellt werden, wobei der Platzhalter "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX" unter "activationId" durch den Lizenzschlüssel ersetzt werden muss. XML XXXXXXXX--XXXX--XXXX--XXXX--XXXXXXXXXXXX Der Name der Lizenzdatei hängt von der verwendeten Software ab. | **Software** | **Name der Lizenzdatei** | |--------------------------------|--------------------------| | signotec signoSign/2 | SS200.licx | | signotec Adobe Acrobat Plug-In | ACRPI.licx | Die Schreibweise des Dateinamens muss exakt übereinstimmen. ## Speicherort der Lizenzdatei Die Lizenzdatei für die automatische Aktivierung kann systemweit oder benutzerspezifisch gespeichert werden. ### Systemweite Lizenzdateien Die systemweiten Lizenzdateien sind im folgenden Ordner zu finden: *%ProgramData%\\signotec\\Licenses* Es ist zu beachten, dass bei einer systemweiten Lizenz jeder Benutzer, der Zugriff auf die Software hat, eine Aktivierung (ggf. auch unbewusst) durchführen kann. Insbesondere in Terminalserverumgebungen sollte daher der Zugriff auf die Software eingeschränkt werden, um eine ungewollte Aktivierungen zu vermeiden. ### Benutzerspezifische Lizenzdateien Die benutzerspezifischen Lizenzdateien befinden sich im folgenden Ordner: > *%AppData%\\signotec\\Licenses* Sofern nur einzelne Benutzer lizenziert werden sollen, der Zugriff auf die Software aber technisch nicht eingeschränkt werden kann oder soll, kann die Lizenzdatei mit dem Lizenzschlüssel in diesem benutzerspezifischen Verzeichnis abgelegt werden. Die Verteilung der Datei kann z.B. auch über Gruppenrichtlinien innerhalb einer Domäne automatisiert werden. Sollte es dennoch zu unbeabsichtigten Aktivierungen kommen, kann die Aktivierung auf dem jeweiligen Computer (Client) [manuell freigegeben](https://docs.signotec.com/de/online-licence/latest/uebertragung-uebernahme-einer-lizenz.md) oder die [automatische Übernahme](https://docs.signotec.com/de/online-licence/latest/uebertragung-uebernahme-einer-lizenz.md) einer Lizenz genutzt werden. --- version: "2025-04-11.1" language: "de" --- # Übertragung/Übernahme einer Lizenz Generell ist es möglich, Lizenzen auf andere Arbeitsplätze zu übertragen. Dies ermöglicht eine sehr flexible Nutzung der Lizenz, da diese bei Bedarf sehr einfach übertragen werden kann. ## Manuelle Freigabe einer Lizenz Um eine Lizenz manuell freizugeben, gibt es eine Schaltfläche "Lizenz freigeben" innerhalb der Lizenzierungsoberfläche der Software. Durch die manuelle Freigabe wird die Lizenz auf dem aktuellen PC entfernt und die entsprechende Aktivierung zurückgesetzt. Die Lizenz kann anschließend auf einem anderen System wieder aktiviert werden. Für die Freigabe der Lizenz bzw. Aktivierung muss das System mit dem Internet verbunden sein. ## Automatische Übernahme einer Lizenz Sofern die Lizenz nicht manuell freigegeben werden kann, z. B. bei einem Defekt, ist auch eine automatische Übernahme der Lizenz bzw. Aktivierung möglich. Sobald die maximale Anzahl der Aktivierungen der Lizenz überschritten wird, erscheint bei der nächsten Aktivierung eine Warnung, dass die maximale Anzahl der Aktivierungen bereits erreicht wurde. Gleichzeitig bietet die Software an, eine Lizenz automatisch von einem anderen PC zu übernehmen. In diesem Fall werden im Hintergrund alle Aktivierungen der Lizenz zurückgesetzt und über die periodische Lizenzprüfung automatisch im Rahmen der maximal erlaubten Aktivierungen neu vergeben. Die automatische Übernahme funktioniert nur einmalig bei Neuinstallationen. Sofern der PC bereits einmal aktiviert war, ist eine erneute automatische Zuweisung nicht möglich. In diesem Fall muss eine weitere Lizenz erworben oder die Anzahl der Aktivierungen erhöht werden. Alternativ kann der technische Support kontaktiert werden. --- version: "2025-04-11.1" language: "en" --- # Online licensing This document describes how to license signotec software online and how to use it offline temporarily. It also describes how to manage, release and automatically re-assign existing activations, for example when a computer is replaced. * [Definitions](https://docs.signotec.com/en/online-licence/latest/begriffsbestimmungen.md) * [License types and terminal servers](https://docs.signotec.com/en/online-licence/latest/lizenzarten-und-terminalserver.md) * [Licensing the software](https://docs.signotec.com/en/online-licence/latest/lizenzierung-der-software.md) * [License distribution by file](https://docs.signotec.com/en/online-licence/latest/lizenzverteilung-per-datei.md) * [Licensing with active Proxy](https://docs.signotec.com/en/online-licence/latest/licensing-with-active-proxy.md) * [Automatic transfer of a license](https://docs.signotec.com/en/online-licence/latest/uebertragung-uebernahme-einer-lizenz.md) * [Online licensing FAQ](https://docs.signotec.com/en/online-licence/latest/faq-zur-onlinelizenzierung.md) --- version: "2025-04-11.1" language: "en" --- # Definitions Various technical terms are used in connection with signotec licenses. The following table lists terms along with their definitions. | **Term** | **Definition** | |-------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Online license | The term "online license" describes licenses that are issued by signotec and regularly checked online. | | License / license key | The license or license key describes a combination of letters and numbers used to activate the signotec software. | | Activation | A license can cover "n" number of "activations." Activation is always linked to the PC on which it is performed (the "client") or the user. In the case of the terminal server, this is the terminal device or user that connects to the server and uses the software remotely. | | Client | The "client" is the computer that uses the software. | | User | A "user" is a person who uses the software. Technically, the username is always linked to the "[ReferencedDomainName](https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-lookupaccountnamea)." In the case of a domain user, this is the name of the domain. In the case of a local user, the computer name is used. | | Offline use | "Offline use" means that the activated license can be temporarily used offline (without an Internet connection).. | | Releasing a license (license release) | "Releasing" a license describes the process of manually resetting an activation so that it can be used on another PC. | | Transferring a license (license transfer) | "Transferring" a license or activation describes an automated process that causes all activations of the license to be automatically reset and re-allocated. | | Software maintenance (AMS) | "Software maintenance" is an option for licenses that enables free-of-charge version updates and priority technical support. | --- version: "2025-04-11.1" language: "en" --- # Online licensing FAQ ## What are the requirements for the license/activation? As standard, activation always requires the user's computer (client). This is normally your local PC or laptop. This also applies to terminal server and Citrix environments. It does not matter which user is logged on. The license is linked to the specific hardware and not the user. If a license is to be both installed locally and used remotely on the terminal server with the save computer (client), two activations are needed for the license! Alternatively, user-specific activation is possible. In this case, the activation is linked to the user who is logged in. The user can then use the software on different computers without multiple activations being needed. More information is provided in the section [License types and terminal server](https://docs.signotec.com/en/online-licence/latest/lizenzarten-und-terminalserver.md). ## Can I use the license both locally and remotely with the same PC? If the software is to be used both locally and remotely on a terminal server, user-specific licensing must be chosen. The login on the local computer and on the terminal server must also be based on an identical domain user. If this is not the case, two activations are needed for the license. More information is provided in the section [License types and terminal server](https://docs.signotec.com/en/online-licence/latest/lizenzarten-und-terminalserver.md). ## How are activations counted when the software is installed on multiple terminal servers? If the software is installed on multiple terminal servers (e.g. to distribute load evenly), the same license key can be saved on all servers. The activations are also counted across servers, per computer (client) or user. Accordingly, the same client or user is licensed on all servers and can use the software. ## Why would I need software maintenance (AMS)? With software maintenance (AMS), customers permanently receive all new updates of the software free of charge. In addition, they have free-of-charge priority access to signotec technical support should any problems occur. ## Can I extend an existing license or do I need a new one? All signotec online licenses can be extended on the fly. If additional activations are purchased, for example, the existing license is simply extended so that you can continue to use the same license key without having to exchange the license. The same applies to enabling optional features and plug-ins. ## How can I find out how many activations I have left? To check your license status, simply navigate to Licensing information in the software's UI. All the relevant details on your license are displayed there. Or contact us at [lizenz@signotec.de](mailto:lizenz@signotec.de). ## Why is automatic transfer of a license only possible once per PC? This is a technical measure aimed at preventing unauthorized use of the software. ## Can I use a license offline for any longer than 60 days at a time? Unfortunately, this is not possible. The license must be checked online once every 60 days. The system only needs to be connected to the Internet very briefly. ## Can a license also be activated offline? Yes, if the PC is exclusively used offline, activation can in this case be performed manually without an Internet connection. This is only recommended, however, if the system is consistently offline. In this case, please contact us at [lizenz@signotec.de](mailto:lizenz@signotec.de). --- version: "2025-04-11.1" language: "en" --- # Licensing with active Proxy An active internet connection is required for automatic licensing, and a connection to the signotec licensing service must be possible. Licensing can also be carried out if internet access is established via a proxy server. The software automatically uses the proxy server configured in Windows, so no special settings or adjustments are usually required. Both manually configured HTTP, SOCKS4, and SOCKS5 proxy servers, as well as automatic proxy configurations via PAC or WPAD files, are supported. ## Licensing Process The software transmits the entered or stored license key, along with current device information, to the licensing server (`https://licence.signotec.com`) via a REST API (`HTTPS, 443`). The server responds with an XML structure (`Content-Type: application/octet-stream`). Depending on the result, the response contains either a positive or negative validation. In the case of a successful license validation, the XML data is saved as a file locally on the computer. By default, the following directory is used: `%ProgramData%\signotec\Licenses`. If write permissions are not available in this directory, the following alternative is used:`%AppData%\signotec\Licenses`. ## Troubleshooting / Exception If licensing fails despite an active internet connection, it is likely that communication with the licensing server or the reception of the license data is being blocked---possibly because the proxy or firewall interprets the data transfer as an unauthorized download. In this case, communication must be explicitly allowed as an exception in the proxy or firewall security settings. This configuration must be carried out by the responsible system administrator. **If automatic licensing does not work even though an internet connection is available, please verify the following:** * Is the proxy server correctly configured in Windows, and is the type of proxy supported by the signotec software (`HTTP, SOCKS4, SOCKS5, PAC, WPAD`)? * Is access to the URL `https://licence.signotec.com` (port 443, HTTPS) permitted? * Is a firewall or proxy server blocking the download or storage of XML data (`Content-Type: application/octet-stream`)? * Does the user have write access to the following directory? * `%ProgramData%\signotec\Licenses` or alternatively `%AppData%\signotec\Licenses` If no internet connection or exception configuration is possible at all, a **manual offline licensing** process must be carried out. In this case, please contact us at: [lizenz@signotec.de](mailto:lizenz@signotec.de). --- version: "2025-04-11.1" language: "en" --- # License types and terminal servers ## Device-specific licenses As standard, the signotec software is coupled with the client that runs the software. The client could be a PC or a laptop, for example. In a terminal server environment, the client is the computer that connects to the terminal server and uses the software remotely. This license variant is available for all platforms (e.g. Windows, Android and Apple iOS). ![image-20240625-065230.png](https://docs.signotec.com/__attachments/a_f36b61bd57bcd8f8eb148d45f4e668675aa688bf847f805df62aabb85a0dc29a/image-20240625-065230.png?cb=2c1eb070d3c153011844a678bff4b4f1) Device-specific activation Device-specific licenses enable the software to be used by ++multiple users++ on ++one (the same) computer++. If a license is used both locally on a computer and on the terminal server, this involves two separate activations! The license can be used either locally or on the terminal server. ## User-specific licenses Alternatively to the device-specific licensing, user-specific licenses can be issued for Windows-based systems (particularly terminal servers). For this license variant, the activation is linked to the user who is logged in rather than the client. ![image-20240625-065216.png](https://docs.signotec.com/__attachments/a_69152302b9be876a7ad8fa5465ca5eab59e89dd8af580e41d58259f2bf5f2fbb/image-20240625-065216.png?cb=0f1abcc27813954ceb6342688098956b) User-specific activation User-specific licenses enable the software to be used by ++one user++ on ++multiple computers++. For user-specific licensing, the username is always linked with the "[ReferencedDomainName](https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-lookupaccountnamea)." In the case of a domain user, this is the name of the domain. In the case of a local user, this is the computer name. This method is therefore particularly suitable for domains and terminal servers, but not for local user accounts. ## Terminal servers If the signotec software is used on a terminal server, an activation is needed for each client/user connecting to the server and using the software. If multiple terminal servers are used in the infrastructure (e.g. for load distribution), only one license/activation is needed for each client/user. This activation is not dependent on the underlying terminal server. Activation is only ever performed when the software is actually started up and a license key is saved. If devices or users are on the terminal server but do not use the software, they are irrelevant for the licensing. Any access restrictions to the software are the responsibility of the system administrator. More information is provided in the section [License distribution by file](https://docs.signotec.com/en/online-licence/latest/lizenzverteilung-per-datei.md). For device-specific licensing in Terminal Server environments, the client name must be assigned statically. Dynamic or random client name generation is not supported. User-specific licensing is available as an alternative. --- version: "2025-04-11.1" language: "en" --- # Licensing the software ## Obtaining the license key The license key is normally transmitted together with the invoice / after payment. Alternatively, you can request the license key by sending an email to [lizenz@signotec.de](mailto:lizenz@signotec.de), stating the customer number and invoice number. The license key is normally provided within three hours. The license key has the following format and is made up of numbers and letters: > XXXXXXXX--XXXX--XXXX--XXXX--XXXXXXXXXXXX ## Activating the software The UI of the software's license section contains an input field where you can input the license key. The license will then be automatically checked online and the installation will be enabled. All license details will then be displayed (e.g. company name and maximum number of activations). To activate the software, the system must be connected to the Internet. ## License checking and offline use Once it has been activated successfully, the software can be used offline (without an Internet connection) for up to 60 days. After this period, the software can no longer be used until after it has been connected to the Internet for a new license check. The time of the last license check and the time period for offline use are provided in the software's license details. The software will automatically attempt to check and update the license online on a daily basis. If the check is successful, the license details are updated and the maximum time period for offline use is reset to 60 days. If the license is to be checked or updated manually, for example so that a purchased extension can be used immediately or to reset the offline usage period, a corresponding update function is included in the software's license details. ## Version updates with and without software maintenance The license details specify whether the license includes software maintenance and if so, how long this is valid for. As long as software maintenance is active, all new versions can be installed free of charge. The license key does not need to be changed in the case of an update. If the software is updated ++without++ active software maintenance, it will no longer be possible to use the software. For licenses without software maintenance, the license key and the corresponding installation files must be kept safe. Older software versions are not made available by signotec. --- version: "2025-04-11.1" language: "en" --- # License distribution by file If a larger number of computers (clients) are to be activated, a license file must be stored centrally in a folder with the license key. The software than activates itself automatically during start-up on the corresponding computers (clients). ## Name and structure of the license file To distribute the license key as a file, you need to create an empty text file with the extension ".licx" and the following content, with the placeholder "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX" replaced by the license key. XML XXXXXXXX--XXXX--XXXX--XXXX--XXXXXXXXXXXX The name of the license file is determined by the software used. | **Software** | **Name of license file** | |--------------------------------|--------------------------| | signotec signoSign/2 | SS200.licx | | signotec Adobe Acrobat Plug-In | ACRPI.licx | The spelling of the file name must match exactly. ## Storage location for the license file The license file for automatic activation can be saved system-wide or for a specific user. ### System-wide license files The system-wide license files are located in the following folder: *%ProgramData%\\signotec\\Licenses* Bear in mind that a system-wide license enables any user with access to the software to perform an activation (perhaps unintentionally). In terminal server environments in particular, access to the software should therefore be restricted in order to avoid accidental activations. ### User-specific license files The user-specific license files are located in the following folder: > *%AppData%\\signotec\\Licenses* If only individual users are to be licensed but a technical restriction of access to the software is not wanted, or not possible, the license file with the license key can be saved in this user-specific directory. The distribution of the file can also be automated within a domain by means of group guidelines, for example. If accidental activations do occur, however, activation on the specific computer (client) can be [released manually](https://signotec.atlassian.net/wiki/spaces/general/pages/206274562/2024-07-22.1-en+Automatic+transfer+of+a+license) or [automatic transfer](https://signotec.atlassian.net/wiki/spaces/general/pages/206274562/2024-07-22.1-en+Automatic+transfer+of+a+license) of a license can be used. --- version: "2025-04-11.1" language: "en" --- # Automatic transfer of a license It is generally possible to transfer licenses to other workstations. This means that the license can be used very flexibly, as it can be transferred easily as required. ## Releasing a license manually To release a license manually, a "Release license" button is provided in the software's licensing UI. Manual release involves removing the license from the current PC and resetting the corresponding activation. The license can then be activated again on another system. For releasing of the license or activation, the system must be connected to the Internet. ## Automatic transfer of a license If the license cannot be released manually, for example in the event of a defect, automatic license release/activation is also possible. If the maximum number of license activations is exceeded, a warning will be displayed during the next activation attempt that the maximum number of activations has already been reached. At the same time, the software provides the option of automatically transferring a license from another PC. In this case, all activations of the license will be reset in the background and reallocated automatically on the basis of the maximum permitted activations by means of the regular license check. For re-installations, the automatic release works only once. If the PC has already been activated, a second automatic allocation is not possible. In this case, another license must be purchased or the number of activations must be increased. Alternatively, you can contact Technical Support. --- version: "v3.28.0" language: "de" --- # signoSign/Universal Handbuch signoSign/Universal ist eine Webanwendung zum Öffnen, Bearbeiten und ISO-konformen Signieren von PDF-Dokumenten. Unterstützt werden**fortgeschrittene** und **qualifizierte Signaturen** gemäß **eIDAS-Verordnung,** die sowohl **vor Ort am Point-of-Sale (POS)** als auch remote als **Fernsignatur**ausgeführt werden können. Die Software kann wahlweise als **Cloud-Lösung (SaaS)** oder im **Eigenbetrieb (On-Premises)** eingesetzt werden. Für die Integration in die eigene Anwendung steht zudem eine **REST-API**zur Verfügung. Wir empfehlen Ihnen, dieses Handbuch sorgfältig durchzulesen, um die Software optimal nutzen zu können. * [Installation (On-Prem)](https://docs.signotec.com/de/signosign-universal/latest/installationshandbuch.md) * [Benutzerhandbuch](https://docs.signotec.com/de/signosign-universal/latest/benutzerhandbuch.md) * [Technische Dokumentation](https://docs.signotec.com/de/signosign-universal/latest/technische-dokumentation.md) --- version: "v3.28.0" language: "de" --- # Allgemeines zu Schnittstellen signoSign/Universal bietet umfangreiche Schnittstellen für verschiedene Technologien. Nachfolgend ein kurzer Überblick über die vorhandenen Schnittstellen und deren typischen Einsatzzwecke. * [REST Webservice](https://docs.signotec.com/de/signosign-universal/latest/rest-webservice.md) * [Speichern in fremde Systeme](https://docs.signotec.com/de/signosign-universal/latest/speichern-in-fremde-systeme.md) * [Frontend-API](https://docs.signotec.com/de/signosign-universal/latest/frontend-api.md) --- version: "v3.28.0" language: "de" --- # Allgemeines zur Konfiguration Die Einstellungen von signoSign/Universal können flexibel aus verschiedenen Quellen eingelesen werden, einschließlich Konfigurationsdateien, Umgebungsvariablen oder Java-Systemvariablen. Dies ermöglicht eine einfache Anpassung der Konfiguration an die spezifischen Anforderungen und Umgebungen, in denen die Anwendung betrieben wird, wie etwa eine Container-Umgebung wie Docker. Die Konfiguration ist statisch und erfolgt einmalig beim Start der Anwendung. Jede Einstellung wird atomar behandelt, was bedeutet, dass sie einzeln gesetzt werden kann. In den meisten Fällen sind die Einstellungen technisch voneinander unabhängig. Bestimmte Einstellungen können vom Benutzer zur Laufzeit der Anwendung geändert werden. Dies bietet eine dynamische Möglichkeit zur Anpassung der Konfiguration, um den aktuellen Anforderungen gerecht zu werden und die Benutzererfahrung zu optimieren. --- version: "v3.28.0" language: "de" --- # App für Apple iOS ## Anforderungen Zur Installation und Nutzung ist ein Gerät mit aktiver Internetverbindung und iOS 13 oder neuer erforderlich. Es wird ein freigeschalteter Zugang oder eine eigene Installation von signoSign/Universal benötigt. ## Installation Die signoSign/Universal iOS App kann im App Store von Apple kostenfrei heruntergeladen werden. Nach erfolgreicher Installation kann die signoSign/Universal App für Apple iOS auf dem Home-Bildschirm gestartet werden. Vor der Nutzung sollte die App jedoch noch konfiguriert werden. Zur App: [App Store](https://apps.apple.com/app/signosign-universal/id1211315240) ## Verbindungsdaten Die App Einstellungen sind über die Einstellungen von Apple iOS verfügbar. Nach dem Öffnen der Einstellungen finden Sie eine Liste mit allen installierten Apps. Dort erscheint auch signoSign/Universal. Um eine Verbindung zwischen signoSign/Universal und der App herzustellen, müssen zwei Verbindungswerte in den App Einstellungen eingetragen werden: Die Home-URL sowie die URL. Die **Home URL** beschreibt den Speicherort, bzw. die bereitstellende Anwendung der zu unterschreibenden Dokumente. Im Standardfall ist dies der signoSign/Universal Document Pool Standard: Schema: \/signoSignUniversal/pool Wenn Sie „Home-URL verwenden" deaktivieren, so wir die App ohne eine bereitstellende Anwendung ausgeführt. In diesem Fall kann nur noch die Import-Funktion über „Öffnen mit..." genutzt werden. Die **URL** verweist auf die eigentliche signoSign/Universal Anwendung. Standard: [https://universal.signosign.com/signoSignUniversal](https://mobile.signosign.com/signoSignUnivesal) Schema: \/signoSignUniversal Für die Verwendung der App mit dem von der signotec GmbH bereitgestellten Server, können diese Verbindungswerte auch unausgefüllt (leer) bleiben. ## Benutzerdaten Die Zugangsdaten zu signoSign/Universal müssen ebenfalls in den Einstellungen hinterlegt werden. Beim Start der App werden diese Zugangsdaten dann für die automatische Anmeldung verwendet. Wenn Sie signoSign/Universal über signotec bereitgestellt bekommen, werden diese Zugangsdaten nach erfolgreicher Registrierung an die E-Mail-Adresse des Benutzers gesandt. Falls Sie signoSign/Universal auf einem eigenen Server betreiben, fragen Sie bitte Ihren Systemadministrator nach den Zugangsdaten. ## App-Berechtigungen Je nach Nutzung der App sind unterschiedliche Berechtigungen erforderlich. * **Zugriff auf Standortinformationen** Durch Aktivierung dieser Option kann signoSign/Universal die GPS-Daten Ihres iOS Gerätes bei der Unterschrift berücksichtigen. Die digitale Unterschrift wird um die Standortdaten erweitert. * **Zugriff auf die Kamera** Durch Aktivieren dieser Funktion wird signoSign/Universal Zugriff auf die integrierte Kamera gewährt. Die digitale Signatur kann um aufgenommene Bilddaten erweitert werden. ## Benutzername anzeigen Durch Aktivierung dieser Option kann der Benutzername bei der Anmeldung an signoSign/Universal angezeigt werden. ## Stiftunterstützung Durch Aktivieren der Stiftunterstützung wird die Signiermethode innerhalb der App so eingerichtet, dass die Erfassung der Unterschrift nur mit Hilfe des gewählten Stiftes erfolgen kann. Eine Unterschrift mit dem Finger ist somit nicht mehr möglich. Durch die Stiftunterstützung können höherwertige Unterschriftsdaten erfasst werden. Insofern Ihr Gerät über eine solche Stifteingabe verfügt, empfehlen wir, diese zu nutzen. ## App Informationen Im Bereich „Systeminformationen" werden Informationen zur verwendeten App und IT-Service angezeigt. Unter „Version" wird die aktuelle Version der App angezeigt. Unter „IT-Service" finden Sie die Versionsnummer der Serverkomponente, mit welcher sich die App verbunden hat. Wurde noch keine Verbindung zu einem Server hergestellt, bleibt dieses Feld unbelegt. --- version: "v3.28.0" language: "de" --- # Architektur signoSign/Universal als Ganzes ist eine Java-Webapplikation, deren Aufgabenbereiche in verschiedene Java-Servlets aufgeteilt sind. Diese Servlets sind: | **Servlet-Name** | **Beschreibung** | |------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| | SsuOpenServlet | Verarbeitung von Anfragen für systemfremde Benutzer im Viewer. Dazu gehören Anfragen ohne Authentifizierung oder die Bearbeitung von geteilten Dokumenten. | | SsuSecureServlet | Verarbeitung von Anfragen Authentifizierter Sessions im Viewer. | | SsuSecureRestApi | Verarbeitung von Anfragen an die REST-API. | | DevTools | Bereitstellung von Hilfsmitteln für Integratoren. (optional) | | Pool | Bereitstellung einer Dokumentenverwaltung. (optional) | Die Servlet-Namen beziehen auf den Inhalt der web.xml der Anwendung. Die Servlets SsuOpenServlet, SsuSecureServlet und SsuSecureRestApi bilden eine logische Einheit und werden häufig als *Viewer* zusammengefasst. Der Begriff wird aber auch verwendet, um eine Instanz eines Viewers zu beschreiben, in die ein Dokument geladen wird. Der Viewer ist die Kernkomponente der Anwendung. Die DevTools sowie die Dokumentenverwaltung sind optionale Erweiterungen, die bei Bedarf deaktiviert werden können. **Persistenz/Datenbank:** Aus technischen Gründen benötigt signoSign/Universal eine Datenbank, die mit dem Java-Framework Hibernate kompatibel ist. Je nach Anwendungsfall müssen jedoch keine Dokumente in der Datenbank gespeichert werden. Erst erweiterte Funktionen wie das Teilen von Dokumenten oder die Verwendung von Workflows erfordern persistierte Dokumente. Aus diesem Grund wird die Anwendung mit einer H2-Datenbank ausgeliefert, die beim Start der Anwendung gestartet wird, wenn die Datenbankeinstellungen dem Auslieferungszustand entsprechen. Es wird nicht empfohlen die H2-Datenbank in einem Produktivsystem zu verwenden. Die Datenbank wird von der Viewer-Komponente und der REST-API verwendet. Die REST-API bildet auch die öffentlich Schnittstelle zur Datenbank. **Der Viewer:** Der Viewer als Komponente arbeitet ohne Persistenz, indem ein bereitgestelltes Dokument in den Arbeitsspeicher geladen wird. Änderungen werden werden nur dann in den geladenen Zustand übertragen, wenn dies explizit durch das Speichern ausgelöst wird oder es technisch notwendig ist, z.B. beim Starten einer Signatur. Beim Speichern kann das Dokument je nach Anwendungsfall in die konfigurierte Datenbank oder in ein externes System übertragen werden. Es ist auch möglich, beim Speichern weder das eine noch das andere zu tun, sondern das Dokument nur im Arbeitsspeicher zu aktualisieren, um das Dokument durch eine Integration der REST-API zu einem späteren Zeitpunkt selbst herunterzuladen und zu verarbeiten. Dokumente verbleiben im Arbeitsspeicher solange die Session besteht oder sie explizit entladen werden. Clientseitig wird in keinem Fall das Dokument benötigt. Der Zugriff und die Arbeit an den Dokumenten erfolgt nie direkt auf dem PDF. Clientseitig wird immer mit einer genauen Repräsentation des eigentlichen PDF in Form von gerenderten Bildern der Seiten und HTML-Formularen gearbeitet. Das Einbringen der Änderungen in das PDF erfolgt immer serverseitig. **Die REST-API:** Die REST-API-Schnittstelle ist als Teil der Viewer-Komponente zu verstehen und ist immer der empfohlene Ansatz für Integratoren. Die API ist in thematische Bereiche unterteilt, um die Orientierung innerhalb der API zu erleichtern. So gibt es beispielsweise einen Bereich für Dokumente, der für das Hochladen, Herunterladen und Abfragen von Dokumenten vorgesehen ist. **Der Dokumentenpool:** Die Dokumentenverwaltung, auch Pool-Anwendung genannt, nutzt ausschließlich die REST-API-Schnittstellen des Viewers und dient als Fassade für den Funktionsumfang der REST-API. **Benutzerverwaltung:** Die Verwaltung der Benutzer erfolgt nicht direkt innerhalb der Anwendung selbst, sondern es stehen zwei verschiedene Ansätze zur Verfügung. Der erste Ansatz besteht darin, OIDC (OpenID Connect) in der Anwendung zu konfigurieren. Dadurch werden die Benutzer über den entsprechenden Anbieter verwaltet. Hierbei werden die Benutzerrollen und -berechtigungen beim externen Identity Provider festgelegt. Alternativ dazu können die Benutzer über den Security-Realm des Servers bereitgestellt werden. Dabei werden die Benutzerinformationen und Zugriffsrechte direkt auf dem Server verwaltet. In beiden Fällen müssen den Benutzern geeignete Rollen zugewiesen werden, um die Anwendung nutzen zu dürfen. Für die Benutzerverwaltung stehen die REST-Ressource Users bzw. User zur Verfügung. Mithilfe dieser Ressource können verschiedene Aktionen durchgeführt werden, wie beispielsweise das Ändern der Benutzereinstellungen oder das Abrufen von Daten, die für den Betrieb der Anwendung notwendig sind. Es besteht auch die Möglichkeit, Benutzer zu löschen. Dabei ist zu beachten, dass das Löschen eines Benutzers lediglich den Benutzeraccount zurücksetzt und nicht verhindert, dass der Benutzer weiterhin die Anwendung nutzen kann. --- version: "v3.28.0" language: "de" --- # Austausch von Dokumenten mit fremden Systemen Das Remote-Saving ermöglicht, ein geladenes Dokument direkt per HTTP an ein anderes System zu senden. Die URL kann per [PATCH /viewer/configuration](https://universal.signosign.com/signoSignUniversal/documentation/swagger-ui.jsp#/Viewer/patchViewerConfiguration) mit dem Parameter *saveUrl* gesetzt werden und ändert damit die Funktion des Speicherns im Viewer. Informationen über den Status der Signaturfelder, werden beim Request mit folgenden URL-Parameter angehängt. * *sf*: Anzahl der unterschriebenen Felder * *usf*: Anzahl der nicht unterschriebenen Felder * *smf*: Anzahl der unterschriebenen Pflichtfelder * *usmf*: Anzahl der nicht unterschriebenen Pflichtfelder * *index (optional)* : Optionaler Index des Viewers der zuvor über den Aufruf [PUT /viewer/meta/index](https://universal.signosign.com/signoSignUniversal/documentation/swagger-ui.jsp#/Viewer/putViewerMetaIndex_1) gesetzt werden kann. Folgende Punkte muss von der empfangenden Seite berücksichtigt werden: * Die Möglichkeit einen Multipart-Upload (*Content-Type: multipart/form-data*) entgegennehmen zu können * Das PDF wird im Feld *saveFile* übergeben. * Das Fremdsystem muss bei Erfolg mit einer Response mit dem Inhalt JSON { "remoteSavingResponse" : "REMOTE_SAVING_SUCCESSFUL" } und im Fehlerfall mit JSON { "remoteSavingResponse" : "REMOTE_SAVING_FAILED" } antworten oder alternativ mit JSON { "remoteSavingResponse" : "REMOTE_SAVING_FAILED", "customizedSavingErrorMessage" : "my custom error message" } * Autorisierungsmöglichkeit durch Cookies (Falls eine Autorisierung notwendig ist) Das Setzen von Cookies für die Kommunikation mit fremden Systemen ist [hier](https://docs.signotec.com/de/signosign-universal/latest/kommunikation-mit-fremden-systemen.md) beschrieben. --- version: "v3.28.0" language: "de" --- # Benutzerdefinierte Einstellungen Die Benutzereinstellungen bilden eine **Teilmenge der insgesamt verfügbaren Einstellungen** der Anwendung. Sie ermöglichen es, bestimmte Konfigurationsparameter, die normalerweise in den globalen Servereinstellungen definiert sind, **mandanten- oder benutzerspezifisch zu überschreiben** . Diese Einstellungen können entweder **über die Pool‑Anwendung** oder über die **REST‑API** vorgenommen werden. ## Ebenen der Konfiguration Die effektiven Einstellungen eines Benutzers ergeben sich aus einer **klaren Prioritätshierarchie**: 1. **Servereinstellungen** Globale Konfiguration der Anwendung. 2. **Mandanteneinstellungen** Gelten für alle Benutzer eines Mandanten und überschreiben die Servereinstellungen. 3. **Benutzereinstellungen** Gelten ausschließlich für einen einzelnen Benutzer und überschreiben die Mandanteneinstellungen. Damit ergibt sich: **Servereinstellungen → Mandanteneinstellungen → Benutzereinstellungen** ## Zugriff und Gültigkeit * Änderungen in den **Benutzereinstellungen** wirken ausschließlich für den jeweiligen Benutzer. * Änderungen in den **Mandanteneinstellungen** betreffen alle Anwender desselben Mandanten. * Einstellungen, die **nicht in den Benutzereinstellungen verfügbar** sind, können ausschließlich durch Administratoren in der **zentralen Serverkonfiguration** gesetzt werden. ## Einschränkung des Umfangs Die in den Benutzereinstellungen angebotenen Optionen bilden bewusst nur **einen definierten Ausschnitt** der vollständigen Konfigurationsmöglichkeiten ab. Nicht alle global verfügbaren Properties stehen auf Benutzer‑ oder Mandantenebene zur Verfügung. ## Sensible Daten in den Benutzereinstellungen Benutzereinstellungen können grundsätzlich auch über die REST‑API ausgelesen werden; sensible Werte werden dabei jedoch aus Sicherheitsgründen mittels BCrypt gehasht zurückgegeben. --- version: "v3.28.0" language: "de" --- # Benutzereinstellungen Über das Benutzersymbol in der Kopfzeile können über den Button "Einstellungen" die Benutzereinstellungen geöffnet werden. Siehe auch [Benutzerdefinierte Einstellungen](https://signotec.atlassian.net/wiki/spaces/SSU/pages/558268417/Benutzerdefinierte+Einstellungen). ## Benutzeroberfläche | **Einstellung** | **Beschreibung** | |--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| | Bevorzugte Sprache | Definiert die bevorzugte Sprache der Anwendung. Die Einstellung "Automatisch" verwendet die bevorzugte Sprache des Browsers. | | Akzentfarbe | Definiert die Akzentfarbe innerhalb von signoSign/Universal. *Standard: #ff8400* | | Logo | Definiert eine URL für das Logo der Anwendung. Das Bild sollte ein Seitenverhältnis von 10:3 haben. Eine Auflösung von 300 x 90 Pixel wird empfohlen. | | Favicon | Definiert das Favoritensymbol (Favicon) der Anwendung. Das Bild sollte ein Seitenverhältnis von 1:1 haben. Eine Auflösung von 16 x 16 Pixel wird empfohlen. | ## Funktionen in der Dokumentenanzeige In diesem Bereich können einzelne Funktionen in der Dokumentenanzeige (im Viewer) konfiguriert werden. Die Funktionen lassen sich in der Kopfzeile oder im Untermenü anzeigen oder werden je nach Displayauflösung dynamisch ausgeblendet. Es stehen folgende Optionen zur Verfügung: | **Einstellung** | **Beschreibung** | |---------------------------------|--------------------------------------------------------------------------------------------------------------| | Dynamisch | Die Funktion wird dynamisch anhand der Displayauflösung immer eingeblendet oder in das Untermenü verschoben. | | Nur im Untermenü anzeigen | Die Funktion wird nicht in der Kopfzeile, sondern nur im Untermenü angezeigt. | | Immer in der Kopfzeile anzeigen | Die Funktion wird immer in der Kopfzeile angezeigt und nicht ins Untermenü verschoben. | | Ausblenden | Die Funktion wird vollständig ausgeblendet und steht nicht zur Verfügung. | ## Erlaubte Signiermethoden | **Einstellung** | **Beschreibung** | |------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Maus | Erlaubt das Unterschreiben mit einer Maus. | | Toucheingabe | Erlaubt das Unterschreiben über Touch. | | Elektronischer Stift | Erlaubt das Unterschreiben über einen elektronischen Stift (z. B. Apple Pencil). | | signotec Unterschriftenpad | Erlaubt das Unterschreiben mit einem signotec Unterschriftenpad. | | Click to Sign | Erlaubt das Signieren des Dokuments durch Eingabe des Namens. Bei dieser Methode wird keine handschriftliche Signatur erfasst. Für die Erhöhung des Beweiswerts wird daher die Kombination mit einer TAN empfohlen. | | Qualifizierte Signatur mit sign-me | Erlaubt eine qualifizierte Signatur über sign-me. | Wenn eine nicht erlaubte Methode verwendet wird, erhält der Benutzer beim Unterschreiben eine Fehlermeldung mit der Information, welche Eingabemittel erlaubt sind. ## Signatureinstellungen | **Einstellung** | **Beschreibung** | |-------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Biometrische Daten erfassen und im Dokument speichern | Konfiguriert, ob die biometrischen Daten der Unterschrift (X-, Y-, Z-Koordinaten sowie Zeit und Druck) verschlüsselt im Dokument gespeichert werden sollen. Diese Speicherung erfolgt zum späteren Nachweis, dass die Unterschrift vom Unterzeichner geleistet wurde. ++Aktiviert:++ Die biometrischen Daten der Unterschrift werden verschlüsselt im Dokument gespeichert. ++Deaktiviert:++ Die biometrischen Daten werden nicht im Dokument gespeichert. Die biometrischen Daten sind ein wesentlicher Bestandteil der Sicherheit und Authentizität elektronischer Unterschriften und für eine spätere Beweisführung sehr wichtig. Für eine DSGVO-konforme Erfassung und Speicherung dieser Daten kann z. B. ein Bestätigungstext vor der Unterschrift in der Software konfiguriert werden. *Standard: Aktiviert* | | Automatisches Speichern | Legt fest, ob und wann das Dokument automatisch gespeichert werden soll. ++Deaktiviert:++ Das Dokument wird nicht automatisch gespeichert. ++Beim Start des Signiervorgangs:++ Das Dokument wird automatisch gespeichert, wenn eine Signaturerfassung gestartet wird. ++Beim Bestätigen einer Signatur:++ Das Dokument wird automatisch gespeichert, wenn eine Signatur bestätigt wird. ++Nach Abschluss aller Signaturen:++ Das Dokument wird automatisch gespeichert, wenn alle Signaturen geleistet wurden. ++Beim Schließen des Dokuments:++ Das Dokument wird automatisch gespeichert, wenn das Dokument geschlossen bzw. verlassen wird. Die Speicherung erfolgt sofort und ohne Benutzerinteraktion. Die Speicherung kann nicht rückgängig gemacht werden. *Standard: Deaktiviert* | | Signiervorgang sofort starten | Legt fest, ob beim Öffnen eines Dokuments sofort automatisch der Signaturvorgang gestartet werden soll. ++Deaktiviert:++ Der Signaturvorgang wird nicht automatisch gestartet. ++Mit erster Signatur starten:++ Nach dem Öffnen des Dokuments wird sofort der Signaturvorgang für die erste Signatur im Dokument gestartet. ++Mit erster Pflichtsignatur starten:++ Nach dem Öffnen des Dokuments wird sofort der Signaturvorgang für die erste Pflichtsignatur im Dokument gestartet. | | Formularfelder sperren | Legt fest, inwieweit vorhandene elektronische Formularfelder (ausgenommen Signaturfelder) mit der ersten Signatur im Dokument gesperrt werden. Gesperrte Formularfelder können nicht mehr geändert werden. ++Alle:++ Die Signatur sperrt alle Formularfelder im Dokument, unabhängig von den Einstellungen im Dokument. ++Ausgefüllt oder im Dokument definiert:++ Die Signatur sperrt alle Formularfelder, die im Dokument bzw. innerhalb des Signaturfeldes definiert sind. Zusätzlich werden alle ausgefüllten Formularfelder gesperrt. ++Wie im Dokument definiert:++ Die Signatur sperrt alle Formularfelder, die im Dokument bzw. innerhalb des Signaturfeldes definiert sind. Die Definition im Dokument erfolgt über spezielle Einstellungen innerhalb der Signaturfelder, dem sogenannten "Lock Dictionary". Dieses kann nicht über signoSign/Universal editiert werden und erfordert ein professionell erstelltes PDF-Formular. *Standard: Wie im Dokument definiert* | | Signaturfarbe | Legt die Stiftfarbe für das Unterschreiben fest. *Standard: #0000ff* | | Signaturzusatz | Legt fest, ob zusätzlich zur Unterschrift ein Zusatz angezeigt werden soll. ++Inhalt:++ Legt den Inhalt des Signaturzusatzes fest. Dieser kann einen festen Text und/oder die Platzhalter "@SIGNTIME" mit dem aktuellen Datum und der aktuellen Uhrzeit und "@LOCATION" mit Standortdaten enthalten. ++Datumsformat:++ Legt das Datumsformat des Platzhalters "@SIGNTIME" fest. ++Horizontale Ausrichtung:++ Legt die horizontale Ausrichtung des Textes innerhalb des Signaturfeldes fest. ++Vertikale Ausrichtung:++ Legt die vertikale Ausrichtung des Textes innerhalb des Signaturfeldes fest. | ## Qualifizierte Signatur Die Nutzung von Qualifizierten Signaturen ist grundsätzlich kostenpflichtig. Bitte kontaktieren Sie hierzu Ihren Vertriebspartner oder das Vertriebsteam von signotec. | **Einstellung** | **Beschreibung** | |-----------------|----------------------------------------------------------------------------------------------------| | Lizenzschlüssel | Hinterlegt den Lizenzschlüssel für die Freischaltung und Abrechnung der qualifizierten Signaturen. | ## E-Mail-Einstellungen | **Einstellung** | **Beschreibung** | |-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Eigenen SMTP-Server verwenden | Legt fest, ob automatische E-Mails über einen eigenen Mailserver versendet werden. ++Aktiviert:++ Es wird ein individueller Mailserver verwendet. Dazu müssen Server, Port, Anzeigename, Absenderadresse und optional eine Authentifizierung konfiguriert werden. Über den Button „Verbindung testen" können die Einstellungen getestet werden. Dabei wird eine Test-E-Mail an den angemeldeten Benutzer versendet. Eine fehlerhafter Konfiguration kann dazu führen, dass keine E-Mails mehr versendet werden. Bitte nehmen Sie die Einstellungen mit Sorgfalt vor. ++Deaktiviert:++ Es wird der Standardserver des Systems verwendet. *Standard: Deaktiviert* | | Versandmethode | Legt fest, über welche Methode E-Mails versendet werden. ++Server:++ Die E-Mails werden über den signoSign/Universal Server versendet. ++Client (mailto):++ E-Mails werden auf dem Client über die "mailto"-Funktion und damit über das Standard-E-Mail-Programm versendet. Diese Einstellung wirkt sich nur auf das einfache Teilen von Dokumenten aus. Workflows werden immer vom Server versendet. *Standard: Server* | ## SMS Einstellungen Die Nutzung von SMS ist grundsätzlich kostenpflichtig. Bitte kontaktieren Sie hierzu Ihren Vertriebspartner oder das Vertriebsteam von signotec. | **Einstellung** | **Beschreibung** | |-----------------|--------------------------------------------------------------------------------| | Freischaltcode | Hinterlegt den Freischaltcode für die Nutzung und Abrechnung der SMS-Funktion. | ## Einstellungen zurücksetzen Über den Button "Zurücksetzen" werden alle Einstellungen auf den aktuellen Standard zurückgesetzt. Der Vorgang kann nicht rückgängig gemacht werden! --- version: "v3.28.0" language: "de" --- # Benutzerhandbuch Die Anwendung signoSign/Universal ist eine webbasierte Software zur Anzeige, Bearbeitung und handgeschriebenen Signatur von PDF-Dokumenten. Die Nutzung kann über jeden HTML5-fähigen Browser sowie die signotec Apps erfolgen. Darüber hinaus bietet die Anwendung die Möglichkeit, Dokumente einzeln oder als Teil eines Workflows mit externen Personen zu teilen. Hierbei wird der Zugriff auf einzelne Dokumente über einen Link gesteuert. Das Besondere daran ist, dass der externe Benutzer keine Logindaten für die Anwendung benötigt. Neben diesen Funktionen lässt sich die Anwendung auch über verschiedene Schnittstellen in eigene Systeme und Prozesse integrieren. Alle Benutzerfunktionen werden in diesem Bereich des Handbuchs erläutert. * [Nutzung am Computer](https://docs.signotec.com/de/signosign-universal/latest/nutzung-am-computer.md) * [Mobile Apps](https://docs.signotec.com/de/signosign-universal/latest/mobile-apps.md) * [Funktionen des „Document Pool"](https://docs.signotec.com/de/signosign-universal/latest/funktionen-des-document-pool.md) * [Funktionen des signoSign/Universal Viewer](https://docs.signotec.com/de/signosign-universal/latest/funktionen-des-signosign-universal-viewer.md) --- version: "v3.28.0" language: "de" --- # Benutzerverwaltung Die Verwaltung der Benutzer erfolgt nicht direkt innerhalb der Anwendung selbst, sondern es stehen zwei verschiedene Ansätze zur Verfügung. Der erste Ansatz besteht darin, [OIDC](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-auth.md) (OpenID Connect) in der Anwendung zu konfigurieren. Dadurch werden die Benutzer über den entsprechenden Anbieter verwaltet. Hierbei werden die Benutzerrollen und -berechtigungen beim externen Identity Provider festgelegt. Alternativ dazu können die Benutzer über den Security-Realm des Servers bereitgestellt werden. Dabei werden die Benutzerinformationen und Zugriffsrechte direkt auf dem Server verwaltet. In beiden Fällen müssen den Benutzern geeignete Rollen zugewiesen werden, um die Anwendung nutzen zu dürfen. Für die Benutzerverwaltung stehen die REST-Ressource [Users](https://universal.signosign.com/signoSignUniversal/documentation/swagger-ui.jsp#/Users) bzw. [User](https://universal.signosign.com/signoSignUniversal/documentation/swagger-ui.jsp#/User) zur Verfügung. Mithilfe dieser Ressource können verschiedene Aktionen durchgeführt werden, wie beispielsweise das Ändern der Benutzereinstellungen oder das Abrufen von Daten, die für den Betrieb der Anwendung notwendig sind. Es besteht auch die Möglichkeit, Benutzer zu löschen. Dabei ist zu beachten, dass das Löschen eines Benutzers lediglich den Benutzeraccount zurücksetzt und nicht verhindert, dass der Benutzer weiterhin die Anwendung nutzen kann. --- version: "v3.28.0" language: "de" --- # Bereiche der Software ## Kopfzeile Die Kopfzeile enthält linksbündig das signoSign/Universal Logo, welches durch ein benutzerdefiniertes Logo ausgetauscht werden kann. Rechtsbündig befinden sich ein Benutzersymbol und ein Hilfesymbol. Über das **Benutzersymbol** kann auf [Einstellungen](https://docs.signotec.com/de/signosign-universal/latest/benutzereinstellungen.md), [Dokumententypen](https://docs.signotec.com/de/signosign-universal/latest/dokumententypen.md) und [Statistiken](https://docs.signotec.com/de/signosign-universal/latest/statistiken.md) zugegriffen werden. Außerdem kann man sich hier von der Anwendung abmelden. Über das **Hilfemenü**kann auf das Handbuch sowie weitere Informationen zur Anwendung und den Nutzungsbedingungen zugegriffen werden. ![image-20240918-065708.png](https://docs.signotec.com/__attachments/a_639eaffc5ed1c3445644d422ce2980b416d68cf26b3d826a5941d56966a46475/image-20240918-065708.png?cb=5f642285620b118c6a0f491190d91f97) *Screenshot: Benutzermenü* ## Hauptmenü Auf der linken Seite der Anwendung befindet sich das Hauptmenü. Es enthält einen hervorgehobenen "Erstellen"-Button sowie die weiteren Bereiche der Software. ![image-20240918-070146.png](https://docs.signotec.com/__attachments/a_caac185048a1732d6e59eb6628badf8014f4ee4499329ebd3596f49fd0292e9f/image-20240918-070146.png?cb=989f3b2af310a84a1c49bd3923a25640) *Screenshot: Hauptmenü und Dashboard* ### Schaltfläche „Erstellen" Über die hervorgehobene Schaltfläche "Erstellen" können neue Dokumente hochgeladen oder ein neuer Workflow erstellt werden. Der Button ist überall in der Software leicht erreichbar. ### Bereich „Dashboard" Im Bereich „Dashboard" finden Sie eine Auswahl von Schnellstartfunktionen, wie z. B. das Hochladen oder Öffnen eines Dokuments sowie das Erstellen eines Workflows. Außerdem finden Sie eine Übersicht der Anzahl der aktiven Vorgänge mit Verlinkung zu den einzelnen Bereichen. ### Bereich „Vorlagen" Im Bereich „Vorlagen" können Sie Dokumente, die Sie immer wieder verwenden möchten, statisch als „Blanko" ablegen. Dokumente, die Sie aus diesem Bereich zur Bearbeitung öffnen, werden beim Speichern als neues Dokument im Bereich „Dokumente" abgelegt. Die Vorlage selbst bleibt unverändert und kann daher immer wieder verwendet werden. Mehr Informationen zur Verwaltung von Dokumenten finden Sie im Kapitel "[Verwaltung von Dokumenten](https://docs.signotec.com/de/signosign-universal/latest/verwaltung-von-dokumenten.md)". Es ist nicht möglich, eine Vorlage zu bearbeiten. Wenn Sie Änderungen an der Vorlage vornehmen möchten, speichern Sie die Vorlage zunächst als Dokument ab und wandeln Sie dieses anschließend wieder in eine Vorlage um. Dies geht ganz einfach über die Funktion "Verschieben". ### Bereich „Dokumente" Im Bereich "Dokumente" stehen individuelle Dokumente zur Verfügung. Diese Dokumente werden im Gegensatz zu den Vorlagen durch inhaltliche Änderungen oder durch die Erfassung von Unterschriften überschrieben. Sofern ein Dokument geteilt wurde, wird neben dem Dateinamen ein Papierflieger-Symbol angezeigt. Wenn Sie auf dieses Symbol klicken, öffnet sich eine Liste, in der Sie die geteilten Zugriffe auf das Dokument einsehen und verwalten können. Weitere Informationen finden Sie im Kapitel „[Dokumente teilen](https://docs.signotec.com/de/signosign-universal/latest/dokumente-teilen.md)". Mehr Informationen zur Verwaltung von Dokumenten finden Sie im Kapitel "[Verwaltung von Dokumenten](https://docs.signotec.com/de/signosign-universal/latest/verwaltung-von-dokumenten.md)". ### Bereich „Geteilte Zugriffe" Im Bereich „Geteilte Zugriffe" werden alle Vorgänge angezeigt, die über die Funktion „Zugriff teilen" oder „Dokument teilen" erzeugt wurden. Noch nicht bearbeitete Vorgänge werden unter „**In Bearbeitung** " angezeigt. Alle erfolgreich abgeschlossenen Vorgänge werden unter „**Abgeschlossen** " angezeigt. Alle vom Empfänger abgelehnten Vorgänge werden unter "**abgelehnt**" angezeigt. In beiden Bereichen können Sie sehen, wann welche Dokumente geteilt wurden und ob das geteilte Dokument bereits bearbeitet wurde. Von hier aus können Sie diese Vorgänge auch wieder löschen, so dass der erzeugte Link ungültig wird. Weitere Informationen finden Sie im Kapitel „[Dokumente teilen](https://docs.signotec.com/de/signosign-universal/latest/dokumente-teilen.md)". ### Bereich „Workflows" Im Bereich „Workflows" werden alle erstellten Workflows angezeigt. Der Bereich ist analog zu den geteilten Zugriffen in „In Bearbeitung" und „Abgeschlossen" unterteilt. Im Bereich „In Bearbeitung" werden alle Workflows aufgelistet, die noch nicht abschließend bearbeitet wurden. In diesem Bereich wird der Status anhand eines Fortschrittsbalkens angezeigt. Außerdem können hier weitere Informationen zu den Workflows abgerufen werden. Alle abgeschlossenen oder abgebrochenen Workflows finden Sie im Bereich „Abgeschlossen". Weitere Informationen finden Sie im Kapitel „[Workflows](https://docs.signotec.com/de/signosign-universal/latest/workflows.md)". --- version: "v3.28.0" language: "de" --- # Konfiguration Die globalen Servereinstellungen werden in einer Standard Java Properties-Datei festgelegt. Die Anwendung enthält eine Datei mit Standardeinstellungen, die entweder direkt bearbeitet oder durch eine [externe Properties-Datei](https://docs.signotec.com/de/signosign-universal/latest/configuration.md#Konfiguration-auslagern) überladen werden kann. Änderungen an den Einstellungen werden erst nach einem Neustart der Anwendung wirksam. *\[WEB-APP-ROOT\]/WEB-INF/classes/settings.properties* *\[WEB-APP-ROOT\]/ssu_web-x.x.x.x.war/WEB-INF/classes/settings.properties* Dieses Kapitel beschreibt die möglichen Einstellungen in der Properties-Datei und wie diese Einstellungen festgelegt werden können. In den folgenden Seiten wird auf die unterschiedlichen Bereiche der Konfigurationsmöglichkeiten eingegangen: * [Einstellungen: business](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-business.md) * [Einstellungen: web](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-web.md) * [Einstellungen: persistence](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-persistence.md) * [Einstellungen: hibernate](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-hibernate.md) * [Einstellungen: deployment](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-deployment.md) * [Einstellungen: restapi](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-restapi.md) * [Einstellungen: smtp](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-smtp.md) * [Einstellungen: ltv](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-ltv.md) * [Einstellungen: tsa](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-tsa.md) * [Einstellungen: jobs](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-jobs.md) * [Einstellungen: pool](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-pool.md) * [Einstellungen: SMS](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-sms.md) * [Einstellungen: auth](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-auth.md) * [Einstellungen: remoteSignature](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-remotesignature.md) * [Einstellungen: logging](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-logging.md) * [Einstellungen: webhooks](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-webhooks.md) * [Einstellungen: redisson](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-redisson.md) * [Einstellungen: passwords](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-passwords.md) * [Benutzerdefinierte Einstellungen](https://docs.signotec.com/de/signosign-universal/latest/benutzerdefinierte-einstellungen.md) ## Umgebungs- und Systemvariablen Jede Einstellung aus der Properties-Datei kann auch durch Java System-Properties und Umgebungsvariablen festgelegt/überschrieben werden. Die Punkte in den Variablennamen können optional durch Unterstriche ersetzt werden. **Format:** *signotec.ssu.* \[EINSTELLUNG\] **Beispiele:** * Bash export signotec_ssu_business_licenseKey=myLicenseKey * Bash set signotec.ssu.business.licenseKey=myLicenseKey * Bash -Dsignotec.ssu.business.licenseKey=myLicenseKey * Umgebungsvariablen mit Punkten sind nicht in jedem Betriebssystem erlaubt. Wir empfehlen, pauschal alle Punkte durch Unterstriche zu ersetzen. `signotec.ssu.business.licenseKey` - \> `signotec_ssu_business_licenseKey` * Es wird empfohlen, die Java System-Properties zu verwenden, weil sich der Abruf der Umgebungsvariablen auf verschiedenen Java-Servern voneinander unterscheiden kann. ## Konfiguration auslagern Um die Wartung der Anwendung zu vereinfachen, sollten die Einstellungen getrennt von der Webanwendung gespeichert werden. Anstatt die Standardeinstellungen im Auslieferungspaket zu bearbeiten, sollten Einstellungen in einer externen Properties-Datei festgelegt werden. Machen Sie eine Kopie der Standardeinstellungen und legen Sie mit der Umgebungsvariable `signotec_ssu_externalpropertiesfile` den Speicherort der Kopie fest. Bash export signotec_ssu_externalpropertiesfile=/myConfigFolder/ssu/settings.properties Beim Start wird signoSign/Universal erst die Standardeinstellungen laden und diese anschließend mit den externen Einstellungen erweitern/überschreiben. --- version: "v3.28.0" language: "de" --- # Konfiguration des PDF-Druckers ## Serverzugriff konfigurieren Die Zugangsdaten zu signoSign/Universal müssen in den Einstellungen hinterlegt werden. Bei Verwendung des signoSign/Universal Uploaders werden diese Zugangsdaten dann für die automatische Anmeldung verwendet. Wenn Sie signoSign/Universal über signotec bereitgestellt bekommen, werden Ihnen diese Zugangsdaten nach erfolgreicher Registrierung an die E-Mail-Adresse des Benutzers gesandt. Server-URL: https://universal.signosign.com/signoSignUniversal Benutzer: *Ihre Mailadresse* Passwort: *Ihr persönliches Kennwort* Falls Sie signoSign/Universal auf einem eigenen Server betreiben, fragen Sie bitte Ihren Systemadministrator nach den erforderlichen Zugangsdaten. ## Konfiguration vor der Übertragung anzeigen Die Einstellung „Konfiguration vor der Übertragung anzeigen" ist per Standard aktiviert und ermöglicht die Aktualisierung der Nutzerdaten bei jedem individuellen Start der Anwendung. Die Wahl einer auszuführenden Standardaktion wird im Zuge der Aktivierung grundsätzlich verhindert. ## Standard-Aktionen Um einen möglichst komfortablen Betrieb zu gewährleisten, lassen sich Standard-Aktionen definieren, die beim Start der Anwendung, bzw. bei Anlieferung eines Dokumentes, automatisch ausgeführt werden. Um eine Standard-Aktion auszuwählen, muss die Option „Konfiguration vor der Übertragung anzeigen" deaktiviert sein, denn die Anzeige des Programmfensters wird durch Setzen einer Standard-Aktion verhindert. Folgende Standard-Aktionen stehen zur Verfügung: * ++Keine (Auswahl anzeigen)++: Dies ist der vorausgewählte Standardwert. Bei jeder Verwendung des signoSign/Universal Uploaders wird ein Dialog mit den verfügbaren Aktionen angeboten. Somit ist es bei jedem individuellen Start des Uploaders möglich, die gewünschte Aktion auszuführen. * ++Unterschreiben:++ Diese Aktion lädt das gewünschte PDF- oder SGN-Dokument als „Dokument" an signoSign/Universal hoch und öffnet dieses automatisch zur Unterschriftenerfassung im Standardbrowser. Wird das Dokument direkt unterschrieben oder hinsichtlich des Inhaltes anderweitig geändert und gespeichert, wird die Aktualisierung des Dokumentes auch am Server vorgenommen. Das geänderte Dokument kann über die entsprechende Schaltfläche wieder heruntergeladen werden. * ++Teilen:++Diese Aktion lädt das gewünschte PDF- oder SGN-Dokument als „Dokument" an signoSign/Universal hoch und erstellt über die Teilen-Funktion automatisch einen Zugriffslink auf dieses Dokument, welcher dem Unterzeichner per E-Mail zur Verfügung gestellt werden kann. Für den Zugriff auf das geteilte Dokument ist kein Kennwort erforderlich, bzw. ist die Vergabe von Kennworten zum aktuellen Zeitpunkt leider nicht möglich. Der signotec signoSign/Universal Uploader ermöglicht das komfortable Öffnen lokaler Dokumente zur Unterschrift in der Webanwendung signoSign/Universal. Der Uploader kann ein einzelnes Dokument zur Zeit übermitteln und verarbeiten lassen. Das parallele Öffnen von Dokumenten, beispielsweise in Tabs, ist nicht möglich. Bitte beachten Sie, dass der Löschvorgang eines „Dokumentes", welches als Grundlage für geteilte Dokumente dient, automatisch auch alle Teilen-Vorgänge auf dieses Dokument entfernt. Die erstellten Links werden somit ungültig. ## Konfigurationsdatei Print to signoSign/Universal legt automatisch eine Konfigurationsdatei im AppData-Pfad (C:\\Users\\%BENUTZERNAME%\\AppData\\Roaming\\signotec\\signoSignUniversal Uploader) an, um die benutzerspezifische Konfiguration vorzuhalten. Lese-, Schreib- und Änderungsberechtigungen auf dieses Verzeichnis sind für den Betrieb erforderlich. Diese benutzerspezifische Konfigurationsdatei bleibt auch nach der Deinstallation für eine etwaige Neuinstallation von Print to signoSign/Universal erhalten. --- version: "v3.28.0" language: "de" --- # Datenbank konfigurieren Für den Betrieb von signoSign/Universal ist es notwendig, eine Datenbank anzubinden. Diese wird insbesondere für folgende Funktionen benötigt: * Speichern von Vorlagen und Dokumente (z. B. durch Nutzung des Document Pool) * Teilen von Dokumenten (Sharingcases) * Hinterlegung von Keystores * Erstellung von Audit-Logs ## H2-Datenbank (Standard) Standardmäßig verwendet signoSign/Universal im Auslieferungszustand eine H2-Datenbank. Diese Datenbank wird zusammen mit der signoSign/Universal-Anwendung gestartet bzw. beim ersten Start automatisch erzeugt (falls nicht vorhanden). Der Pfad, an der die H2-Datenbank erzeugt wird, kann über die Einstellungen definiert werden. In den Hibernate-Connector-Einstellungen innerhalb „settings.properties" kann hierzu die „connectionurl" frei definiert werden. Die folgenden Standardeinstellungen von signoSign/Universal erzeugen die H2 Datenbank im ausführenden Verzeichnis des Servers: XML hibernate.connectiondriverClassName=org.h2.Driver hibernate.dialect=org.hibernate.dialect.H2Dialect hibernate.connectionurl=jdbc:h2:tcp://localhost/./SSU_DB/ssupersistencedb hibernate.connectionusername=sa hibernate.connectionpassword= Bitte beachten Sie, dass der Server (z. B. Apache Tomcat) ausreichend Rechte benötigt, um am konfigurierten Pfad eine Datenbankdatei abzulegen bzw. zu verwalten. Die H2-Datenbank ist nur für sehr einfache Anwendungsfälle und insbesondere für Testzwecke geeignet. Es wird dringend empfohlen, eine externe, administrierbare Datenbank zu verwenden. Die Verwendung der H2-Datenbank kann langfristig zu Performance- und Kompatibilitätsproblemen führen! ## Externe Datenbank anbinden Wenn die H2-Datenbank nicht genutzt werden soll, kann auch eine andere Hibernate-kompatible Datenbank (z. B. MySQL oder PostgreSQL) angebunden werden. Hierzu müssen die Hibernate-Connector-Einstellungen in der „settings.properties" angepasst werden und das jeweilige API der Datenbank (ähnlich wie beim Java 11 Patch) zur Verfügung gestellt werden. Detaillierte Informationen hierzu finden Sie in der technischen Dokumentation. Beispiel anhand einer MySQL: XML hibernate.connectiondriverClassName=com.mysql.cj.jdbc.Driver hibernate.dialect=org.hibernate.dialect.MySQLDialect hibernate.connectionurl=jdbc:mysql://[DB-SERVER] hibernate.connectionusername=[DB-USER] hibernate.connectionpassword=[USER-PASSWORD] --- version: "v3.28.0" language: "de" --- # 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](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-web.md#Sichtbarkeit-der-Toolbar-Buttons) festgelegt. Der Button wird deaktiviert dargestellt, wenn die Sharing Case Funktion mit der Einstellung [persistence.documentSharing](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-persistence.md#persistence.documentSharing) deaktiviert ist. Mit der REST-API Ressource [sharingcases](https://universal.signosign.com/signoSignUniversal/documentation/swagger-ui.jsp#/Sharing%20cases) können Sharing Cases [erstellt](https://universal.signosign.com/signoSignUniversal/documentation/swagger-ui.jsp#/Sharing%20cases/postSharingcase), [bearbeitet](https://universal.signosign.com/signoSignUniversal/documentation/swagger-ui.jsp#/Sharing%20cases/patchSharingCase) und [gelöscht](https://universal.signosign.com/signoSignUniversal/documentation/swagger-ui.jsp#/Sharing%20cases/deleteSharingCase) 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](https://universal.signosign.com/signoSignUniversal/documentation/swagger-ui.jsp#/Sharing%20cases/getSharingcaseUrl) abrufbar und berücksichtigt bei der Generierung die [ssmPublicUrl](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-web.md#web.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](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-persistence.md#persistence.documentSharingRejectable) dies vorsieht, kann ein Empfänger ein Dokument auch unter Angabe eines Grundes ablehnen. Sofern [SMTP-Einstellungen](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-smtp.md) 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](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-persistence.md#persistence.documentSharingRejectable) oder für bestimmte Dokumente über einen entsprechenden [Dokumententyp](https://docs.signotec.com/de/signosign-universal/latest/konfiguration-von-dokumententypen.md) 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](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-persistence.md#persistence.documentSharingDeferrable) oder für bestimmte Dokumente über einen entsprechenden [Dokumententyp](https://docs.signotec.com/de/signosign-universal/latest/konfiguration-von-dokumententypen.md) aktiviert werden. --- version: "v3.28.0" language: "de" --- # Dokumente Die Anwendung unterstützt ausschließlich PDF-Dokumente. Andere Dateiformate müssen vor der Verwendung in das PDF-Format konvertiert werden, um in der Anwendung verarbeitet werden zu können. Die **PDF-Norm** dient dabei als Orientierung für sämtliche Implementierungen für den Viewer. Dementsprechend wird ein fehlerfreier Betrieb nur gewährleistet, wenn die verwendeten PDF-Dateien der Norm entsprechen. Abweichungen oder fehlerhafte PDF-Strukturen **können** zu Darstellungs- oder Verarbeitungsproblemen führen. ## Metadaten zu Dokumenten Neben den Binärdaten des Dokuments werden auch Metadaten zu einem Dokument gespeichert. Folgende Tabelle listet diese auf. | **Bezeichnung** | **Beschreibung** | |--------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ID | Numerische Identifikationsnummer des Dokuments im System. | | Besitzer des Dokuments | Der Besitzer des Dokuments. Der Besitzer eines Dokuments kann nur durch administrative Eingriffe geändert werden. | | Typ des Dokuments (`parentId`) | Mehr Informationen sind im Abschnitt [Typen von Dokumenten und ihre Parent ID](https://docs.signotec.com/de/signosign-universal/latest/dokumente.md#Typen-von-Dokumenten-und-ihre-Parent-ID) enthalten. | | Dateiname | Der Name eines Dokuments. Entspricht in aller Regel dem Namen der Datei während des Hochladens in die Datenbank. | | Dateigröße | Ein ganzzahliger Wert, der die Größe der Binärdaten in Bytes angibt. | | Zeitpunkt der Erstellung | Der Zeitpunkt, zu dem das Dokument im System entstanden ist. | | Zeitpunkt der letzten Änderung | Der Zeitpunkt zu dem das Dokument zuletzt geändert wurde. Unmittelbar nach Entstehung eines Dokuments ist dieser Wert leer. | | Datei-Hash | Der zuletzt entstandene Hash-Wert der Binärdaten des Dokuments. Dieser Hash wird auch für Signaturprozesse verwendet. | | Platzhalter-Flag (`placeholder`: `true`/`false`) | Dieses Dokument ist ein exemplarisches Beispiel für die zu verwendenden Dokumente. Bisher spielt diese Information nur für Workflow-Pläne (`BLUEPRINT`-Dokumente) eine funktionale Rolle. Bei `true` muss zum Start des Workflow-Plans ein konkretes Dokument an das System übergeben werden. | ## Typen von Dokumenten und ihre Parent-ID Der Typ eines Dokuments beschreibt bestimmte Verhaltensweisen, Anwendungsfälle oder Einschränkungen zu einem Dokument. Folgende Typen von Dokumenten gibt es. | **Bezeichnung** | **Beschreibung** | |-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `DOCUMENT` | Der Standard-Typ. Beim Abspeichern eines solchen Dokuments, überschreibt es den ursprünglichen Zustand in der Datenbank. | | `TEMPLATE` | Dient als Vorlage für Dokumente. Beim Abspeichern wird eine Kopie des Dokuments mit dem geänderten Zustand angelegt. Das neue Dokument hat den Typ `DOCUMENT`. Sobald eine Vorlage im Viewer gespeichert wurde, ändert sich das geladene Dokument in `DOCUMENT`. Mehrfaches Speichern führt daher nicht zu mehr als einem neuem Dokument. | | `BLUEPRINT` | Das Dokument ist Bestandteil eines Workflow-Plans. Beim Start dieses Plans wird eine Kopie als `PROCESS`-Dokument für den entstehenden Workflow-Prozess angelegt. Diese Dokumente werden nicht von der Pool-Anwendung angezeigt. | | `PROCESS` | Diese Dokumente werden nur im Kontext eines Workflow-Prozesses bearbeitet. Diese Dokumente werden nicht von der Pool-Anwendung angezeigt. | Der Typ eines Dokuments leitet sich direkt von dem `parentId`-Wert ab. Der Wert gibt an, von welchem Dokument ein Dokument abgeleitet wurde. Negative Werte können weitere Informationen ausdrücken. | **Werte** | **Bedeutung** | |-----------|----------------------------------------------------------------------------------------------------------------------------| | `>0` | Das Dokument Stammt von dem Dokument mit dieser ID ab. | | `-1` | Das Dokument ist ein `TEMPLATE`-Dokument. | | `-2` | Ein `DOCUMENT`, dass über die REST-API in die Datenbank geladen wurde. | | `-3` | Ein `DOCUMET` , dass über die REST-API direkt in den Viewer geladen wurde und von dort in die Datenbank gespeichert wurde. | | `-4` | Ein `TEMPLATE`, dass nachträglich in ein `DOCUMENT `geändert wurde. | | `-5` | Ein `BLUEPRINT` Dokument, dass zum Anlegen eines Workflow-Plans angelegt wurde. | | `-6` | Ein `PROCESS` Dokument, dass beim Start eines Workflow-Prozesses angelegt wurde. | ## Verfügbarkeit von Dokumenten im System limitieren Die Verfügbarkeit von Dokumenten kann systemweit durch eine aktivierbare Löschroutine eingeschränkt werden. Dabei kann definiert werden, wie lange ein Dokument nach seiner Erstellung bzw. Veränderung im System verbleiben darf. Nach Einrichtung dieser Löschroutine zeigt die Pool-Anwendung an, wie lange die entsprechenden Dokumente, geteilten Zugriffe oder Workflows noch im System verfügbar sein werden, bevor sie automatisch gelöscht werden. Mehr Informationen zur Einrichtung der Löschroutine finden Sie [hier](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-jobs.md). --- version: "v3.28.0" language: "de" --- # Dokumente teilen signoSign/Universal bietet Ihnen die Möglichkeit, Dokumente mithilfe eines Links mit einer externen Person zu teilen. Das Besondere dabei ist, dass diese Person keine Logindaten benötigt, um das Dokument zu öffnen und zu unterschreiben. Ein solcher Vorgang wird in signoSign/Universal auch als „Sharing Case" bezeichnet. Ein Dokument kann beliebig oft geteilt werden. Jedes Teilen erzeugt dabei einen einzigartigen Link, der direkt auf das ausgewählte Dokument verweist. Wenn das Dokument über einen Link bearbeitet wird, sind die Änderungen sofort in Ihrer Ablage sichtbar. Die Links verlieren aus Sicherheitsgründen nach Bearbeitung durch den Empfänger ihre Gültigkeit. Der erzeugte Link kann von Jedermann geöffnet werden. Insofern der Link nicht mit einem Passwort geschützt ist, kann jeder, der den Link kennt, das Dokument öffnen. ## Dokument aus dem Document Pool teilen Um ein Dokument zu teilen, nutzen Sie einfach die Funktion „Zugriff teilen" bzw. „Dokument teilen". Es wird Ihnen ein Fenster angezeigt, wo Sie optional ein Passwort und einen Kommentar hinterlegen können. Zudem ist ein automatischer Versand des Zugangs per E-Mail oder SMS möglich. Auch ist die [Zuweisung von Formularfeldern](https://docs.signotec.com/de/signosign-universal/latest/dokumente-teilen.md#Formularfelder-zuweisen) möglich. ![image-20250319-125016.png](https://docs.signotec.com/__attachments/a_27d32ea97e46566f4bb8fafe1f8b67264068cc03a6bd57c16b2050326e083d92/image-20250319-125016.png?cb=ff31ca52d303b4b4f5d2e751b8905221) *Screenshot: Dokument teilen* Nachdem Sie auf „Zugriff teilen" geklickt haben, werden Ihnen die Details und ein QR-Code angezeigt. In diesem Fenster können Sie das Passwort für den Zugriff zurücksetzen oder auch den Kommentar bearbeiten. Über „Link kopieren" können Sie den Zugangslink direkt in die Zwischenablage kopieren und z. B. in eine eigene E-Mail einfügen. Über „Erneut senden" können Sie den Zugriffslink zum Dokument erneut per SMS oder E-Mail versenden. Diesen Dialog mit den Informationen und QR-Code können Sie an vielen Stellen über den Button „Details" erneut aufrufen, z. B. über den Bereich „Geteilte Zugriffe". ### Formularfelder zuweisen Wenn Sie ein Dokument teilen, können Sie dem Empfänger Formularfelder zuweisen. Im Teilen-Dialog wird Ihnen hierzu die Schaltfläche „Formularfelder zuweisen" angeboten. Es öffnet sich eine Vorschau des Dokuments. Hier können Sie per Klick auf das Feld oder per Auswahl über die Seitenleiste Formularfelder an- oder abwählen. Ausgewählte Felder werden grün, nicht ausgewählte Felder rot dargestellt. Der Empfänger des Dokuments kann nur die ausgewählten Felder sehen und bearbeiten. Insofern Sie keine Zuweisung vornehmen, sind immer alle Felder sichtbar. Zudem ist es möglich über die Auswahl ,,Signaturfeld erstellen" ein Signaturfeld in das Dokument einzubringen. ![03c08126-cc9d-4eab-be19-6b6155e05b12.png](https://docs.signotec.com/__attachments/a_18be03daa28438837583f087771facbe83767b2e96ece865c512dd0a1e78aab8/03c08126-cc9d-4eab-be19-6b6155e05b12.png?cb=43ea9b350354e5587c3cbc0a5e8575a2) ### Geteilte Zugriffe in der Dokumentenliste Sobald ein Dokument geteilt wurde, wird neben dem Dateinamen in der Dokumentenliste ein "Papierflieger"-Symbol angezeigt. Mit einem Klick auf dieses Symbol können Sie die geteilten Zugriffe zu dem Dokument sehen. ![image-20250116-105623.png](https://docs.signotec.com/__attachments/a_565a39fb7e0cc23f4a69399a724b9f448ed76f6fe49ae97f375b55e826db981d/image-20250116-105623.png?cb=e5d046a583c5c3feca7dd5bd0a5b4f10) *Screenshot: Geteilte Vorgänge in Dokumentenliste* Weitere Informationen zu den Sharing Cases finden Sie in der [Detailansicht](https://docs.signotec.com/de/signosign-universal/latest/verwaltung-von-dokumenten.md#Eigenschaften-eines-Dokuments) des geteilten Zugriffs, des Dokuments oder im Bereich „Geteilte Dokumente". ## Einverständniserklärung konfigurieren Die Einverständniserklärungen für die geteilten Zugriffe lassen sich unter [Dokumententypen](https://docs.signotec.com/de/signosign-universal/latest/dokumententypen.md) für jeden geteilten Vorgang individuell anpassen. ## **Signiervorgang sofort starten** Es kann unter [Dokumententypen](https://docs.signotec.com/de/signosign-universal/latest/dokumententypen.md) festgelegt werden ob und wie der Signiervorgang sofort gestartet werden soll. ## Automatisches speichern In [Dokumentenypen](https://docs.signotec.com/de/signosign-universal/latest/dokumententypen.md) kann bestimmt werden wie und an welchem Punkt des Signierprozesses automatisch gespeichert werden soll. --- version: "v3.28.0" language: "de" --- # Dokumententypen Über das Benutzersymbol in der Kopfzeile können über den Button „Einstellungen" die Einstellungen geöffnet werden. Über das Menü auf der linken Seite ist ein Wechsel in die Einstellungen der Dokumententypen möglich. ## Definition Dokumenttypen sind Konfigurationen, die es ermöglichen, Einstellungen für bestimmte Dokumente zu hinterlegen. Dazu gehören insbesondere die automatische Platzierung von Signaturfeldern sowie die zugehörigen erlaubten Signaturmethoden. Es können beliebig viele Dokumententypen konfiguriert werden. Einmal hinterlegte Einstellungen gelten für alle Dokumente eines Typs und müssen nicht bei jedem Vorgang explizit angegeben werden. Dies erleichtert die Automatisierung von Prozessen und reduziert redundante Arbeitsschritte. ## Konfiguration eines Dokumententyps Über die Liste der Dokumententypen können Dokumententypen hinzugefügt, gelöscht und sortiert werden. ### Neuen Dokumententyp erstellen Um einen neuen Dokumententyp zu erstellen, kann das "+"-Symbol oberhalb der Liste verwendet werden. Der Button erzeugt automatisch einen neuen Dokumententyp und wählt diesen aus. Dieser kann anschließend konfiguriert werden. Ein neu hinzugefügter oder nicht gespeicherter Dokumententyp muss über die Schaltfläche "Speichern" gespeichert werden. Solange eine ungespeicherte Einstellung vorhanden ist, kann nicht zwischen den Dokumententypen gewechselt werden. Der aktuell aktive und ungespeicherte Dokumententyp ist in der Liste hervorgehoben. ### Dokumententyp konfigurieren Nach dem Hinzufügen oder Auswählen eines Dokumententyps, können dessen Einstellungen verändert werden. Alle Einstellungen werden im Folgenden beschrieben. #### Allgemein Die allgemeinen Einstellungen legen den Namen und die Identifizierung des Dokumententyps fest. | **Einstellung** | **Beschreibung** | |-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Titel | Legt den Namen des Dokumententyps fest. Der Name ist rein für administrative Zwecke und wird z. B. in der Liste der Dokumententypen angezeigt. | | Dateiname | Legt fest, welchen Dateinamen das Dokument aufweisen muss, damit dieser Dokumententyp angewendet wird. Es können eindeutige Dateinamen oder auch Platzhalter verwendet werden. Wenn ein eindeutiger Dateiname, z.B. "Vertrag.pdf" verwendet wird, werden diese Einstellungen nur angewendet, wenn der Dateiname identisch ist. Bei Verwendung von Platzhaltern kann der Dateiname auch abweichen und variable Werte enthalten. ++Beispiele:++ * Der Dateiname "Vertrag.pdf" gilt nur für Dokumente die exakt "Vertrag.pdf" heißen. * Der Dateiname "Vertrag**\***" gilt für alle Dokumente, deren Dateiname mit "Vertrag" beginnt. * Der Dateiname "**\***Vertrag" gilt für alle Dokumente, deren Dateiname mit "Vertrag" endet. * Der Dateiname "**\*** Vertrag**\***" gilt für alle Dokumente, deren Dateiname "Vertrag" enthält. * Der Dateiname "**\***" gilt für alle Dateinamen und somit für alle Dokumente. Groß- und Kleinschreibung wird beachtet! | #### Signaturfelder mit relativer Position Signaturfelder mit einer relativen Position werden in Abhängigkeit von einem Suchbegriff im Dokument platziert. | **Einstellung** | **Beschreibung** | |---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | "+"-Button | Erstellt einen neuen Eintrag für ein Signaturfeld. | | Signaturfeldname | Legt den Namen des Signaturfelds im Dokument fest. Der Name wird z.B. beim Zuweisen von Formularfeldern oder beim Unterzeichnen angezeigt. Der Name entspricht dem technischen Formularfeldnamen im Dokument und muss eindeutig sein. Sofern das Dokument bereits ein gleichnamiges Feld erstellt, wird kein neues Feld erzeugt. | | Suchbegriff | Legt den Suchbegriff fest, der für die Positionierung des Signaturfelds verwendet wird. Der Suchbegriff kann beliebiger Text im Dokument sein, z. B. "Unterschrift Kunde". Der Begriff dient als Nullpunkt für die Positionierung und Größe des Signaturfelds. Über die Größe und den Versatz kann die Position final bestimmt werden. Durch die technische Extraktion des Texts erkennt die Software auch Text, der "weiß auf weiß" verwendet wird. Suchbegriffe können somit auch "unsichtbar" in Formulare eingebracht werden. Suchbegriffe sollten eindeutig sein. Allgemeine Wörter wie "Unterschrift" können häufig auch in Fließtexten vorkommen und dazu führen, dass die Positionierung nicht wie gewünscht funktioniert. | | Feldgröße | Legt die Signaturfeldgröße (Höhe und Breite) des Signaturfelds fest. Die Feldgröße wird in Pixeln angegeben. Eine gute Standardgröße beträgt z. B. 150 x 50 Pixel. | | Versatz | Legt den horizontalen und vertikalen Versatz zum Suchbegriff fest. Durch den Versatz wird der Nullpunkt des Signaturfelds verschoben. Werte über 0 verschieben den Nullpunkt nach rechts bzw. unten. Werte unter 0 nach links bzw. oben. Beispiel: Wird nach dem Begriff "Unterschrift Kunde" gesucht und ein Signaturfeld mit 50 Pixeln Höhe festgelegt, kann der vertikale Versatz auf -50 festgelegt werden, um das Feld um 50 Pixel nach oben zu schieben. | | Pflichtfeld | Legt fest, ob es sich bei dem Signaturfeld um ein Pflichtfeld handelt. Diese Signaturfelder werden als Pflichtfelder in das Dokument eingefügt und erhalten in der Dokumentanzeige einen roten Rahmen. Beim Teilen von Dokumenten müssen die zugewiesenen Pflichtfelder vom Empfänger vor der Fertigstellung des Dokuments signiert werden. | | Erlaubte Signiermethoden ("Zahnrad"-Symbol) | Über das Zahnradsymbol können die erlaubten Signiermethoden für die Signatur dieses Signaturfelds festgelegt werden. | | Feld löschen ("Mülleimer"-Symbol) | Über das Mülleimer-Symbol kann das konfigurierte Signaturfeld gelöscht werden. | #### Signaturfelder mit absoluter Position Signaturfelder mit einer absoluten Position werden unabhängig vom Dokumentinhalt an einer bestimmten Position auf einer Seite des Dokuments platziert. | **Einstellung** | **Beschreibung** | |---------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Signaturfeldname | Legt den Namen des Signaturfelds im Dokument fest. Der Name wird z.B. beim Zuweisen von Formularfeldern oder beim Unterzeichnen angezeigt. Der Name entspricht dem technischen Formularfeldnamen im Dokument und muss eindeutig sein. Sofern das Dokument bereits ein gleichnamiges Feld erstellt, wird kein neues Feld erzeugt. | | Seite | Legt fest, auf welcher Seite das Signaturfeld eingebracht werden soll. | | Feldgröße | Legt die Signaturfeldgröße (Höhe und Breite) des Signaturfelds fest. Die Feldgröße wird in Pixeln angegeben. Eine gute Standardgröße beträgt z. B. 150 x 50 Pixel. | | Position | Legt die Position (den Nullpunkt) des Signaturfeldes auf der angegebenen Seite fest. Der erste Wert bestimmt die horizontale Position, der zweite Wert die vertikale Position. Der Nullpunkt befindet sich oben links auf der Seite, daher sind negative Werte nicht zulässig. Die angegebene Position und Größe müssen sich im sichtbaren Bereich des Dokuments befinden. Eine A4-Seite hat im Standard 72 DPI und somit im Hochformat ein Koordinatensystem von 0/0 (oben links) bis 595/840 (unten rechts). | | Pflichtfeld | Legt fest, ob es sich bei dem Signaturfeld um ein Pflichtfeld handelt. Diese Signaturfelder werden als Pflichtfelder in das Dokument eingefügt und erhalten in der Dokumentanzeige einen roten Rahmen. Beim Teilen von Dokumenten müssen die zugewiesenen Pflichtfelder vom Empfänger vor der Fertigstellung des Dokuments signiert werden. | | Erlaubte Signiermethoden ("Zahnrad"-Symbol) | Über das Zahnradsymbol können die erlaubten Signiermethoden für die Signatur dieses Signaturfelds festgelegt werden. | | Feld löschen ("Mülleimer"-Symbol) | Über das Mülleimer-Symbol kann das konfigurierte Signaturfeld gelöscht werden. | #### Einstellungen für das Teilen von Zugriffen Die Einstellungen für das Teilen von Zugriffen legt Rahmenbedingungen für die Funktion "Zugriff teilen" fest. | **Einstellung** | **Beschreibung** | |----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Weiterleitung nach Abschluss (Redirect-URL) | Legt fest, ob der Unterzeichner eines geteilten Dokuments nach Abschluss des Dokuments auf eine bestimmte Seite weitergeleitet werden soll, z.B. auf die eigene Webseite oder eine "Danke"-Seite. | | Erlaubt dem Empfänger den Vorgang zu speichern und zu einem späteren Zeitpunkt abzuschließen | Legt fest, ob der Unterzeichner das Dokument für eine spätere Bearbeitung zwischenspeichern darf. ++Aktiviert:++ Der Empfänger kann das Dokument zwischenspeichern. ++Deaktiviert:++ Der Empfänger kann das Dokument nicht zwischenspeichern. *Standard: Deaktiviert* | | Erlaubt dem Empfänger den Vorgang abzulehnen | Legt fest, ob der Unterzeichner die Signatur des Dokuments ablehnen darf. ++Aktiviert:++ Der Empfänger kann die Bearbeitung des Dokuments ablehnen. Wenn die Option „Konfiguration der Einverständniserklärung" aktiviert ist, wird beim Ablehnen der Erklärung der Dialog zum Ablehnen des Dokuments geöffnet. Andernfalls schließt sich der Dialog und das Dokument verbleibt im Lesemodus. ++Deaktiviert:++ Der Empfänger kann die Bearbeitung des Dokuments nicht ablehnen. *Standard: Deaktiviert* | | Konfiguration der Einverständniserklärung | Legt fest, ob der Empfänger beim Öffnen des geteilten Dokuments einer Einverständniserklärung zustimmen muss. ++Aktiviert:++ Der Empfänger muss einer Einverständniserklärung zustimmen, bevor das Dokument bearbeitet und signiert werden kann. Titel und Text der Einverständniserklärung können individuell festgelegt werden. Sofern der Empfänger der Erklärung nicht zustimmt, verbleibt das Dokument im Lesemodus. Wenn die Option „Erlaubt dem Empfänger den Vorgang abzulehnen" aktiviert ist, wird beim Ablehnen der Erklärung der Dialog zum Ablehnen des Dokuments geöffnet. Andernfalls schließt sich der Dialog und das Dokument verbleibt im Lesemodus. ++Deaktiviert:++ Der Empfänger muss keiner Einverständniserklärung zustimmen, um das Dokument zu bearbeiten. *Standard: Deaktiviert* | | Konfiguration der E-Mail-Texte | Legt fest, ob eigene E-Mail-Texte verwendet werden sollen. ++Aktiviert:++ Es werden individuelle Texte für automatische E-Mails verwendet. Konfiguriert werden kann der Betreff, die Nachricht sowie die Signatur. Die konfigurierten E-Mail-Texte werden ausschließlich bei automatischen E-Mails verwendet, die beim Teilen einzelner Dokumente versendet werden. Die Konfiguration des E-Mail-Texts in Workflows erfolgt direkt in den Workflow-Einstellungen. ++Deaktiviert:++ Es werden die Standardtexte der Anwendung verwendet. *Standard: Deaktiviert* | | Signiervorgang sofort starten | Legt fest, ob beim Öffnen des geteilten Dokuments umgehend ohne weitere Interaktion die Signaturerfassung gestartet werden soll. ++Deaktiviert:++ Der Signaturvorgang wird nicht automatisch gestartet. ++Mit erster Signatur starten:++ Der Signaturvorgang wird mit dem ersten Signaturfeld im Dokument gestartet. Anschließend werden die weiteren Signaturfelder nacheinander abgearbeitet. ++Mit erster Pflichtsignatur starten:++ Der Signaturvorgang wird mit dem ersten obligatorischen Signaturfeld im Dokument gestartet. Anschließend werden die weiteren Signaturfelder nacheinander abgearbeitet. ++Mit benanntem Signaturfeld starten:++ Der Signaturvorgang wird mit einem bestimmten Signaturfeld gestartet. Der Name des Signaturfelds muss angegeben werden. Anschließend werden die weiteren Signaturfelder nacheinander abgearbeitet. Wird ein Signaturfeld angegeben, das nicht im Dokument vorhanden ist, beginnt der Signaturvorgang mit der ersten Signatur im Dokument. *Standard: Deaktiviert* | | Automatisches Speichern | Legt fest, ob das geteilte Dokument bei bestimmten Änderungen automatisch gespeichert werden soll. * ++Deaktiviert:++ Das Dokument wird nicht automatisch gespeichert. Der Empfänger muss das Bestätigen und Speichern daher explizit ausführen. * ++Beim Start des Signiervorgangs:++ Das Dokument wird beim Start eines Signaturvorgangs automatisch gespeichert. * ++Beim Bestätigen einer Signatur:++ Das Dokument wird automatisch gespeichert, sobald eine Signatur bestätigt wird. * ++Beim Abschluss aller Signaturen:++ Das Dokument wird automatisch gespeichert, sobald alle Signaturen erfasst wurden. * ++Beim Schließen des Dokuments:++ Das Dokument wird beim Schließen automatisch gespeichert. *Standard: Deaktiviert* | ### Dokumententypen sortieren Beim Öffnen eines Dokuments versucht die Anwendung, die passenden Einstellungen zu finden. Dabei wird die Liste der verfügbaren Dokumententypen von oben nach unten durchsucht. Die Anwendung wendet dann die ersten Einstellungen an, die auf das geöffnete Dokument zutreffen. Um eine Priorisierung der Einstellungen vorzunehmen, kann die Liste der konfigurierten Dokumententypen sortiert werden. Um einen Dokumententyp in der Liste zu verschieben, muss dieser in der ausgewählt und über die Pfeil-Symbole oberhalb der Liste nach oben oder unten verschoben werden. Eine Sortierung der Dokumententypen ist in der Regel nur dann sinnvoll, wenn nicht alle Dokumententypen eindeutig konfiguriert werden können. In diesem Fall sollten die eindeutigsten Einstellungen am Anfang und die allgemeinsten Einstellungen am Ende der Liste stehen. Es wird jeweils nur ein Dokumententyp verwendet. Es gibt keine Kombination mehrerer Dokumententypen. ### Dokumententyp löschen Um einen Dokumententyp zu löschen, muss dieser in der Liste der konfigurierten Dokumententypen ausgewählt und über das Löschen-Symbol oberhalb der Liste entfernt werden. Es erscheint eine Abfrage, ob der ausgewählte Dokumententyp wirklich gelöscht werden soll, die mit "Ja" bestätigt werden muss. Gelöschte Dokumententypen können nicht wiederhergestellt werden. --- version: "v3.28.0" language: "de" --- # Einstellungen: auth Die folgenden Einstellungen konfigurieren die Authentifizierung von Benutzern. Standardmäßig wird der Authentifizierungsmechanismus des Servlet Containers bzw. Application Servers verwendet. Alternativ kann *Single Sign On (SSO)* mit [OpenID Connect (OIDC)](https://openid.net/connect/) verwendet werden. * Die mobilen Apps für Android und iOS sind nicht kompatibel mit Single Sign On. Verwenden Sie die Einstellung `auth.type = REALM`, um signoSign/Universal über die Apps zu nutzen. * Für die Nutzung von Single-Sign-On ist die Einstellung des Schlüssels `web.ssmPublicUrl` zwingend erforderlich. ## auth.type |--------------------|---------|-----------------------------------------------------------------------------------------------------------------------------| | **Beschreibung** | Legt den Typ der Authentifizierung fest. Für die Verwendung von [OpenID Connect](https://openid.net/connect/) müssen die Schlüssel `auth.oidc.discoveryUrl`, `auth.oidc.clientId` und `auth.oidc.clientSecret` festgelegt werden. || | **Mögliche Werte** | `REALM` | Der Authentifizierungsmechanismus des *Servlet Containers* bzw. *Application Servers* wird verwendet. | | **Mögliche Werte** | `OIDC` | Die Benutzer werden von einem *Authorization Server* mittels [OpenID Connect](https://openid.net/connect/) authentifiziert. | | **Standardwert** | `REALM` || ## auth.realm.forceLowerCaseUsername |--------------------|---------|---------------------------------------------------------------------------------------------------------------------------------| | **Beschreibung** | Wenn diese Einstellung aktiviert ist, wird die Groß-/Kleinschreibung des Benutzernamens ignoriert. Benutzer *"Max Mustermann"* und *"max mustermann"* teilen sich die gleichen Daten im System, wie bspw. Dokumente. Beide Benutzer können sich aber anmelden, solange der Login-Mechanismus dies zulässt, aber signoSign/Universal verwendet intern den kleingeschriebenen Benutzernamen. || | **Mögliche Werte** | `true` | Die Groß-/Kleinschreibung wird ignoriert. *"Max Mustermann"* und *"max mustermann"* sind derselbe Benutzeraccount. | | **Mögliche Werte** | `false` | Die Groß-/Kleinschreibung wird berücksichtig. *"Max Mustermann"* und *"max mustermann"* sind unterschiedliche Benutzeraccounts. | | **Standardwert** | `false` || ## auth.oidc.discoveryUrl |--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Beschreibung** | Die URL der [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata) des Identity Servers. Die URL endet i. d. R. mit */.well-known/openid-configuration*. Dieser Wert muss für die Verwendung von [OpenID Connect](https://openid.net/connect/) festgelegt werden. | | **Mögliche Werte** | Eine URL. | | **Standardwert** | - | ## auth.oidc.clientId |--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Beschreibung** | Der Identifier mit dem signoSign/Universal beim *Identity Server* registriert ist. Eine Anwendung, die [OpenID Connect](https://openid.net/connect/) verwendet, muss beim *Identity Server* registriert sein, wobei dieser Identifier vergeben wird, der für den [Authorization Code Flow](https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth) benötigt wird. Dieser Wert muss für die Verwendung von [OpenID Connect](https://openid.net/connect/) festgelegt werden. | | **Mögliche Werte** | Eine beliebige Zeichenkette. | | **Standardwert** | - | ## auth.oidc.clientSecret |--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Beschreibung** | Das beim *Identity Server* festgelegte Geheimnis, welches signoSign/Universal für den [Authorization Code Flow](https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth) verwendet. Dieser Wert muss für die Verwendung von [OpenID Connect](https://openid.net/connect/) festgelegt werden. | | **Mögliche Werte** | Eine beliebige Zeichenkette. | | **Standardwert** | - | ## auth.oidc.scope |--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Beschreibung** | Die Scope Werte, die für den [Authorization Code Flow](https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth) verwendet werden. Für die grundlegende Funktionalität benötigt [OpenID Connect](https://openid.net/connect/) den Wert *openid*. | | **Mögliche Werte** | Eine beliebige Zeichenkette. | | **Standardwert** | `openid profile email` | ## auth.oidc.usernameClaim |--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Beschreibung** | Der Wert (*claim*) im Token, aus dem der Benutzername entnommen wird. Wenn der Wert nicht vorhanden oder leer ist, ist ein Login an signoSign/Universal nicht möglich. | | **Mögliche Werte** | Eine beliebige Zeichenkette. | | **Standardwert** | `email` | Der Standardwert `email` ist ein [Standard claim](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims), der durch den *scope email* in den Token eingefügt wird. Wenn der Wert `email` nicht in [auth.oidc.scope](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-auth.md#auth.oidc.scope) enthalten ist, sollte diese Einstellung überprüft werden. ## auth.oidc.tenantClaim |--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Beschreibung** | Der Claim im Token, aus dem der die Tenant-Identifikation entnommen wird. Wenn der Wert nicht vorhanden oder leer ist, ist ein Login an signoSign/Universal nicht möglich, wenn die Anwendung im Multi-Mandanten-Modus betrieben wird. | | **Mögliche Werte** | Eine aphanumerische Zeichenkette, die pro Mandant eindeutig ist. | | **Standardwert** | `tenant` | Dieser Claim ist zwingend erforderlich, wenn das System im Mandantenmodus betrieben wird. Siehe dazu auch den Abschnitt [Mandantenfähigkeit](https://docs.signotec.com/de/signosign-universal/latest/mandantenfahigkeit.md). ## auth.oidc.rolesClaim |--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Beschreibung** | Der Wert (*claim* ) im Token, aus dem die [Benutzerrollen](https://docs.signotec.com/de/signosign-universal/latest/rest-api.md#Benutzerrollen-und-die-ownerId) entnommen werden. Wenn der Wert im Token nicht vorhanden, leer oder kein JSON Array ist, ist ein Login an signoSign/Universal nicht möglich. | | **Mögliche Werte** | Eine beliebige Zeichenkette. | | **Standardwert** | `roles` | Der Standardwert `roles` ist *kein* [Standard claim](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims), weil [OpenID Connect](https://openid.net/connect/) keinen Standard für Benutzerrollen definiert. Der Wert muss durch proprietäre Einstellung des *Identity Servers* und durch Verwendung von benutzerdefinierten [Scopes](https://docs.signotec.com/de/signosign-universal/latest/einstellungen-auth.md#auth.oidc.scope) in den Token eingefügt werden. ## auth.oidc.tokenAudience |--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Beschreibung** | Aus Sicht des *Identity Servers* ist signoSign/Universal eine Ressource. Ein OAuth *Access-Token* wird immer für eine Ressource ausgestellt. Mit dieser Einstellung kann eine Liste von gültigen Ressourcen festgelegt werden. Die signoSign/Universal REST-API wird nur die *Access-Token* akzeptieren, dessen *aud claim* Wert in dieser Liste enthalten ist. Die Prüfung ist deaktiviert wenn kein Wert festgelegt ist. | | **Mögliche Werte** | Eine kommaseparierte Liste von Identifiern. | | **Standardwert** | - | Wenn die signoSign/Universal REST-API öffentlich verfügbar ist, wird die Angabe dieser Liste aus Sicherheitsgründen dringend empfohlen. Eine öffentliche REST-API sollte immer prüfen ob ein *Access-Token* für die API ausgestellt wurde. ## auth.oidc.tokenIssuer |--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Beschreibung** | Eine Liste von zusätzlichen vertrauenswürdigen *Access-Token* Ausstellern. Der Aussteller aus den [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata) ist immer vertrauenswürdig. Die signoSign/Universal REST-API wird nur *Access-Tokens* akzeptieren, dessen *iss claim* Wert bekannt ist. | | **Mögliche Werte** | Eine kommaseparierte Liste von Identifiern. | | **Standardwert** | Der *issuer* aus [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata), wenn vorhanden. | --- version: "v3.28.0" language: "de" --- # Einstellungen: business Folgende Einstellungen sind in der settings.properties mit dem Präfix "business." möglich. ## business.licenseKey |--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Beschreibung** | Hier kann der Lizenzschlüssel für signoSign/Universal eingetragen werden. Bitte ändern Sie diesen Wert nur nach Absprache mit signotec. Mit einem ungültigen Lizenzschlüssel kann die Anwendung nicht genutzt werden. Wenn kein Schlüssel angegeben ist, läuft die Anwendung im Evaluationsmodus. | | **Mögliche Werte** | Ein von der Firma signotec bereitgestellter, gültiger Lizenzschlüssel. | | **Standardwert** | - | [Next Page](https://docs.signotec.com/llms-full.txt/1)