Help > ReadSoft Capture Framework anpassen > Geschäftslogik konfigurieren > Geschäftsregeln

Geschäftsregelvorlagen

ReadSoft Capture Framework liefert Standard Geschäftsregelvorlagen in einem Assembly namens xboundOcfValidationBase.dll. Die DLL-Datei befindet sich im XBOUND Programmverzeichnis. Beim ersten Zugriff auf die Geschäftslogik muss diese Geschäftsregelbibliothek angelegt werden (siehe Anleitung).

ClosedBarcodeToField

Übernimmt einen oder alle Barcodes in das Feld.

Parameter

Beschreibung

field

Feld.

copyFirstBarcodeOnly

  • 0: Es werden alle Barcodes übernommen.

  • 1: Es wird nur der erste Barcode übernommen.

separator

Trennzeichen.

ClosedCaptureComponents_CheckClassificationConfidence

Diese Geschäftsregel prüft folgendes:

  • Ob die Klassifikationskonfidenz einen bestimmten Threshold erreicht. Wenn nicht, wird das Feld gelöscht und in der Verification vorgestellt.

  • Ob die Klassifikationskonfidenz eine minimale Konfidenz erreicht. Wenn nicht, wird das Feld in der Verification vorgestellt.

  • Ob der Konfidenzgrad der Klassifikation und Separierung sicher war.

Parameter

Beschreibung

Context

Validierungskontext-Objekt (wird vom System bereitgestellt).

pField

Feld.

pMinConfidence

Minimale Konfidenz, die überschritten werden muss, damit das Dokument auf gültig gesetzt wird.

pConfidenceThreshold

Konfidenzschwellwert, der überschritten werden muss, ansonsten wird der erkannte Wert verworfen.

pConfidenceStatus

Wenn 1, dann wird die Konfidenzschwelle der Klassifikation und Separierung berücksichtigt.

pMinConfidenceDistance

Konfidenzabstand bei Mehrfacherkennung (Alternativen). Noch nicht implementiert.

ClosedCaptureComponents_CheckExtractionConfidence

Diese Geschäftsregel prüft folgendes:

  • Ob die Extraktionskonfidenz einen bestimmten Threshold erreicht. Wenn nicht, wird das Feld gelöscht und in der Verification vorgestellt.

  • Ob die Extraktionskonfidenz eine minimale Konfidenz erreicht. Wenn nicht, wird das Feld in der Verification vorgestellt.

  • Ob die zweite Extraktionsalternative einen ausreichenden Abstand zur besten Alternative aufweist.

Parameter

Beschreibung

Context

Validierungskontext-Objekt (wird vom System bereitgestellt).

pField

Feld.

pMinConfidence

Minimale Konfidenz, die überschritten werden muss, damit das Dokument auf gültig gesetzt wird.

pConfidenceThreshold

Konfidenzschwellwert, der überschritten werden muss, ansonsten wird der erkannte Wert verworfen.

pMinConfidenceDistance

Konfidenzabstand bei Mehrfacherkennung (Alternativen). Noch nicht implementiert.

ClosedChangeParentDocument

Diese Geschäftsregel verschiebt das aktuelle Dokument unter das letzte vorgehende Dokument vom angegebenen Dokumenttyp.

Parameter

Beschreibung

pContext

Validierungskontext-Objekt (wird vom System bereitgestellt).

pParentDocTypeName

Dokumenttyp des Zieldokuments.

ClosedCheckConfidenceRank

Diese Geschäftsregel prüft, ob das Leseergebnis des Feldes sicher ist. Wenn nicht, schlägt die Validierung fehl.

Parameter

Beschreibung

pContext

Validierungskontext-Objekt (wird vom System bereitgestellt).

pField

Feld.

ClosedCheckForInvalidCharacters

Diese Geschäftsregel prüft, ob im übergebenen Wert ungültige Zeichen enthalten sind. Die ungültigen Zeichen können als InvalidCharacters übergeben werden.

Parameter

Beschreibung

pValue

Wert.

pInvalidCharacters

