Custom Pre-defined Notes

Kofax Capture ships with default pre-defined notes that you can use to add comments to document pages when they are being processed in the Scan, Quality Control, Validation, or Verification modules. You can replace the default notes with your own by creating an XML file and saving it in a folder.

You cannot mix custom and default notes in the same module. To continue using one or more of the default notes, you need to manually put the same text in your custom note XML file. If you do not specify custom notes for a module (in the XML file), the default notes are used.

The XML file must be called ACNotes.xml and placed in the Config subfolder of the Kofax Capture root folder. On standalone systems, this is the same as the root installation folder. In client/server configurations, use the shared folder on the server.

Warning Duplicate notes are not allowed within a single section. If you have the same note in the All section as in one of the other sections, they are counted as duplicates. Duplicate notes may lead to unpredictable behavior when running one of these modules.

Here is an example of an XML file for custom pre-defined notes:

<KofaxCaptureNotes>
   <Modules>
      <Module Name="All" >
         <Notes>
            <Note Name="All: This is note a." />
            <Note Name="All: This is note b." />
            <Note Name="All: This is note c." />
         </Notes>
      </Module>
      <Module Name="Kofax Capture Scan" >
         <Notes>
            <Note Name="Scan: This is note a." />
            <Note Name="Scan: This is note b." />
            <Note Name="Scan: This is note c." />
         </Notes>
      </Module>
      <Module Name=" Kofax Capture Quality Control" >
         <Notes>
            <Note Name="Quality Control: This is note a." />
            <Note Name="Quality Control: This is note b." />
            <Note Name="Quality Control: This is note c." />
         </Notes>
      </Module>
      <Module Name=" Kofax Capture Validation" >
         <Notes>
            <Note Name="Validation: This is note a." />
            <Note Name="Validation: This is note b." />
            <Note Name="Validation: This is note c." />
         </Notes>
      </Module>
      <Module Name=" Kofax Capture Verification" >
         <Notes>
            <Note Name="Verification: This is note a." />
            <Note Name="Verification: This is note b." />
            <Note Name="Verification: This is note c." />
         </Notes>
      </Module>
   </Modules>
</KofaxCaptureNotes>

In the preceding example, there is a section for each module that supports notes. The first section is for All modules. Notes in the All section appear in all four modules. Otherwise, the notes display only in the specified module.

Note If you upgrade Kofax Capture, you need to manually update the custom pre-defined notes file so that the module names are correctly identified as shown in the sample XML file. For example, ensure that the module name for Scan is updated to the current module name Kofax Capture Scan (that is, <Module Name="Kofax Capture Scan">).

Custom pre-defined notes behave exactly like the default notes that ship with Kofax Capture. Specifically, they are sorted alphabetically and the first 10 may be accessed by a single keystroke (hot key). This keystroke is identified by a numeral in parentheses at the end of the note. The numeral is automatically appended by Kofax Capture; you should not include it in the note yourself.

If you decide to customize your own notes:

  • You can create very long notes, but only the first 40 characters or so are visible in the drop-down list. If the note is too long, the remainder of the note is not visible until you place it in the text box by selecting it. Moreover, the hot key is not visible at the end of a very long note.

  • You can have up to 32,000 notes in each module. This limit is based on combining the notes for an individual module with those in the All section. For example, if you had 1000 notes in the All section, you would be limited to 31,000 notes in the other sections.

  • XML element and attribute names are case-sensitive.

  • XML element and attribute names not shown in the preceding example are ignored.