Basic Form

Use the Basic form captures general information for a basic workflow.

Basic forms are added and edited on the Groups tab of the Kyocera MFP (HyPAS) configuration dialog box.

  • To add a basic form to a process, click a group or menu node then click Add Form > Basic Form on the menu bar.
  • Configure options for a basic form on the General, Fields, and Components tabs in the Form Settings dialog box.

When you set up any type of form, the following three tabs must be configured in the Form Settings dialog box:

General Tab Options

Option Description
Name The name of the form to be displayed on the MFP panel. For example, if this form is used to send the scanned documents to the user’s home directory, then name the form "Scan to User’s Home Directory". This name must be unique among the forms at the current nesting level.
Icon Specifies an icon to be associated with this form. Enter the path where the image is stored. The image must be 64x64 pixels, saved to a PNG or JPEG file that is no larger than 24 KB.
Single Touch mode Select this check box to begin the scanning process immediately after a user selects the form. The user is not prompted for selections of any kind.
Access Control Specifies who can use a form.
  • Public Access — Allow any user to access the form.
  • Restricted Access — Allow specified users to access the form.
  • Allowed Users/Groups — Specifies users who can access the form for Restricted Access. Click the browse button (...) to select users or groups.
Scan Settings This table lists all the available scan settings and specifies the default value for each setting. The default value is used when a user does not change a setting at the device panel.

The Setting column identifies the setting to be configured, the Options column specifies the default setting for an option. Select the Allow Changes check box to allow users to change a scan setting at the device panel. This check box is initially selected for all scan settings.

This table allows you to configure the following scan settings:

  • File Format — Choose PDF, TIFF, JPEG, or High Compression PDF.

    Only TIFF and PDF are compatible with black and white. File format is changed from JPEG or High Compression PDF to TIFF when Color Mode is set to "Auto (Color/B&W)" or "Black & White".

    When PDF High Compression is selected, the default Resolution can only be set to 300 dpi.

  • Resolution — Resolution (dots per inch) of the scan. Settings are 200 dpi, 300 dpi, 400 dpi, or 600 dpi.

    Resolution is changed to 300 dpi when File Format is set to "High Compression PDF".

  • Original Image — Specifies the scanning mode. Choose Text+Photo, Photo, Text, or for OCR.

    Original Image is changed from OCR to Text when Color Mode is set to "Auto Color (Color/Gray)", "Full Color" or "Grayscale". These settings are not compatible with OCR.

  • Color Mode — Specifies the color mode. Options are Auto (Color/Gray), Auto (Color/B&W), Full Color, Grayscale, Black & White.
  • Book Original — Specifies the printed page size and binding type. This can be turned Off (the default setting) or set to one of the following values:
    • Ledger-Left
    • Ledger-Right
    • Letter-Left
    • Letter-Right
    • A3-Left
    • A3-Right
    • A4-Left
    • A4-Right
    • B4-Left
    • B4-Right
    • B5-Left
    • B5-Right
    • 8K-Left
    • 8K-Right
  • 2-Sided Original — Specifies the default number of sides to be scanned, either One Side for single sided originals or Two Sides for duplex scanning.
  • Original Orientation — Specifies the orientation of scanned pages, either Top Edge Top or Top Edge Left.
  • Continuous Scan — Set this to On to prompt the user for additional pages after completing each batch of pages. All of the pages will be captured to a single file.
  • Mixed Size — Set this to Same Width for originals that vary in height but not width or to Different Width for originals that may vary width. Leave this set to Off (the default setting) if all pages of a document are the same size.
PDF Encryption Click this button to open the PDF Encryption Settings dialog box to enable and configure encryption for the PDF or High compression PDF file format. For more information, see PDF Encryption Settings.
Dynamic Form
  • Enable Dynamic Form — Standard behavior of a form can be modified by responding to events. Select this check box to allow the workflow server to load scripts. 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).
    • Change form scan settings.
    • Validate field contents before a document is captured by the server.
  • Script path — Specifies path to the .NET script (.vb) that contains code to respond to form and field events. You can click the browse button (...) to locate a file. You can also click the Edit Script button to open a script editor window with basic script code.
  • Edit Script Code — You can click this button to open the script in the Edit Script Contents script editor. If no script is specified in the Script path box, the script editor creates a new script with basic script code. For details about the script editor and the object model used to respond to form and field events, click the help button in the code editor window to view to the Kyocera MFP (HyPAS) Capture Component Scripting help.
  • Raise event when:
    • Form is loaded — Select this check box to cause the form to initiate an event every time the user enters the form.
    • Form is submitted: — Select this check box to cause the form to initiate an event every time the user presses Scan button in the form.
  • Run as device logged in user — Select this check box to run the script under the authentication context of the logged in user. This option should be used only where you need to access a system that requires explicit identification. Whenever possible specify user name and passwords in your script. (You can use available .NET technologies such as encrypting to hide the passwords from view when editing the script.)
    Note: The Run as device logged in user option is only available if the group requires authentication and the configured authentication mode is Windows.

Fields Tab Options

Configure the indexing fields that will be presented to the user. Add a new field by typing in the empty Name box on the last row. Delete a field by clicking in the first column to select the field and then pressing the Delete key on the computer keyboard.

Column 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 label that represents the field in the MFP panel. The field name is used if this column is left empty.
Type Enter the field 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. Click the browse button (...) in the properties column Required field to configure settings for a field type.

The following field types are supported:

  • Text — Allows a user to enter plain text.
  • Numeric — Allows a user to enter numbers (with or without decimal point).
  • Date — Allows a user to enter date and time information in different formats
  • 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.
  • Checkbox — Allows a user to select an option in a form.
  • Tree — Creates a tree choice control in a form.
Required field (Required) A field is required when this check box is selected.
Required field (Properties) Click the browse button (...) to edit additional properties for a particular field type.

Components Tab Options

This tab lists process and route components in the workflow. Configure a component for this form by clicking the browse button (...) in the (Configure) column for a row. This opens the configuration dialog box for the component. You can click the Help button in the configuration dialog box for component instructions.

Field Description
Name Shows the name of a component.
Description Briefly describes what the component does.
Type Shows whether the component is a Process or Route component.
(Configure) Click the browse button (...) to open the settings dialog box for a component. You can click the Help button in the component settings dialog box to view the help for the component.