› User interface › Forms › Build forms › Build a Scan create new job form

Build a Scan create new job form

A Scan create new job form creates the job and enables documents to be scanned and associated with the job.

The process initialization variables associated with the process appear as corresponding controls on the generated form. You can open and customize the form in the Design view.

When using the Scan create new job form, you must install the Kofax Web capture service.

You can scan and import the files in the same batch without changing the scanner using the "Import Files" toolbar button that appears on a Scan create new job form at runtime. The "Import Files" button is only available if the current scanner is not for File Import. For a File Import scanner, this button is hidden. The "Import Files" button supports the hotkey ("Ctrl,Ctrl+O").

In case the selected scanner is not File Import, then "Ctrl, O" will scan all files, and "Ctrl,Ctrl+O" will import files.

When configuring the ScanControl on a Scan form or Scan create new job form, the following drill-down properties are available by default. Use these properties to seed a scanner endorser or imprinter with initial values when scanning starts, and retrieve the value when scanning is complete. See the following table for some properties.

Name Type

ScanControl.ImageAddress

A parameter whose value is applied to the scanner driver before scanning is started. The value is automatically refreshed after scanning is finished and represents the “next” image address value.

The value is not defined if it is retrieved before scanning happened.

ScanControl.ImageAddressTemplate

A read-only property that contains a currently configured image address template string. The value of this property is retrieved each time the scanner settings or driver is changed, and after scanning is finished. If the image address is not enabled or not available, the string is empty.

ScanControl.ScanningHostName

A read-only property that contains the hostname of the scanning machine. This property returns the value passed to the onScanReady event by Web Capture Service.

ScanControl.ImprinterFormat

Scanner format. Valid values range from 0 to 2.

Value TWAIN Driver VRS Driver

0 or " " (empty string)

Default value.

Scanner prints single line defined by the ImprinterString property.

Default value.

Scanner prints single line defined by the ImprinterString property.

1

Scanner prints multiple lines defined by the ImprinterString property.

Not applicable. Works as format '0'.

2

Scanner prints a string composed according to the scheme {String}{Index}{Suffix}

Scanner prints a string composed according to the scheme {String}{Index}

ScanControl.ImprinterString

A string value that forms all or just prefix of the resulting printed value depending on the format.

ScanControl.ImprinterIndex

An automatic index that increments by scanner after each scanned page.

This is dependent on the ImprinterFormat used. Also retrieves the final imprinter string used.

Use this property to seed the start index value before a scan and to read its last value after the scan is complete.

ScanControl. ImprinterIndexStep

The increment between index values. Support depends on the scanner.

ScanControl.ImprinterIndexDigits

Maximum allowed digits in the index value.

ScanControl.ImprinterSuffix

A suffix string that is appended to the resulting printed value.

ScanControl.ImprinterRotation

The amount of in-place character rotation. The rotation is in degrees and moves clockwise. TWAIN specification supports values from 0 to 359 although most scanner manufacturers have limited the accepted values to 0, 90, 180, and 270. VRS Elite supports 0, 90, 180, and 270.

ScanControl.ImprinterVerticalOffset

Vertical offset in the specified units.

ScanControl.ImprinterUnits

Units of measure when specifying the vertical offset.

  • 0=inches

  • 1=centimeters

  • 2=picas

  • 3=points

  • 4=twips

  • 5=pixels

  • 6=millimeters

ScanControl.ImprinterFontStyle

The font style for TWAIN scanning defined by a combination of the numeric values of the following bit fields:

  • 1: Normal

  • 2: Bold

  • 4: Italics

  • 8: Large size

  • 16: Small size

For example, if the TWAIN scanner supports a font size composed of bold and large-size font, then the numeric value would be 10, that is 2+8.

VRS Elite does not support this parameter, instead, the font size can be specified in the driver settings and saved to a VRS profile.

Before you generate a Scan create new job form, ensure the following for the process on which the form is being generated:

  • The form has a different name than the document type or folder used.
  • The form is not protected.

  1. Navigate to User interface > Forms.
  2. On the Generate list, select Scan create new job form.

    Alternatively, select Generate scan CNJ form on the context menu of the process for which you want to build the form.

    The Scan create new job form dialog box is displayed.

  3. On the Process list, select the process.

    Ensure the following for the process:

    • It is capture-enabled and contains a classification group. See the Capture properties of a process.

    • It has a different name than the document type or folder used.

    • It is not protected.

    • When you generate a form on a process that exists in GitHub and the process is not checked out to GitHub or checked out with another user, a warning message appears. When you click OK, a Scan create new job form is generated without increasing the process version.

  4. By default, the form name appears in the Form name field as the process name suffixed with Scan. For example, if the process name is LoanApproval, the form name appears as LoanApproval_Scan. However, you can change the name of the form.
  5. By default, the Category is the same category that the process belongs to. However, you can change the category of the form.
  6. By default, Update process with associated form is selected. This means when you add this process (on which the form is created) to a package, the associated Scan create new job form is automatically included in the package if Include items associated with forms is selected during package creation. See Create a package.
  7. Click Generate and save to save the generated form.
    Alternatively, to release the form, click Generate and release.

The generated form has the following format: <ProcessName>_<form type>. For example, LoanApproval_Scan where LoanApproval is the process name and Scan is the form type.

You can only associate a process map with one form, you cannot create a form with a process map that uses another form.

Install the Web capture service

  1. When opening a scan-enabled form for the first time, a message appears prompting you to install the new Web Capture Service.
  2. Click Run.
  3. Select Save As to save a copy of the msi installer. The msi installer can be used for Enterprise central deployment scenarios.
  4. Refresh the page once the installation is complete.

    The View and change settings icon View Scan Settings on the Scan create new job form becomes available after the page is refreshed. The Kofax Web Capture Service icon in the System Tray icons indicates if the service is running.

    When installing through the browser, you must have administrative rights to complete the installation. You need to install the Web capture service only once, and web scanning is enabled across all supported browsers.

Edit a Scan create new job form

  1. Open the Scan create new job form in the Design view.
    The existing properties of the form are displayed in the properties panel. Additionally, the Refresh interval and Override table auto-height settings are also available in the Behaviour group of the Settings tab.
  2. Make changes as needed.
    You can add controls to the initialization variables view (within the ScanControl).
  3. Save the form.

    At runtime, the latest released version of the form loads, and all initialization variables are displayed on the Process tab of the Composite Capture control.