› 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 a job and enables the 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 the files.

  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.

When you open the generated Scan create new job form and configure the action such as .Net method or Display rule, the drill-down properties are available by default for a form control for mapping to the parameters. To seed a scanner endorser or imprinter with initial values when scanning starts, and retrieve the value when scanning is complete, some additional drill-down properties are also available by default. See Drill-down properties of Capture Composite controls.

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. The properties are same as properties of a Capture composite control. See Properties of a Capture Composite control. The following properties are not available for a Scan create new job form: Show InPlace Editor, Show complete and take next, Show complete, Show document confidence, Auto complete behaviour, Navigate to next error, Activity display text, Change document type, and Activity variant.
  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.