Skip to content

Nutzung

Hotfolder-Service

Der Hotfolder-Service lässt sich durch Starten der qstamper-service.exe aktivieren. Nach dem Start der qstamper-service.exe werden eingehende PDF-Dokumente im definierten Hotfolder vollautomatisch bearbeitet. Der standardmäßige Hotfolder befindet sich als Unterverzeichnis im QStamper-Hauptverzeichnis und lautet 'hotfolder'. Die gestempelten Dokumente werden standardmäßig im Unterverzeichnis 'results' abgelegt. Alle verwendeten Ordner können in Ihrer Konfigurationsdatei in der Sektion 'service' individuell angepasst werden.

JobRouter-Integration

Für die Integration in JobRouter-Prozesse empfehlen wir die Verwendung des Hotfolder-Services. Übergeben Sie zum Beispiel die Dokumente von JobRouter an QStamper über die Kopierfunktion in einer Ausführungsregel oder als Ausgabepfad in JobPDF. Möchten Sie das gestempelte Dokument wieder in den JobRouter-Prozess zurückführen, kann der QStamper-Ausgabeordner (Standard: "results") mit JobStart abgehört und mit einem konfiguriertem Prozessschritt fortgeführt werden. Des Weiteren empfehlen wir den QStamper-Hotfolder-Service als Windows-Service einzurichten, so dass dieser nach einem Neustart des Geräts nicht manuell gestartet werden muss.

Weitere Beispiele folgen in Kürze.

Aufruf on demand ohne Hotfolder-Service

Falls Sie den QStamper-Hotfolder-Service nicht verwenden wollen oder können, kann QStamper alternativ auch für jede Datei separat on demand aufgerufen werden. Hierfür kann die qstamper.exe mit folgenden Parametern aufgerufen werden:

  • Der Pfad und Dateiname der Eingabedatei, welche gestempelt werden soll.
  • erforderlich
  • Der gewünschte Pfad und Dateiname der resultierenden, gestempelten Datei.
  • erforderlich
  • Die Konfigurationsdatei für den Stempelprozess.
  • optional, Standard: config/config.yml im QStamper-Verzeichnis
  • Der Inhalt des Stempels (nur für QR-Codes und Barcodes) bei Verwendung des Content-Providers "cmd" für die Konfigurationsvariable stamper.content.provider in der verwendeten YAML-Konfigurationsdatei.
  • optional

Beispiel:

.\qstamper.exe -i C:\input.pdf -o C:\output.pdf -conf C:\QStamper\config\my_custom_config.yml -c RE123123

Verwendung verschiedener Konfigurationen

Sie können beliebig viele weitere YAML-Konfigurationsdateien anlegen, um z.B. verschiedene Stempelprozesse abzubilden. Eigene YAML-Konfigurationsdateien können mit dem Parameter -conf beim Start des QStamper-Hotfolder-Services verwendet werden.

Beispiel: 

.\qstamper-service.exe -conf C:\QStamper\config\my_custom_config.yml

Automatischer Start als Windows-Service/Dienst

Installation & Deinstallation

Im QStamper-Hauptverzeichnis befindet sich das Unterverzeichnis utils, in dem ein Installations- und ein Deinstallationsskript für den Betrieb als Windows-Service bereitgestellt werden.

Über das Skript install-windows-service.bat wird ein Windows-Dienst namens "QStamper Service" installiert und direkt gestartet. Das Skript uninstall-windows-service.bat stoppt und deinstalliert den Dienst. Beide Skripte müssen mit Administratorrechten ausgeführt werden.

Manuelle Verwendung

Falls das Installations- oder Deinstallationsskript bei Ihnen nicht funktionieren sollte, da Sie z.B. remote auf das Gerät zugreifen und die Ausführungsumgebung daher nicht zu den verwendeten Pfaden der Skripte passt, können Sie den Dienst auch manuell installieren und starten bzw. beenden und deinstallieren. Hierzu muss Ihre verwendete Eingabeaufforderung (z.B. CMD, PowerShell oder Terminal) mit Administratorrechten gestartet und ins Unterverzeichnis utils gewechselt werden.

Manuelle Installation: 

.\qstamper-windows-service.exe install

Manueller Start: 

net start QStamperService

Manueller Stop: 

net stop QStamperService

Manuelle Deinstallation: 

.\qstamper-windows-service.exe uninstall

Informationen

Service-Ereignisse schreibt der Qstamper-Windows-Dienst in eine separate Logdatei namens var\log\windows_service_log.txt. Die Dokumentenverarbeitung wird dabei weiterhin in der Logdatei var\log\core_log.txt protokolliert.

Der QStamper-Windows-Service kann in der Dienste-Anwendung von Windows manuell gestartet, gestoppt und konfiguriert werden. Die Dienste-Anwendung finden Sie über das Startmenü von Windows, wenn Sie "Dienste" in das Suchfeld eingeben. Alternativ kann die Dienste-Anwendung auch über das Dialogfeld "Ausführen" (Tastenkombination: Windows+R) und dem Befehl services.msc gestartet werden.

Einschränkungen: Aktuell können dem QStamper-Windows-Service keine Parameter mitgegeben werden, wodurch die integrierte QStamper-Service-Instanz immer die standardmäßige config\config.yml verwendet. Des Weiteren kann momentan nur ein einzelner QStamper-Windows-Service installiert werden. Mehrere QStamper-Instanzen können aktuell nicht parallel als Windows-Dienste betrieben werden.