WARP Konfiguration

Owned by Former user (Deleted)
Last updated: Juli 18, 2024 by Dennis Balzuweit
4 min read

Konfiguration

Die Konfiguration erfolgt unter folgendem C4 Knoten über das entsprechend hinterlegte C4 Plugin:

/clarc/Software/clarc warp daemon

Im WARP-Konfigurationsdialog stehen folgende Optionen bereit:

ParameterBeschreibung

Processing  

Stack processing Bestimmt, ob die als Stapel zusammengehörigen Dokumente auch als solche Verarbeitet werden soll. Ein Stapel wird dann immer als eine Einheit betrachtet und am Stück bearbeitet.
Merge identical documents Fasst Dokumente innerhalb eines Stapels über deren KeyHash (siehe Queue-Tabelle) zu einem Dokument zusammen. Das heißt, es werden alle Anlagen der Dokumente zusammengefasst und mit einem Metadatensatz verarbeitet.
Process interval Über diesen Intervall kann geregelt werden wann die Server die zu verarbeitenden Dokumenten in der Queue suchen soll. Die Angabe ist in Sekunden. Im Standard werden alle neu eingehenden Dokumente unmittelbar verarbeitet. Der Server erhält dazu einen Verarbeitungs-Trigger.
Process retries Anzahl der Verarbeitungsversuche für ein Dokument. Kann das Dokument nach diesen Versuchen nicht verarbeitet werden, bleibt es in der Queue mit dem Status ERROR unbearbeitet stehen und muss administrativ zurückgesetzt werden.
Retry time Wiederholungsintervall in Minuten. Eine fehlgeschlagene Verarbeitung eines Dokuments wird nach dieser Zeit erneut vorgenommen. Siehe auch RETRYTIME in der Queue-Tabelle. Auf diesen Wert kann auch schreibend aus dem Scripting heraus zugegriffen werden.
Reset process state Ein hängendes Dokument wird nach dieser Anzahl an Minuten vom WARP Service automatisch zurückgesetzt. Hängende Dokumente haben den Status IMPORT oder PROCESSING. 
Def. blob name prefix Obsolet
Def. blob Name template 

Name der zu erzeugenden Dateien bei Konvertierungen. Es können die Standardplatzhalter und Feldinhalte verwendet werden. Zudem folgende zwei:

  • %firstfilename
  • %firstviewname

Siehe auch:

  • DefaultBlobNameTemplate
  • DefaultBlobViewNameTemplate

Zu finden unter

/clarc/Software/Basics/Common 

Log

Log levelDer vom Server zu verwendende Log-Level.
Create log fileLogdatei erzeugen - ja/nein.
Log field outputBei aktiver Option werden im Logfile die Metadaten jedes verarbeiteten Dokuments ausgegeben.

Security

Accept external requestsErlaubt HTTP Anfragen welche nicht vom lokalen System kommen.
Use trusted IP listEs werden nur HTTP Anfragen von Systemen akzeptiert, welche in der Liste der vertrauenswürdigen IP-Adressen aufgeführt sind.
Trusted IP listListe der vertrauenswürdigen IP-Adressen. Siehe "Use trusted IP list". Die Adressen werden mit "," getrennt aufgeführt.

Advanced

Script compatibility mode

Obsolet.

Aktiviert den Kompatibilitätsmodus für alte WARP Scripte. Es werden dadurch zur Laufzeit die Scripte auf die neuen Klassen-Methoden konvertiert.

Die Option ScriptCompatibilityMode ist mit der Version 5.1 in den WARP Basics nicht mehr verfügbar. Alte Scripte und Funktionen können daher nicht mehr verwendet werden.

Folgende Befehle sind hierbei betroffen:

  • AddExportField               
  • AddExportFile            
  • GetExportFieldCount     
  • GetExportFieldId         
  • GetExportFieldName      
  • GetExportFieldValueById 
  • SetExportFieldValueById  
  • GetExportFieldValueByName
  • SetExportFieldValueByName
  • GetExportFileName       
  • GetExportBlobName        
  • SetExportBlobName        
  • GetExportBlobCount      
  • GetExportBlobData       
  • DeleteExportBlob       
  • DeleteExportField        
  • AllowProcessing         
  • DeleteFromQueue         
  • ProcessingMessage        
  • ExportDestination       
  • ExportTitle             
  • ExportConversionScheme  
  • ScriptBuffer             
  • ExportScriptScheme      
  • ExportJobId            
  • ExportRetries
Document upload enabledErlaubt den Upload von Dokumenten. Siehe WARP API.
Distributor modeIm Distributor Modus werden in der Primär-Instanz selbst keine Dokumente mehr verarbeitet. Die Instanz ist dann ausschließlich für die Jobverwaltung zuständig.
Blob pathAlternativer Blob-Pfad. Im Standard werden alle Dokumente unter <clarc>\data\blobs verwaltet (siehe Verzeichnisstruktur). Leer lassen um den Standard zu verwenden.
Internal queue sizeBestimmt die interne Queue größe. Diese Anzahl an Dokumenten wird von der Primärinstanz auf einmal in den internen Verarbeitungsstapel geladen. Der Standardwert ist 1000. Wählen Sie einen kleineren Wert um hoch priorisiert Dokumente schneller der Verarbeitung zuzuführen.
Max. instance errorsGibt an wie oft eine Instanz nicht auf Anfragen bzw. Trigger des Master-Servers reagieren darf bis sie deaktiviert wird. Registriert sich die Instanz erneut am Master, wird sie wieder in den Verarbeitungszyklus mit aufgenommen.
Work thread priorityInterne Thread-Priorität des Verarbeitungsprozessses.