Ein oder mehr ungültige Zeichen (ohne Trennzeichen).

ClosedCheckLength

Diese Geschäftsregel prüft, ob die Länge des Wertes zwischen der konfigurierten Mindest- und Maximallänge liegt.

Parameter

Beschreibung

pValue

Wert.

pMinLength

Minimale Länge. Wird die minimale Länge auf -1 gesetzt, so wird sie nicht geprüft.

pMaxLength

Maximale Länge. Wird die maximale Länge auf -1 gesetzt, so wird sie nicht geprüft.

Beispiel:

Eine CheckLength-Prüfung hat drei Parameter: pValue, pMinLength, pMaxLength. Den Parameter pValue setzt man typischerweise auf ein Feld, sagen wir auf Postleitzahl. Dieses Feld wird auch validiert, also wird Validieren gecheckt. Wenn sich in dem Feld Postleitzahl etwas ändert, soll neu validiert werden. Also wird auch Auslöser gecheckt.

Der Parameter pMinLength ist eine Konstante und wird fest mit 3 belegt. Auslösen und Validieren sind hier nicht von Belang.

Der Parameter pMaxLength wird auch aus einem Feld Postleitzahl Länge ausgelesen. Dieses Feld dient aber nur der (dynamischen) Datenübergabe; der Wert für pMaxLength ist nicht fest vorgegeben sondern kommt live aus dem Feld. Dieses Feld wird aber nicht validiert. Darum bleibt wird Validieren hier nicht gecheckt. Wenn sich das Feld Postleitzahl Länge jedoch ändert, soll neu validiert werden. Darum wird Auslöser gecheckt.

ClosedCheckRegEx

Diese Geschäftsregel prüft, ob der Wert dem regulären Ausdruck entspricht.

Parameter

Beschreibung

pValue

Wert.

pIgnoreCase

Groß- und Kleinschreibung ignorieren.

pSingleMatchOnly

Wert darf nur einmal auf das Pattern passen.

pPattern

Regulärer Ausdruck.

ClosedCheckRejects

Diese Geschäftsregel prüft, ob im Feld unsichere Zeichen oder Rejects vorhanden sind. Wenn ja, schlägt sie fehl.

Parameter

Beschreibung

pContext

Validierungskontext-Objekt (wird vom System bereitgestellt).

pField

Feld.

ClosedCombineFields

Diese Geschäftsregel setzt mehrere Felder mit oder ohne Trennzeichen zu einem neuen Feld zusammen.

Parameter

Beschreibung

pTargetField

Zielfeld.

pSeparator

Trennzeichen.

pIgnoreEmpty

Leere Felder ignorieren. 1= ja; 0=nein.

pField1

Feld.

pField2

Feld, optional.

pField3

Feld, optional.

pField4

Feld, optional.

pField5

Feld, optional.

ClosedCompareFields

Diese Geschäftsregel prüft, ob der Wert des aktuellen Feldes mit dem Wert eines konfigurierten Feldes des Elterndokuments übereinstimmt.

Parameter

Beschreibung

pContext

Validierungskontext-Objekt (wird vom System bereitgestellt).

pField

Feld.

pCompareFieldName

Name des Vergleichsfeldes.

ClosedCountMedia

Diese Geschäftsregel zählt die Medien eines Dokumentes mit den übergebenen Eigenschaften (searchTerm) und speichert die Anzahl in dem angegebenen Feld (targetField).

Parameter

Beschreibung

context

Validierungskontext-Objekt (wird vom System bereitgestellt).

targetField

Das Feld, in dem die Anzahl der gefundenen Medien gespeichert wird. Die Zahl wird als String gespeichert (0, 1, 2, usw). Im Fehlerfall bleibt das Zielfeld unverändert.

searchTerm

