OmniPage Barcode component RRTs

Component RRT ID

The RRT ID for this component is OPB.

Date and time related RRTs are evaluated in Coordinated Universal Time (UTC) by default. It can be set to use local time, for more details, see Using RRTs.

Reserved Replacement Tag Names (RRTN)

Returns RRT Name Description

All barcodes

*,*

A comma-separated list of values of all barcodes recognized in the output document.

All barcodes of zone "ZoneName"

ZoneName,*

A comma-separated list of all barcodes from a zone with the name ZoneName.

All barcodes per page

BarcodesPerPage

Lists all barcodes per page using the following format:

~OPB::BarcodesPerPage~=1:BC1,BC2;2:BC3,BC4,BC5

where the numbers represent the page number of the output document where the barcodes are recognized, and BC represent the barcode values recognized on the current page.

All pages with barcodes

BarcodeAllPages

Lists all pages with barcodes using the following format:

~OPB::BarcodeAllPages~=1,1,2,2,2

where the numbers represent the page numbers of the output document where the barcodes are recognized. It can be paired up with the information from the All barcodes RRT:

~OPB::*,*~=BC1,BC2,BC3,BC4,BC5

where the listed elements represent all barcode values recognized on the output document.

Barcode pages

BarcodePages

A comma-separated list of page numbers in the output document for pages on which barcodes are recognized.

Barcode value of a zone

ZoneName,PageNumber

The barcode value recognized for a zone with the name ZoneName.

Replace PageNumber with a page number in the output document. The component will return an empty string if the zone is not encountered on a specified page number.

Count of pages

PagesCount

The count of pages in the output document.

Count of pages with barcode

BarcodePagesCount

The count of pages in the output document on which the component recognizes barcodes.

Page specific barcodes

,PageNumber

A comma-separated list of values of all the barcodes the component recognizes on a specified page of the output document. Replace PageNumber string with a page number in the output document.

Pages of a zone "ZoneName"

ZoneName,pages

A comma-separated list of pages in the output document on which the component recognizes a zone with the name ZoneName.

Field Replacement Tag Names (FRTN)

Fields set on the Field Values tab of the Barcode component settings can be used as RRTs. The syntax used to refer to field values in this case is as follows:

FRT Name Description

%FieldName%

The RRT specifies the name of a FieldName field defined on the Field Values tab.

When the Split on barcode check box is selected on the General tab of the OmniPage Barcode settings, every output document, representing the part of the input document, has its own page numbering and its own set of barcodes. Therefore, when you select the Split on barcode function, the component RRTs are replaced separately for each of the output documents (parts of the split document).

Barcode Separator Pages RRTs

When you use the options Split on barcode and Generate RRTs for barcodes on barcode pages, the component generates a set of RRTs for the barcode values found on pages considered as separators.

The following table describes the RRTs for barcode values from separator pages:

Returns RRT Name Description
Output documents count SplitPartsCount

The number of output documents (after splitting the original document).

Separator pages count

SplitSeparatorsCount

The number of pages in the original document identified as split separators.

Separator pages list SplitSeparatorsPages

A comma-separated list of pages in the original document identified as split separators.

Separator barcodes list SeparatorBarcodes

A comma-separated list of separator barcodes in the original document.

Separator barcode

SeparatorBarcode

The separator barcode from the split output document.

External Scripting RRTs

The following table describes the RRTs for that can be used to pass data to scripts:

Returns RRT Name Description
Value of the current barcode Barcode

The value of the current barcode.

Name of zone where the barcode was found

Zonename

The name of the zone where the barcode was found.

List of all barcodes on specified page PageBarcodes

A comma-separated list of all barcodes found on the current page.

Pagenumber of the page PageNumber

The page number; starts with 1.