Form

When setting up a form the following four tabs must be configured:

General Tab

Fields Tab

Components Tab

Appearance Tab

General Tab

Option Description
Display Name The name that will be displayed on the MFP for this form.
Single Touch Scan Select this check box if you do not want the user to enter any indexing data about the document. By selecting this option, the scan operation will start immediately after the user presses the "form" button on the device.
Access Control Access to the form can be control with the following options:
  • Public  — Allows unrestricted public access to the form.
  • Restricted Access — Restricts access to users or groups listed. Users can also search for users and groups by checking.
  • Active Directory Integrated — Accessing the active directory to authenticate users.
Scan Settings This table lists all of the available scan settings. Configure settings in the four columns:
  • The Parameter column shows a configurable scan setting. Settings are grouped under Basic Options and Advanced Options. You can scroll the list up or down to see additional options.
  • In the Value column you can set default scan settings, which will be used if the user does not change the setting at the device panel. See the Lexmark User Guide for a detailed description of each scan parameter.
  • Select the Locked checked box to prevent users from changing a setting at the MFP device panel. Select the Locked check box next to Basic Options to prevent users from changing any of the basic options.
  • Select Default to use the default setting supplied by the MFP device. You cannot set values for a parameters while the Default check box is selected.
    Note: The Default selection overrides the Locked setting, so selecting both Locked and Default is not any different result than just selecting the Default check box. The user may still define different scan settings for parameters at the MFP console.

Settings for Basic Options:

  • Page Size — Select from the list of available page sizes.
  • Sides — Specifies Simplex (one-sided), Duplex Short Edge (two-sided, bound on short edge) and Duplex Long Edge (two-side, bound on long edge).
  • Page Orientation — Orientation of the target document, either “portrait” or “landscape”.
  • Resolution — Resolution in dpi (dots per inch) of the scan.
  • File Format — File format of the scanned document (TIFF, JPEG, PDF, RAW (2.0), Secure PDF, XPS).
  • Multi-Page Tiff — Specifies whether the TIFF file contains a single page image or a multi-page images (subfiles).
  • Color Mode — Provides the enumeration for an available color mode. The target document will be rendered in Black and White (grayscale) or Color. If no value is specified, Color will be used. If the device is only able to scan in monochrome then all scans will be monochrome, regardless of the setting here.
  • Mono Bit Depth — Specifies bit depth and used only when Color Mode is set to Black and White. This setting is ignored if Color Mode is set to Color and bit-depth will be set to 24-bit. This setting is only available with devices using Framework versions 2.x. For previous versions, use the Composition setting.
  • Composition — Specifies the image composition of the job. The image composition defines the bit depth, number of planes, and color space of the image data to be generated by the job. Not all combinations of image composition, file format and compression are valid for Framework versions 1.x. This setting is not used and has no effect for devices running Framework versions 2.x.
  • Content  — Contents of the target document.
  • Compression — Specify different formats for compression of the scanned image. Not available with devices using Framework versions 2.x.

Settings for Advanced Options:

Note: Not all Lexmark MFPs support these options. Refer to the user manual for a device for more information.
  • Custom Job — Allows a user to concatenate sets of original scan jobs into one single job. Jobs may from different sources and different settings.
  • Darkness — The darkness level of the scan with (1) being the lightest and (9) the darkest.
  • Edge Erase (Top, Left, Right, Bottom) — Specifies the amount of image data to erase at either the top, left, right or bottom of the original image window. This option allows the user to eliminate unwanted marks along the edge of the target document.
  • Scan Preview (hard drive) — When enabled, the user will see a thumbnail of the image scanned. With flatbed devices, a thumbnail will be displayed for each page scanned. For ADF devices, a thumbnail will be displayed for only the first page.
  • Background Removal — Specify the background removal level of a scan. Higher values change lighter shades to white. A value of zero (0) is neutral.
  • Color Dropout (2.0) — Turns the selected color to white in order to aid with forms processing functions. Also turns dark marks and notations to black. This setting only affects grayscale jobs.
  • Color Dropout Threshold (2.0) — Specify the threshold for shades to become either black or white. By increasing the threshold, darker shades become black while lighter shades become white. By decreasing the threshold, darker shades become white while lighter shades become black.
  • Contrast — Specify the contrast level of the scan. Higher values results in more contrast.
  • JPEG Quality — The amount of image quality and detail to be retained by the JPEG compression algorithm.
  • Source — Specify the scanning source.
  • Negative Image (2.0) — Specify whether the image produced by the scan is to be inverted.
  • Shadow Detail — Specifies the black-point level of the scan.
  • Scan Edge to Edge — Specify whether target document will be scanned from edge to edge or only within the specified margins.
  • Sharpness — Specify the sharpness of the image. Increasing the value may be useful for blurry text. Decreasing the value may be useful for patterns.
  • Action Button Text (2.0) — Specify the text to be displayed on the “Action” button. If no text is specified, the default text for the action is used.
  • One Page Copy — Specify whether scanner scans an entire job at one time or one page.
  • Pdf Password (1.2 on X940e, X945e) — User can specify a password to use for secure PDF. File Format must be set to SECURE PDF. This setting does not apply to Framework versions 2.x.
  • Pdf Algorithm (1.2 on X940e, X945e) — Specify the encryption algorithm to use with secure PDF. File Format must be set to SECURE PDF. With Framework versions 2.x, the encryption algorithm is selected automatically.
  • Restart Job (1.2 and older) — Specify whether the job must be resubmitted when the job is canceled for any reason. This setting does not apply to Framework versions 2.x. For Framework versions 2.x, the user can use Scanner Jam Recovery instead of this setting.
  • Scan Recovery (1.2 and older) — Specify whether a job resumes immediately after the MFP devices jams. Successfully scanned pages will be preserved and scanning will resume after the last good page. If setting is not selected, the job will not resume after the MFP device jam.
  • Scanner Jam Recovery (2.0) — Specify whether the full or partial job must be resubmitted when the job is canceled for any reason. If Page-level is selected and the entire job must be restarted, then the job must be resubmitted. The Page-level setting saves all properly scanned pages but all pages after the first jammed must be resubmitted.