Hot folders

Definition von einfach Hot-Foldern mit Name und Pfad inkl. Dateinmanesmaske. Erweiterte Hot-Folder Definitionen finden Sie hier: WARP Hot-Folder.

Operating time

An dieser Stelle können Verarbeitungszeiträume definiert werden. Nur in den definierten Zeiten werden dann Dokumente verarbeitet.

Manage operating timeAktiviert die Regelung der Verarbeitungszeiträume.

Weitere Einstellungen

/clarc/Software/clarc warp daemon/Basics
ParameterDatentypBeschreibung
AllowNoBlobConversionBOOLEAN

Befindet sich in den WARP Basics und ist im Standard auf False. Bestimmt,  ob der Konvertierungsvorgang ohne ein Blob bearbeitet werden soll.

BackupPathUC4STR

Gibt den Pfad für das Warp Backup an. Im Pfad können die Standardplatzhalter verwendet werden und zudem der Platzhalter "%docid".

Im Standard werden die Dokumente und Blobs unter <clarc>\backup\ abgelegt. Die Ablage der Blobs und der Dokumente erfolgt einzeln und im XML Format.

BlobDestinationUCS2STRAblageziel für die Blobs.

Mögliche Werte sind:
  • Filesystem
  • Database.

Der Standard ist Filesystem (empfohlen).
CreateBackupBOOLEAN

Ist die Option auf True, wird automatisch ein WARP Backup von den verarbeiteten Dokumenten erstellt.

DefaultBlobNameUCS2STR

Ist der Standardblobname, der übernommen wird sofern nichts explizites gesetzt oder gefunden wird. Standardmäßig wird versucht diesen aus dem entsprechenden Dateinamen zu ermitteln.

ExportRetriesINTFehlgeschlagene Exporte werden max. "ExportRetries" mal versucht zu verarbeiten. Danach verbleiben diese bis zum Zurücksetzen oder Löschen in der Queue.
HotFolderIntervalBYTE

Diese Angabe steuert die periodische Überprüfung der überwachten Ordner- Hot folder. Die Angabe erfolgt in Sekunden. Der Default ist 60 Sekunden.

IndexLogBOOLEANMit dieser Option werden bei jedem Export die Indexinformationen des jeweiligen Dokuments mit in das Logging ausgegeben. Die Option ist zudem abhängig vom eingestellten Loglevel.
LogToFileBOOLEANLogToFile steuert, ob die Logausgabe zusätzlich im Dateisystem erfolgen soll.
Der Standardordner für Logausgaben ist ...\log\. Die Logfiles werden hier entsprechend Ihres Programms benannt. Je Anwendung, Instanz und Tag wird ein Logfile erstellt.
MaxParallelTasksINTGibt die maximale Anzahl der parallel laufenden Tasks an bei der Verarbeitung von Dokumenten über den Webservice. Alle weiteren Tasks werden in einer Warteschlange gehalten und dann nach und nach verarbeitet.
QueueStackSizeINTQueueStackSize definiert die Größe der internen Verarbeitungsqueue. Dies ist vor allem in Cluster-Umgebungen wichtig um eine schnelle Verarbeitung zu gewährleisten. Der maximale Wert liegt bei 10.000. Im Standard wird die Größe mit 1.000 angegeben. Für die optimale Verarbeitung von hoch priorisierten Elementen, bei nur einer Instanz, wird ein Wert von 10 empfohlen.
ResetExportStateTimeINTDatensätze deren Änderungsdatum älter sind als ResetExportStateTime (Angabe in Minuten) und den Status Processing oder Unknown haben, werden zurückgesetzt. Der Standardwert ist 1440 - was einem Tag entspricht.
MaxProcessingTimeINTDatensätze welche länger als MaxProcessingTime Sekunden in der internen Queue im Status Processing liegen werden zurückgesetzt. Im Standard liegt der Wert bei 43200, was 12 Stunden entspricht.
ScriptPreCompilingBOOLEAN

Die Property ScriptPreCompiling befindet sich in den WARP Basics und ist im Standard aktiv. Die Option ist an- und ausschaltbar und per Default nicht im System angelegt. Mit dem ScriptPreCompiling können die Skripte kompiliert ausgeführt werden was zu einer deutlichen Performancesteigerung führt.

UploadEnabledBOOLEANIst diese Option aktiv können Dokumente im CLARC XML Document Format via Http Put auf den Server bzw. direkt in die Verarbeitungsqueue übergeben werden.
AllowNoBlobsConversionBOOLEANIst die Option aktiv, werden die Conversion-Engines auch ohne das Vorhandensein eines Blobs ausgeführt. Dies kann zum Beispiel für die Erzeugung von X-Rechnungen sein. Im Standard ist die Option ausgeschaltet. 

Aktivierung

Die vorgenommenen Änderungen werden über den C4 Button "Refresh Services" übernommen und stehen dann zur Verwendung bereit.