Form

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

General Tab

Fields Tab

Components Tab

Appearance Tab

General Tab

Field Name Description
Display Name The name that will be displayed on the MFP for this form.
Single Touch Scan Check this option 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 — Restrict access to users or groups listed. Users can also search for users and groups by selecting Active Directory Integrated and accessing the entire active directory.
Scan Settings This table lists all of the available scan settings. 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 Ricoh Desktop SF User Guide for detailed description of each scan parameter. By selecting Locked (next to Basic Options), all Basic Options are locked and cannot be changed by the user at the MFP device panel. By checking Default (next to each Parameter), default options as supplied by the MFP device itself are used. Note: Selecting both Default and Locked does not produce any different result.  By checking the Default checkbox, the user will override the Locked checkbox. The user may define different scan settings for different parameters.  The user should note that the Default checkbox must NOT be checked in order to set values for Basic Options.
  • Page Size — Provides the list of available page size.
  • Sides — Placement of the target document on the MFP device.
  • Page Orientation — Orientation of the target document can be either Portrait or Landscape.
  • Resolution — Resolution (dots per inch) of the scan.
  • File Format — File format of the scanned document.
  • Multi-Page Tiff — A Tiff file format can be either a single page format or a multiple page format.
  • Color Mode — Provides the enumeration for an available color mode. The target document will be rendered in 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, regardless of specification, will be monochrome.
  • Mono Bit Depth — Specifies bit depth and used only when Color Mode is set to Black and White.  If Color Mode is set to Color, then any selection will be ignored and bit-depth will be set to 24-bit.
  • Composition — This option is not available in this version.
  • Content  — Contents of the target document.
  • Compression — This option is not available in this version.
The user may define different scan settings for Advance Options as well.  The user should note that the Default checkbox must NOT be checked in order to set values for Advance Options.  The user should also note that all MFPs do not support these Advance Options.  The user should check the user manual for their specific MFP 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 — 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 — 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 — 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 moiré patterns.
  • Action Button Text — 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 — This option is not available in this version.
  • Pdf Algorithm  — Specify the encryption algorithm to use with secure PDF.  File Format must be set to SECURE PDF.  The encryption algorithm is selected automatically.
  • Restart Job  — This option is not available in this version.
  • Scan Recovery  — This option is not available in this version.
  • Scanner Jam Recovery  — Specify whether the full or partial job must be resubmitted when the job is cancelled 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 Enable Dynamic Form — Standard behavior of a form can be modified by responding to events. This checkbox 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 (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 — 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 you want to use, you can browse for it using the ellipsis button next to the Snap-in path box. Source Path. 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 also click the Create/Edit Snap-in 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, please refer to the Ricoh Desktop SF Snap-in documentation  by clicking Help in the code editor window. Raise event when Form is Loaded — Select this checkbox to cause the form to initiate an event every time the user enters the form. Raise event when Form is Submitted — Select this checkbox to make the form to initiate an event every time the user presses Scan button in this 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.

  • Name — The field name should be unique among the other fields within this form.
  • Display — The text which is displayed above the field at 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 un-formatted 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 — Presents a list of choices in tree form.
  • N (Notify Server) — If checked, this field triggers 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 Ricoh Desktop SF Snap-in documentation.
  • P (Properties) — Allows a user to edit additional properties of the field type.

Components Tab

Configure the component for this form by clicking the Properties button (right-most column on each row). The configuration window for the component will be displayed. Refer to the help for the component for instructions to configure.

Appearance Tab

Option 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.
Button Images - 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; i.e. 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.