Eine kommaseparierte Liste von Kriterien, die die Medien erfüllen müssen, um gezählt zu werden. Jedes Kriterium besteht aus drei Teilen:

  • Einer der folgenden Eigenschaftsnamen:

    • Format: Das Format des Mediums (z.B. TIFF) – oder eine leere Zeichenkette für Medien ohne angegebenes Format.

    • Name: Der Name des Medium – oder eine leere Zeichenkette für Medien ohne angegebenen Namen.

    • Type: Der XBOUND Dokumenttyp des Mediums – oder eine leere Zeichenkette für Medien ohne angegebenen Typ.

    • Resolution: Die Auflösung des ersten Bildes des Mediums in DPI (dots per inch) – oder 0 für Medien ohne angegebene Auflösung.

      Einschränkung: Nur Medien, deren horizontale und vertikale Auflösung gleich ist, werden berücksichtigt.

  • Einer der folgenden Vergleichsoperatoren:

    =  (der Ausdruck muss den Wert der Eigenschaft entsprechen)

    <>  (der Ausdruck darf den Wert der Eigenschaft nicht entsprechen)

  • Ein regulärer Ausdruck für die Suche nach dem Eigenschaftswert.

Es ist nicht notwendig, alle Eigenschaften anzugeben. Die Eigenschaften können in jeder beliebigen Reihenfolge verwendet werden und sind nicht case sensitive. Leerzeichen zwischen den Teilen werden ignoriert.

Beispiele:

  • Anzahl aller Medien:

    ""

  • Anzahl der Medium mit dem Format TIFF:

    "Format=TIFF"

  • Anzahl der Medium mit dem Format TIFF oder JPEG und Auflösung ungleich 300 DPI:

    "Format=(TIFF|JPEG), Resolution<>300"

  • Anzahl der Medium mit Format TIFF, Name 001.tif, DocType Invoice, Auflösung 300 DPI:

    "Format=TIFF, Name=001.tif, Type=Invoice, Resolution=300"

Ein ValidationResultCollection-Objekt wird zurückgegeben. Der Gültigkeitsstatus ist True sofern keine Ausnahme aufgetreten ist. Ist searchTerm ungültig, wird der Gültigkeitsstatus auf False gesetzt und der Grund dafür in der Nachricht angegeben.

ClosedExtractString

Diese Geschäftsregel sucht im Feld nach dem regulären Ausdruck und schreibt ihn in das Feld wieder zurück. Er wird also ausgeschnitten.

Parameter

Beschreibung

pValue

Wert.

pPattern

Regulärer Ausdruck.

ClosedFormatDate

Diese Geschäftsregel wandelt ein Datum in das angegebene Format um.

Parameter

Beschreibung

pDate

Ein Datumswert von Typ String.

pFormat

Formatzeichenfolge, z.B. 'dd.MM.yyyy'. Erlaubte Formate finden Sie unter: http://msdn.microsoft.com/de-de/library/vstudio/8kb3ddd4.aspx

ClosedGetQueryData

Diese Geschäftsregel spielt die Daten aus der angegebenen Abfrage zu. Die Regel füllt die konfigurierten XBOUND-Felder mit den Daten, wenn die Abfrage nur ein Ergebnis (eine Zeile) zurückliefert.

Informationen zur Konfiguration einer Abfrage finden Sie unter Datenbankabfrage konfigurieren und testen.

Parameter

Beschreibung

pContext

Validierungskontext-Objekt (wird vom System bereitgestellt).

pQueryName

Name der konfigurierten Abfrage.

pTriggerField1 – pTriggerField10

Feld mit dem diese Abfrage getriggert wird. Triggerfelder haben keine Auswirkung auf die Abfrage, sie dienen wirklich nur als deren Auslöser.

ClosedIsDate

Die IsDate-Methode überprüft, ob es sich bei dem übergebenen Datum, um ein gültiges Datum handelt. Länderspezifische Einstellungen bleiben dabei unberücksichtigt.

Parameter

Beschreibung

pDate

Ein Datumswert von Typ String.

ClosedIsDateFormat

Diese Geschäftsregel prüft, ob das Datum dem angegebenen Format entspricht.

Parameter

Beschreibung

pDate

Ein Datumswert von Typ String.

pFormat

