Configuring an Image Merge Item - 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

Image Merges are configured in the Front Office Scanning configuration file. All Image Merge information is contained in the MergeItems element of configuration file; the configuration information for each individual Image Merge is contained in a MergeItem sub-element of the MergeItems element.

Each MergeItem sub-element can have only one Image sub-element configured for it. To configure your solution for more than one Image Merge, you must create and configure a separate MergeItem sub-element for each Image Merge.

If you wish to configure a Document Type to perform both an Image Merge and a Data Set Keyword Merge, you can configure the Image sub-element and the Keywords sub-element within the same MergeItem sub-element. Alternatively, if you only wish to perform an Image Merge without stamping any Keyword Values onto the document, you can configure the Image sub-element within its own MergeItem sub-element and omit the Keywords sub-element.

To configure an Image Merge:

  1. In the Front Office Scanning configuration file, locate the MergeItems element. If this element is not present, add it to the configuration file.
    Tip:

    For more information on the Front Office Scanning configuration file's MergeItems element and the MergeItem sub-element, including a detailed description of its format and settings, see The MergeItems Element.

  2. Add a MergeItem sub-element to the MergeItems element.
    Each MergeItem sub-element contains the data associated with one Image Merge.
  3. Add the MergeID setting to the MergeItem sub-element. The MergeID setting is a unique, numeric identifier for the Image Merge represented by this MergeItem sub-element.

    For example:

    <MergeItem MergeID="1">
    Tip:

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

    Note:

    The MergeID value is also assigned to one or more Document Type buttons; for more information, see Assigning an Image Merge to a Document Type Button.

  4. Add an Image sub-element to the MergeItem sub-element. The Image sub-element allows you to configure the settings for the image to be captured and stamped on the document.
    To configure an Image sub-element:
    1. Add the ImgLeft setting to the Image sub-element. The ImgLeft 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.

      For example:

      <ImgLeft>1.1</ImgLeft>
    2. Add the ImgTop setting to the Image sub-element. The ImgTop 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.

      For example:

      <ImgTop>2.5</ImgTop>
    3. Add the XMax setting to the Image sub-element. The XMax setting allows you to specify the maximum width (in pixels) of the stamped image.

      For example:

      <XMax>5000</XMax>
    4. Add the YMax setting to the Image sub-element. The YMax setting allows you to specify the maximum height (in pixels) of the stamped image.

      For example:

      <YMax>3000</YMax>
    5. Add the Scale setting to the Image sub-element. The Scale 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.

      For example:

      <Scale>1.0</Scale>
      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.

    6. Once all settings have been configured for the Image sub-element, ensure that you add the end tag (i.e., </Image>) to close the Image sub-element in the MergeItem sub-element.
  5. Once the Image Merge has been configured, ensure that you add the end tag (i.e., </MergeItem>) to close the MergeItem sub-element.
  6. Repeat Steps 2-7 to create a MergeItem sub-element for each Image Merge that you would like to create for your Front Office Scanning solution.