BarcodeToField
This business rule transfers one or all barcodes to the field using a separator. CaptureComponents_CheckClassificationConfidence
This business rule checks: Whether the classification confidence reaches a
specified threshold. If not, the field is deleted and
displayed in Verification. Whether the classification confidence reaches a
minimum level. If not, the field is deleted and displayed
in Verification. Whether the confidence level of classification and
separation was Certain.
|
| ValidationContext
object (provided by the system; not configured by users). | | Field. | | The minimum
confidence that must be reached in order for the document
to be set to Valid.
| | The confidence
threshold that must be reached; otherwise the recognized
value is discarded. | | If 1,
the confidence threshold will apply to classification
and separation. | | The confidence
separation (difference) between alternatives, when
multiple alternatives are found. Not
yet implemented. |
CaptureComponents_CheckExtractionConfidence
This business rule checks: Whether the extraction confidence reaches a specified
threshold. If not, the field is deleted and displayed
in Verification. Whether the extraction confidence reaches a minimum
level. If not, the field is deleted and displayed in Verification. Whether the second extraction alternative has sufficient
distance (difference) from the best alternative.
|
| ValidationContext
object (provided by the system; not configured by users). | | Field. | | The minimum
confidence that must be reached in order for the document
to be set to Valid.
| | The confidence
threshold that must be reached; otherwise the recognized
value is discarded. | | The confidence
separation (difference) between alternatives, when
multiple alternatives are found. Not
yet implemented. |
ChangeParentDocument
This business rule moves the current document to a the last
preceding document of specified document type. |
| ValidationContext
object (provided by the system; not configured by users). | | Document
type of the target document. |
CheckConfidenceRank
This business rule checks if the read result of field or cell is certain. If not, validation fails. |
| ValidationContext
object (provided by the system; not configured by users). | | Field. |
CheckForInvalidCharacters
This business rule checks for invalid characters in the
specified value. You can provide the invalid characters without
a separator in the pInvalidCharacters parameter. |
| Value. Map this parameter to a varchar
field. | | One or more invalid characters (no separator expected). |
CheckLength
This business rule checks if the length is between the specified
minimum and maximum length. |
| Value. Map this parameter to a varchar
field. | | Minimum
length. If minimum length is set to -1, it is not
checked. | | Maximum
length. If maximum length is set to -1, it is not
checked. |
Example: A CheckLength comparison has three parameters:
pValue, pMinLength, and pMaxLength. The pValue parameter is typically
set to a field, for example PostCode.
This field should be validated, so we select the box in the
column. When something changes in the PostCode
field, we want to reapply the rule. Therefore, we select . The pMinLength parameter is a constant and
is set to 3. Triggering and validation are not relevant here. The pMaxLength parameter is extracted from
the PostCode Length field. However,
this field is only for dynamic data transmission; the value for pMaxLength
is not fixed but comes live from the field. This field is not validated,
so is not selected. However,
when PostCode Length changes, we
want to reapply the rule, so we select . CheckRegEx
This business rule checks if a value matches a specified
. |
| Value. Map this parameter to a varchar
field. | | Ignore
case. If true, capitalization is not relevant. | | Value may
only fit once to pattern. | | Regular expression. |
CheckRejects
This business rule checks if the field or cell contains
rejects or suggestions. If so, validation fails. |
| ValidationContext
object (provided by the system; not configured by users). | | Field. |
CombineFields
This business rule combines fields with another field using
the specified separator. |
| Target
field. | | Separator. | | Ignore
empty fields. 1= true; 0=false. | | Field. | | Field, optional. | | Field, optional. | | Field, optional. | | Field, optional. |
CompareFields
This business rule compares the current field with a specified
comparison field on the parent document (not case-sensitive). |
| ValidationContext
object (provided by the system; not configured by users). | | Field. | | Name
of the comparison field. |
CountMedia
This business rule counts the media that match the specified criteria () in the current document and reports that number to the specified field (). |
| ValidationContext
object (provided by the system; not configured by users). | | The field to report the number of matching media to. The number is saved as a string (0, 1, 2, etc.). If there is an error, the target field remains unchanged. | | A comma-separated list of criteria that the media must meet in order to be counted. Each criterion consists of three parts: A property name – one or more of these: Format: The format of the medium (for example TIFF), or an empty string for media with no format specified. Name: The name of the medium, or an empty string for media with no name specified. Type: The XBOUND document type of the medium, or an empty string for media with no type specified. Resolution: The DPI of the first image of the medium, or 0 for media with no resolution specified. Restriction: Only media whose horizontal and vertical resolution are equal are considered.
One of the following comparison operators: = (the expression must match the property value) <> (the expression must not match the property value) A for matching the property value.
It is not necessary to enter all of the properties, and they can be used in any order. They are not case sensitive. Spaces between the parts are ignored. Examples: Total number of media: "" Number of media with TIFF format: "Format=TIFF" Number of media with TIFF or JPEG format and resolution not 300 DPI: "Format=(TIFF|JPEG), Resolution<>300" Number of media with TIFF format named 001.tif that are associated with the "Invoice" document type and that have 300 DPI: "Format=TIFF, Name=001.tif, Type=Invoice, Resolution=300"
|
A ValidationResultCollection is returned. The validity status is True unless an exception occurs. If is invalid, the validity status is set to False and the reason is reported in the message. ExtractString
This business rule extracts from the current field a string
that matches the specified , and replaces the field value with the extracted
string. |
| Value. Map this parameter to a varchar
field. | | Regular expression. |
FormatDate
This business rule changes the date value to a specified
format. GetQueryData
This business rule retrieves data from a query, if the query
delivers a single result. This rule fills the configured XBOUND
fields with the query data if the query returns only one row. For information about configuring a query, see Creating
and testing a database query. |
| ValidationContext
object (provided by the system; not configured by users). | | Query name. | | Trigger field. (The field that triggers this query.) Trigger fields
do not influence the query itself. |
IsDate
This business rule checks whether if the specified value
is a valid date. Country-specific settings are ignored. |
| A date value of type string. |
IsDateFormat
This business rule checks whether the date fits the specified format. IsInDateRangeFromNow
This business rule checks whether the date is
within the specified interval with respect to the
current date. Example: You specify that the date can be one
day in future. The current date is January 31, 2013
at 5 a.m. The given date is January 30, 2013 at
10 a.m.
Result: The date is within range. Parts
of a new day (hours, minutes) are not considered.
|
| A date value of type string. | | Date interval. Allowed values: 'd' = day; 'm' = month; 'y' = year; 'h'
= hour; 'n' = minute; 's' = second; 'ms' = millisecond. | | Number of intervals to add. Example: That means that can be maximum
three days in the future. is
valid. is
valid. is
invalid.
|
|
IsInDateRange_FixedFormat
This business rule checks if the date is within the specified interval. Note that parts of a new day, such as hours and minutes, are not considered. |
| A date value of type string. | | Format (for example "dd/MM/yyyy"). More
information about standard date and time format strings (external
link). | | Date interval. Allowed values: 'd' = day; 'm' = month; 'y' = year; 'h'
= hour; 'n' = minute; 's' = second; 'ms' = millisecond. | | Number of intervals before the current date. Example: This means that the date can be max. 14 days in the past. is
invalid. is
valid. is
valid.
| | Number of intervals after the current date. Example: This means that the date can be max. 30 days in the future. is
invalid. is
valid. is
valid.
|
|
IsInIntegerRange
This business rule checks if current value is less than
or equal to the minimum value and greater than or equal to
the maximum value. |
| Value. Map this parameter to a varchar
field. | | Minimum
value. | | Maximum
value. |
IsInQuery
This business rule checks if the document data can be found
in the query result. For information about configuring a query, see Creating
and testing a database query. |
| ValidationContext
object (provided by the system; not configured by users). | | Query name. | | Trigger field. (The field that triggers this query.) Trigger fields
do not influence the query itself. |
IsNotInDateRangeFromNow
This business rule checks if the date is not within the
specified interval with respect to the current date. ( Example.) This business rule transfers one or all barcodes to the
field using a separator. |
| A date value of type string. | | Date interval. Allowed values: 'd' = day; 'm' = month; 'y' = year; 'h'
= hour; 'n' = minute; 's' = second; 'ms' = millisecond. | | Number of intervals to add. Example: That means that can be maximum
three days in the future. is
valid. is
valid. is
invalid.
|
IsNullOrEmpty
This business rule checks if the value is filled in. |
| Value. Map this parameter to a varchar
field. |
| IsNumeric
This business rule checks if value is numeric. |
| Value. Map this parameter to a varchar
field. |
Mandatory
This business rule checks if the field is filled in. |
| ValidationContext
object (provided by the system; not configured by users). | | Field. |
RegExReplace
This business rule takes the value of a field (sourceField), replaces strings that match a (searchFor) with a replacement string (replaceBy), and saves the result in a field (targetField). The target field can be the same field or a different one. |
| Source field. | | Target field. | | The regular expression to use. | | New format. | | Ignores differences in upper/lowercase letters. |
Example 1: In this example the first name and last name are rearranged. "First Last" becomes "Last, First". sourceField value: "John Doe" searchFor: "(\w+) (\w+)" replaceBy: "$2, $1" targetField value: "Doe, John" Example 2: In this example, multiple spaces are reduced to one space: sourceField: "Take it easy" seachFor: " +" replaceBy " " targetField: "Take it easy" RemoveCharacters
This business rule removes invalid characters. |
| Value. Map this parameter to a varchar
field. | | One or more invalid characters (no separator expected). |
ReplaceCharacters
This business rule replaces certain characters with specified
new characters. Example: pValue = "ABCDABCD", pOldCharacters="AC",
pNewCharacters="1x" Result: 1BxD1BxD |
| Value. Map this parameter to a varchar
field. | | Characters
to be replaced. | | Characters
to replace the old ones. |
ResetShownInVerifierForAllFields
This business rule resets the ShownInVerifier
status for all fields. |
| ValidationContext
object (provided by the system; not configured by users). | | Field. |
ResetValidForcedForAllFields
This business rule resets the ValidForced
status for all fields. |
| ValidationContext
object (provided by the system; not configured by users). | | Field. |
SetFieldsValidForcedForAllFields
This business rule sets all fields to the ValidForced
status if the value of the trigger field matches the
specified value. |
| ValidationContext
object (provided by the system; not configured by users). | | Field. | | If the
field has this value, then the field is assigned the
ValidForced
status. |
SetImageResolutionFromMedium
This business rule gets the resolution (DPI) of each medium (MIMETypes named "image/...") and saves it to the images of the medium (RCF properties HorizontalResolution and VerticalResolution). If an error occurs when getting the resolution, it logs theerror and continues with the next medium. All other errors cause validation to fail. |
| ValidationContext
object (provided by the system; not configured by users). |
SetInvalid
This business rule sets the status of the field to Invalid. |
| ValidationContext
object (provided by the system; not configured by users). | | Field name. |
SetValid
This business rule sets the status of the field to Valid. |
| ValidationContext
object (provided by the system; not configured by users). | | Field name. |
SetValue
This business rule sets the field value. |
| ValidationContext
object (provided by the system; not configured by users). | | Field name. | | New field
value. |
ShowInVerifier
– Date field
This business rule shows the selected field once in the
Verification. |
| ValidationContext
object (provided by the system; not configured by users). | | Field
(DateTime). |
ShowInVerifier
– Float field
This business rule shows the selected field once in the
Verification. |
| ValidationContext
object (provided by the system; not configured by users). | | Field
(Float). |
ShowInVerifier
– Integer field
This business rule shows the selected field once in the
Verification. |
| ValidationContext
object (provided by the system; not configured by users). | | Field
(Int). |
ShowInVerifier
– String field
This business rule shows the selected field once in the
Verification. |
| ValidationContext
object (provided by the system; not configured by users). | | Field. |
ShowUncertainExtractionResults
This business rule looks at the confidence rank (ConfidenceRank
property) of the field value (FieldValue).
If the rank is not "OK", the message from extraction
(the CustomTag
property) is displayed. This allows the one-time presentation of a message
optionally attached to a field. It can be used to display
external validation messages in the Verification. CustomTag
must contain a semicolon-separated series of key value
records. The keys and values must be separated by equal signs.
The keys themselves must not contain equal signs, and the
values must not contain semicolons. The record used by the business rule must have "Message"
as key. The value is the message to be displayed in Verification. The business rule – if used – must be the first rule of
the field. |
| ValidationContext
object (provided by the system; not configured by users). | | Field. |
SpellCheck
This business rule checks whether the field value contains
spelling errors. SplitFields
This business rule splits the source field using a separator,
and it puts the parts into target fields. |
| Source
field. | | Separator. | | Target
field. | | Target field, optional. | | Target field, optional. | | Target field, optional. | | Target field, optional. |
ToUpper
This business rule changes all letters to capital letters. |
| Value. Map this parameter to a varchar
field. |
|