Formatzeichenfolge, z.B. 'dd.MM.yyyy'. Erlaubte Formate finden Sie unter: http://msdn.microsoft.com/de-de/library/vstudio/8kb3ddd4.aspx

ClosedIsInDateRangeFromNow

Diese Geschäftsregel prüft, ob das Datum im angegebenen Intervall bezogen auf heute liegt. (ClosedBeispiel.)

Wenn definiert wird, dass

  • Datum darf einen Tag in der Zukunft liegen,

  • aktuelles Datum ist 30.01.2007 05:00,

  • jetzt ist der 31.01.2007 10:00,

dann ist das Datum zulässig. Angefangene Tage (Stunden, Minuten usw.) werden dabei nicht berücksichtigt.

Parameter

Beschreibung

pDate

Ein Datumswert von Typ String.

pInterval

Datumsintervall. Erlaubte Werte: 'd' = Tag; 'm' = Monat; 'y' = Jahr; 'h' = Stunde; 'n' = Minute; 's' = Sekunde; 'ms' = Millisekunde.

pCount

ClosedIsInDateRange_FixedFormat

Diese Geschäftsregel prüft, ob das Datum innerhalb des angegebenen Intervalls liegt. Angefangene Tage (Stunden, Minuten usw.) werden dabei nicht berücksichtigt.

Parameters

Beschreibung

pDate

Ein Datumswert von Typ String.

pFormat

Formatzeichenfolge, z.B. 'dd.MM.yyyy'. Erlaubte Formate finden Sie unter: http://msdn.microsoft.com/de-de/library/vstudio/8kb3ddd4.aspx

pInterval

Datumsintervall. Erlaubte Werte: 'd' = Tag; 'm' = Monat; 'y' = Jahr; 'h' = Stunde; 'n' = Minute; 's' = Sekunde; 'ms' = Millisekunde.

pBeforeInterval

pAfterInterval

ClosedIsInIntegerRange

Diese Geschäftsregel prüft, ob der Wert kleiner gleich dem angegebenen Maximalwert und größer gleich dem Minimalwert ist.

Parameter

Beschreibung

pValue

Wert.

pMinValue

Minimalwert.

pMaxValue

Maximalwert.

ClosedIsInQuery

Diese Geschäftsregel prüft, ob mit den in einer Abfrage konfigurierten Dokumentdaten mindestens eine Zeile in der Datenbank zu finden ist.

Informationen zur Konfiguration einer Abfrage finden Sie unter Datenbankabfrage konfigurieren und testen.

Parameter

Beschreibung

pContext

Validierungskontext-Objekt (wird vom System bereitgestellt).

pQueryName

Name der konfigurierten Abfrage.

pTriggerField1 – pTriggerField10

Feld mit dem diese Abfrage getriggert wird. Triggerfelder haben keine Auswirkung auf die Abfrage, sie dienen wirklich nur als deren Auslöser.

ClosedIsNotInDateRangeFromNow

Diese Geschäftsregel prüft, ob das Datum außerhalb des Intervalls bezogen auf heute liegt. (ClosedBeispiel.)

Wenn definiert wird, dass

  • Datum darf einen Tag in der Zukunft liegen,

  • aktuelles Datum ist 30.01.2007 05:00,

  • jetzt ist der 31.01.2007 10:00,

dann ist das Datum zulässig. Angefangene Tage (Stunden, Minuten usw.) werden dabei nicht berücksichtigt.

Parameter

Beschreibung

pDate

Ein Datumswert von Typ String.

pInterval

Datumsintervall. Erlaubte Werte: 'd' = Tag; 'm' = Monat; 'y' = Jahr; 'h' = Stunde; 'n' = Minute; 's' = Sekunde; 'ms' = Millisekunde.

pCount

ClosedIsNullOrEmpty

Diese Geschäftsregel prüft, ob der Wert leer oder undefiniert ist.

Parameter

Beschreibung

pValue

Wert.

ClosedIsNumeric

Diese Geschäftsregel prüft, ob der Wert numerisch ist.

Parameter

Beschreibung

pValue

Wert.

