The MergeItems Element - Front Office Scanning - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Premier - external - Standard - Essential - Premier - Standard - Essential

Front Office Scanning

Platform
OnBase
Product
Front Office Scanning
Release
Foundation 23.1
License
Premier
Standard
Essential

The MergeItems element allows you to configure Data Set Keyword Merges and Image Merges for the existing templates in the Front Office Scanning client.

A Data Set Keyword Merge is an automated process that "stamps" a Keyword Value onto a template.

An Image Merge is a similar automated process that stamps an image captured by a webcam onto a template.

Note:

Data Set Keyword Merges and Image Merges are not supported on scanned images.

<MergeItems>
<MergeItem MergeID="1">
<Font>Times New Roman</Font>
<FontSize>16</FontSize>
<Page>1</Page>
<Keywords>
<Keyword>
<Page>3</Page>
<Name>MRN</Name>
<KeyLeft>0.25</KeyLeft>
<KeyTop>0.25</KeyTop>
<BarCode>True</BarCode>
<BarCodeType>Code39</BarCodeType>
<BarText>true</BarText>
<BarHeight>25</BarHeight>
<BarWidth>100</BarWidth>
</Keyword>
</Keywords>
<Image>
<ImgLeft>1.1</ImgLeft>
<ImgTop>2.5</ImgTop>
<XMax>5000</XMax>
<YMax>3000</YMax>
<Scale>1.0</Scale>
</Image>
</MergeItem>
</MergeItems>

The MergeItems element is composed of one or more MergeItem sub-elements. Each MergeItem sub-element represents one Data Set Keyword Merge or Image Merge configured for your Front Office Scanning solution. Multiple Keyword Value stamps can be configured as part of each Data Set Keyword Merge. Similarly, multiple webcam images can be configured as part of each Image Merge.

Each MergeItem sub-element contains the following settings:

MergeItem Sub-Element Settings

Description

MergeID

This setting specifies a unique identification number for the Data Set Keyword Merge represented by this MergeItem sub-element. This identification number is known as the merge ID.

Enter a numeric value for the merge ID.

Tip:

It is recommended that the first MergeItem sub-element have a MergeID of 1, the second MergeItem sub-element have a MergeID of 2, etc.

The merge ID is also assigned to one or more DocType elements. Once the merge ID is assigned to a DocType element, the Data Set Keyword Merge is configured for that DocType element (i.e.,each time a document is assigned to a Document Type via the Document Type button associated with the DocType element, the Keyword Value stamp configured by the Data Set Keyword Merge is added to the document).

Font

This setting allows you to specify the font used to display Keyword Values when they are stamped on the document as part of the Data Set Keyword Merge.

Enter the name of the font directly between the Font tags.

If no value is entered for the Font setting, or if the Font setting is not present, Arial is selected by default.

FontSize

This setting allows you to specify the size of the font used to display Keyword Values when they are stamped on the document as part of the Data Set Keyword Merge.

Enter the size of the font (in points) directly between the FontSize tags.

If no value is entered for the FontSize setting, or if the FontSize setting is not present, 12 is selected by default.

Page

This setting, when used outside a Keyword tag, allows you to specify which page of the document you would like Keyword Values to be stamped on by default as part of the Data Set Keyword Merge.

Enter the page number directly between the Page tags. To stamp the Keyword Value on all pages of the document, enter -1 for the Page setting.

You can also use the Page setting inside a Keyword tag to specify a different page of the document to stamp the Keyword Value specified in the Keyword tag. For this Keyword Value only, the Page setting specified inside the Keyword tag overrides the default Page setting specified outside the Keyword tag.

<Keywords>

The Keywords sub-element allows you to specify the Keyword Values that you would like to be stamped on the document as part of the Data Set Keyword Merge.

The Keywords sub-element is composed of one or more Keyword sub-elements.

<Keyword>

Each Keyword sub-element represents one Keyword Value that is stamped on the document as part of the Data Set Keyword Merge.

Each Keyword sub-element contains the following settings: Name, KeyLeft, KeyTop, and BarCode.

Name

This setting allows you to specify the Keyword Type associated with the Keyword Value from the selected Data Set that is stamped on the document.

Enter the name of the Keyword Type directly between the Name tags.

KeyLeft

This setting allows you to determine the horizontal positioning of the Keyword Value stamp on the document.