Dynamic Form

Standard behavior of a form can be modified by responding to events.

  • Enable Dynamic Form — This check box allows the workflow sever to load form snap-ins. Here are some examples of what enabling dynamic forms can do:
    • Add and remove fields.
    • Change field contents, for example, load the contents of a list field from a database)
    • Validate field contents before the document is scanned into the server.
  • Snap-in path — Specifies the full path to the compiled snap-in (.NET assembly) that contains the code to respond to form and field events. If you have an existing snap-in to use, click the browse button (...) to locate the file.
  • Source Path — Specifies the full path to the source code of the snap-in. This path is used by code editor to compile the snap-in only during design time.
  • Create/Edit Snap-in — You can click this button to open a code editor window with basic snap-in code. For details of the code editor window and the object model used to respond to form and field events, click Help in the code editor window to refer to the Lexmark Capture Component Snap-in Documentation.
  • Raise event when Form is loaded — Check this check box to cause the form to initiate an event every time the user enters the form.
  • Raise event when Form is submitted — Select this check box to make the form to initiate an event every time the user presses Scan button for the form.

Fields Tab

Configure the indexing fields that will be presented to user. Add fields by clicking on the New field button appearing as the first column header and labeled with “N”. Once you have added the first row, you can tab through to get additional fields added.

Option Description
Name The field name should be unique among the other fields within this form. This name is displayed for the field on the device panel. The field name labels the RRT that returns the field value at run time. For example, if the field name is "Field1", the RRT is ~K20::%Field1%~. The name can be any combination of alphanumeric characters. Spaces and special characters (for example, ~, !, @, #, $, %) are not allowed.
Display The text that labels a field on the device panel.
Type A field type represents the format by which data is collected at the device panel. Regardless of field type, the result will be in text format. The following field types are supported:
  • Text — Allows a user to enter plain text.
  • Integer — Allows a user to enter integers (whole numbers only).
  • Numeric — Allows a user to enter numbers (with or without decimal point).
  • List — Allows to present users with a list of choices from which users select the desired item. Use this field type if you want a text field with auto complete capabilities. If a list of choices is too long, the list can be made searchable.
  • Tree — Creates a tree choice control in a form.
N (notify server) Select the check box in this column to trigger an event when the value of the field changes. You can respond to this event in the snap-in that was configured for the dynamic form section in the General tab. For details on how to respond to form and field events, refer to the Lexmark Capture Component Snap-in Documentation.
P (properties) Click the browse button (...) in this column to edit properties for a particular field type.

Components Tab

Configure the component for this form by clicking the configuration button (...) in the last C column of the table. Clicking this button for a component displays its configuration window. For more information about configuring a component, click the Help button in the component configuration window.

Appearance Tab

Field Name Description
Description The name that will be displayed on the MFP for this form.
Scan Button Label Enter the text that will appear on the scan button on the display panel for the device.
Button Images
  • Normal — Enter the location of the image that will be displayed on the MFP panel (this image will be the icon that is displayed prior to the user pressing that icon on the MFP panel). If no image is selected, the default image on the MFP panel will be used.
  • Pressed — Enter the location of the image that will be displayed on the device once the user has pressed the icon (this image will be displayed for a corresponding icon once the user has selected that icon; that is, the image used will change from the one specified in the Normal field to the one specified in the Pressed field). If no image is selected, the default image on the MFP panel will be used.