ClosedMandatory

Diese Geschäftsregel prüft, ob das Feld gefüllt ist.

Parameter

Beschreibung

pContext

Validierungskontext-Objekt (wird vom System bereitgestellt).

pField

Feld.

ClosedRegExReplace

Diese Geschäftsregel ersetzt im Wert eines Feldes (sourceField) jede einem gegebenen regulären Ausdruck (searchFor) entsprechende Zeichenfolge mit einer Ersetzungszeichenfolge (replaceBy) und stellt das Ergebnis in einem Feld (targetField) bereit. Das Ergebnis kann im aktuellen Feld oder in ein anderes Feld gespeichert werden.

Parameter

Beschreibung

sourceField

Quellfeld.

targetField

Zielfeld.

searchForDer zu verwendende regulären Ausdruck.
replaceByDas neue Format.
ignoreCaseIgnoriert Unterschiede in der Groß / Kleinschreibung.

Beispiel 1: Hier wird Vor- und Nachname umgeordnet. "Vorname Nachname" wird "Nachname, Vorname".

sourceField Wert: "Klaus Müller"

searchFor: "(\w+) (\w+)"

replaceBy: "$2, $1"

targetField Wert: "Müller, Klaus"

Beispiel 2:

Hier werden mehrere aufeinanderfolgende Leerzeichen zu einem zusammengefasst:

sourceField: "Take    it      easy"

seachFor: " +"

replaceBy " "

targetField: "Take it easy"

ClosedRemoveCharacters

Diese Geschäftsregel entfernt ungültige Zeichen.

Parameter

Beschreibung

pValue

Wert.

pInvalidCharacters

Ein oder mehr ungültige Zeichen (ohne Trennzeichen).

ClosedReplaceCharacters

Diese Geschäftsregel ersetzt ungültige Zeichen durch andere Zeichen.

Beispiel: pValue = "ABCDABCD", pOldCharacters="AC", pNewCharacters="1x"

Ergebnis: 1BxD1BxD

Parameter

Beschreibung

pValue

Wert.

pOldCharacters

Zu ersetzende Zeichen.

pNewCharacters

Zeichen, die die ungültigen Zeichen ersetzen.

ClosedResetShownInVerifierForAllFields

Setzt den ShownInVerifier Status an allen Feldern zurück.

Parameter

Beschreibung

Context

Validierungskontext-Objekt (wird vom System bereitgestellt).

Field

Feld.

ClosedResetValidForcedForAllFields

Setzt den ValidForced Status aller Felder zurück.

Parameter

Beschreibung

Context

Validierungskontext-Objekt (wird vom System bereitgestellt).

Field

Feld.

ClosedSetFieldsValidForcedForAllFields

Setzt den ValidForced Status aller Felder zurück.

Parameter

Beschreibung

Context

Validierungskontext-Objekt (wird vom System bereitgestellt).

Field

Feld.

Value

Feldwert, der dazu führt, dass alle Felder auf ValidForced gesetzt werden.

ClosedSetImageResolutionFromMedium

Diese Geschäftsregel ermittelt die Auflösung (in DPI) jedes Bild-Mediums (MIME-Type namens "image/...") und überträgt diese auf die Images des Mediums (RCF-Eigenschaften HorizontalResolution und VerticalResolution).

Tritt bei der Ermittlung der Auflösung eine Fehler auf, wird dieser als Fehler geloggt und mit dem nächsten Medium fortgefahren. Alle anderen Fehler führen dazu, dass die Validierung fehlschlägt.

Parameter

Beschreibung

context

Validierungskontext-Objekt (wird vom System bereitgestellt).

ClosedSetInvalid

Diese Geschäftsregel setzt den Validierungsstatus des Feldes auf Invalid.

Parameter

Beschreibung

pContext

Validierungskontext-Objekt (wird vom System bereitgestellt).

pFieldName

Feldname.

ClosedSetValid

Diese Geschäftsregel setzt den Validierungsstatus des Feldes auf Valid.

Parameter

Beschreibung

pContext

