IdentifyByBarcodesBP

Updates the current page type if a barcode match is found.

Syntax

bool IdentifyByBarcodesBP(string barcodePageMappings, string mappingsDelim, string keyValueSep, bool caseSensitive)

Parameters

barcodePageMappings: A delimited list of barcode value-page type mappings that are evaluated to determine whether matching barcodes exist on the current page. For more information, see the Details section.
If any of these mappings are regular expressions, set the batch variable BarcodeRegEx to true. If this variable is not set to true, the regular expressions are not recognized as regular expressions. Smart Parameters are supported.
mappingsDelim: (Optional) Delimiter separating mappings. Default: comma. Smart Parameters are supported.
keyValueSep: (Optional) Delimiter that is used to separate the barcode value and the page type in an individual mapping. Default: equals sign (=). Smart Parameters are supported.
caseSensitive: (Optional) True enforces case sensitivity when you evaluate the list of barcodes that are found on the page. Default: False.

Returns

True, if a match is found. Otherwise, False.

Level

Page level

Details

This action searches all of the barcodes that are found on the current page for a match from the provided mappings by using the GetBarCodeList variable. If a barcode value is found, this action updates the type of the current page by using the corresponding input mapping.

The GetAllBarcodesBP action is called if the GetBarCodeList variable does not exist. If the GetAllBarcodesBP action was called earlier with a string parameter, use an identical symbol for the mappingsDelim parameter.

If multiple barcode values are found, the page type that is assigned is the first corresponding value from the GetBarCodeList variable.

Example

IdentifyByBarcodesBP(Separator=Separator_PageAttach=Attachment_Page,,,)
IdentifyByBarcodesBP(Separator=Separator_Page%Attach=Attachment_Page,%,,,)
IdentifyByBarcodesBP(Separator|Separator_Page%Attach|Attachment_Page,%,|,True)