Enter the distance (in inches) between the left edge of the page and the beginning of the Keyword Value stamp directly between the KeyLeft tags.

KeyTop

This setting allows you to determine the vertical positioning of the Keyword Value stamp on the document.

Enter the distance (in inches) between the top of the page and the top of the Keyword Value stamp directly between the KeyTop tags.

BarCode

This setting allows you to display the Keyword Value as a bar code, rather than text, when it is stamped on the document as part of the Data Set Keyword Merge.

  • If BarCode is set to false, or if the BarCode setting is not present, then the Keyword Value is displayed as text when it is stamped on the document.

  • If BarCode is set to true, then the Keyword Value is displayed as a bar code instead of as a text value when it is stamped on the document.

BarCodeType

This setting allows you to set the type of bar code that the Keyword Value is displayed as when the BarCode setting is set to true.

  • If BarCodeType is set to Code39, or if the setting is not specified, then the Keyword Value is displayed as a Code 39 (3 of 9) bar code.

  • If BarCodeType is set to Code128, then the Keyword Value is displayed as a Code 128 bar code.

  • If BarCodeType is set to DataMatrix, then the Keyword Value is displayed as a DataMatrix bar code.

  • If BarCodeType is set to PDF417, then the Keyword Value is displayed as a PDF417 bar code.

  • If BarCodeType is set to QRCode, then the Keyword Value is displayed as a QR code.

Note:

To create Code 128, DataMatrix, PDF417, or QR code bar codes, the Hyland Bar Code Recognition software for OnBase version 12 or later is required.

BarText

This setting allows you to display or hide the Keyword Value in plain text beneath the bar code that is stamped on the document as part of the Data Set Keyword Merge.

  • If BarText is set to true, or if the setting is not specified, the plain text Keyword Value is displayed beneath Code 3 of 9 and Code 128 bar codes. The plain text value is not displayed beneath DataMatrix, PDF417, or QR code bar codes.

  • If BarText is set to false, the plain text Keyword Value is not displayed beneath any of the bar code types.

BarHeight

This setting allows you to specify the height of the bar codes used to display Keyword Values.

Enter the desired height size in hundredths of inches.

If the setting is not specified, the default values are 25(0.25 inches) for Code 3 of 9 and Code 128 bar codes, and 100(1.00 inches) for DataMatrix, PDF417, and QR code bar codes.

Note:

If you enter a value that is too small for the data to be encoded, an error message will be displayed when the Data Set Keyword Merge process is run.

BarWidth

This setting allows you to specify the width of DataMatrix, PDF417, and QR code bar codes used to display Keyword Values.

Enter the desired width size in hundredths of inches.

If the setting is not specified, the default value is 100 (1.00 inches) for DataMatrix, PDF417, and QR code bar codes.

Note:

This setting does not affect the width of Code 3 of 9 or Code 128 bar codes. The widths of these bar code types are determined by the data to be encoded.

Note:

If you enter a value that is too small for the data to be encoded, an error message will be displayed when the Data Set Keyword Merge process is run.

<Image>

The Image sub-element allows you to capture an image and stamp it onto the document as part of the Data Set Keyword Merge.

Each Image sub-element contains the following settings: ImgLeft, ImgTop, XMax, YMax, and Scale.

ImgLeft

This setting allows you to specify the horizontal positioning of the stamped image on the document.

Enter the distance (in inches) between the left edge of the page and the left edge of the stamped image.

ImgTop

This setting allows you to specify the vertical positioning of the stamped image on the document.

Enter the distance (in inches) between the top edge of the page and the top edge of the stamped image.

XMax

This setting allows you to specify the maximum width (in pixels) of the stamped image.

YMax

This setting allows you to specify the maximum height (in pixels) of the stamped image.

Scale

This setting allows you to specify the scale of the stamped image. For example, 1.0 is the original size of the image, 0.5 is half of the original size, and 2.0 is double the original size.

Note:

The Scale setting respects the original aspect ratio of the image, but the aspect ratio can be altered if XMax and YMax do not also respect the original aspect ratio.

In order to use the functionality offered by these settings, additional configuration is required. For more information on merging Keyword Values on a document, see Configuring a Data Set Keyword Merge. For more information on merging a webcam image on a document, see Configuring an Image Merge.