Validierungskontext-Objekt (wird vom System bereitgestellt).

pFieldName

Feldname.

ClosedSetValue

Diese Geschäftsregel weist den übergebenen Wert dem Feld zu.

Parameter

Beschreibung

pContext

Validierungskontext-Objekt (wird vom System bereitgestellt).

pFieldName

Feldname.

pValue

Neuer Wert.

ClosedShowInVerifier – Datumsfeld

Diese Geschäftsregel sorgt dafür, dass dieses Feld einmalig in der Verification vorgestellt wird.

Parameter

Beschreibung

pContext

Validierungskontext-Objekt (wird vom System bereitgestellt).

pField

Feld.

ClosedShowInVerifier – Floatfeld

Diese Geschäftsregel sorgt dafür, dass dieses Feld einmalig in der Verification vorgestellt wird.

Parameter

Beschreibung

pContext

Validierungskontext-Objekt (wird vom System bereitgestellt).

pField

Feld.

ClosedShowInVerifier – Integerfeld

Diese Geschäftsregel sorgt dafür, dass dieses Feld einmalig in der Verification vorgestellt wird.

Parameter

Beschreibung

pContext

Validierungskontext-Objekt (wird vom System bereitgestellt).

pField

Feld.

ClosedShowInVerifier – Stringfeld

Diese Geschäftsregel sorgt dafür, dass dieses Feld einmalig in der Verification vorgestellt wird.

Parameter

Beschreibung

pContext

Validierungskontext-Objekt (wird vom System bereitgestellt).

pField

Feld.

ClosedShowUncertainExtractionResults

Diese Geschäftsregel kontrolliert die Klassifikationssicherheit (Eigenschaft ConfidenceRank) des Feldwertes (FieldValue). Ist die Sicherheit ungleich "OK", wird die Meldung von der von der Extraktion (die Eigenschaft CustomTag) angezeigt.

Diese Geschäftsregel ermöglicht das einmalige Vorstellen einer ggf. am Feld hinterlegten Nachricht. Damit besteht die Möglichkeit, externe Validierungsmeldungen zur Anzeige zu bringen.

Das allgemeine Format von CustomTag ist eine Folge von Semikolon getrennten Schlüssel-Wert-Einträgen. Schlüssel und Wert sind durch ein Gleichheitszeichen getrennt. Der Schlüssel darf keine Gleichheitszeichen und der Wert kein Semikolon enthalten.

Der von der Geschäftsregel verwendete Eintrag enthält als Schlüssel "Message". Der Wert ist die anzuzeigende Nachricht.

Die Geschäftsregel sollte jeweils als erste Regel eines Feldes verwendet werden.

Parameter

Beschreibung

pContext

Validierungskontext-Objekt (wird vom System bereitgestellt).

pField

Feld.

ClosedSpellCheck

Diese Geschäftsregel prüft, ob der Wert eines Textfeldes Rechtschreibfehler beinhaltet.

Parameter

Beschreibung

pContext

Validierungskontext-Objekt (wird vom System bereitgestellt).

pValue

Das Feld.

pParameterSet

Das zu verwendende Prozess-Parameterset (siehe Speichern von Rechtschreibprüfungseinstellungen für die Wiederverwendung in Verification-Prozessschritten).

ClosedSplitFields

Diese Geschäftsregel splittet ein Feld am Separator auf und verteilt die Bestandteile in die angegebenen Felder.

Parameter

Beschreibung

pSourceField

Quellfeld.

pSeparator

Trennzeichen.

pTargetField1

Zielfeld.

pTargetField2

Zielfeld, optional.

pTargetField3

Zielfeld, optional.

pTargetField4

Zielfeld, optional.

pTargetField5

Zielfeld, optional.

ClosedToUpper

Diese Geschäftsregel wandelt alle Buchstaben in Großbuchstaben um.

Parameter

Beschreibung

pValue

Wert.

Geschäftsregelvorlagen anzeigen, sortieren und filtern

© 2018 Kofax, Inc. All rights reserved. | Nutzungsbedingungen