Jump to main content
Brainware Intelligent Capture Scripting
Brainware Intelligent Capture Scripting
 Foundation 23.1
  • Documentation Notice
  • About Scripting
  • ScriptModule Events
  • Cedar DocClass Event Interface
  • Cedar [FieldName] Event Interface
  • Working with Workdoc Objects (SCBCdrWKDOCLib)
  • SCBCdrPROJLib
  • Working with the Associative Search Engine (CDRADSLib)
  • Working with the Check Analysis Engine (SCBCdrParaCheckLib)
  • Working with the Format Analysis Engine (SCBCdrFormatEngine)
  • Working with Format Settings (SCBCdrFormatSettings)
  • Working with Batches (SCBCdrBATCHLib)
  • Comparing Strings (SCBCdrSTRCOMPLib)
  • Working with Images (SCBCroIMGLib)
  • Working with CI Documents (SCBCroCiDocLib)
  • Working with Cairo Projects (SCBCroPROJLib)
  • Working with Collections (SCBCroCollLib)
  • Working with Worktext Objects (SCBCroWorktextLib)
  • Working with Verification Forms (DISTILLERVERIFIERCOMPLib)
  • Printing Documents (SCBCroPrintLib)
  • Error Handling
  • Troubleshooting Scripting Issues
  • Encryption
  1. Home
  2. Working with Workdoc Objects (SCBCdrWKDOCLib)
  3. SCBCdrCandidate

    Cedar candidates are generated during the analysis step and are representing possible results of a field.

  4. SCBCdrCandidate Methods

    The SCBCdrField object provides the following methods.

  • Documentation Notice
  • About Scripting
  • ScriptModule Events
  • Cedar DocClass Event Interface
  • Cedar [FieldName] Event Interface
  • Working with Workdoc Objects (SCBCdrWKDOCLib)
    • SCBCdrWKDOCLib Type Definitions

      The SCBCdrWKDOCLib object provides the following type definitions.

    • SCBCdrCandidate

      Cedar candidates are generated during the analysis step and are representing possible results of a field.

      • SCBCdrCandidate Methods

        The SCBCdrField object provides the following methods.

        • CopyToField

          This method copies all required properties from the candidate to the field result.

        • RemoveAttractor

          This method removes the attractor specified by index.

      • SCBCdrCandidate Properties

        The SCBCdrField object provides the following properties.

    • SCBCdrDocPage

      The SCBCdrDocPage object represents a single DocPage within a workdoc.

    • SCBCdrEmailProperties

      When importing a MSG file into a workdoc, the most important properties of the email are stored in the workdoc and available in the custom script through the "ISCBCdrEmailProperties" interface that can be queried from the SCBCdrWorkdoc interface.

    • SCBCdrField

      This object contains the evaluated data to extract from the document.

    • SCBCdrFields

      This is a collection of all field objects contained in the current WorkDoc object.

    • SCBCdrFolder

      A folder can represent an array of workdocs within a batch. A folder can contain one or more workdocs. During classification and extraction, you can access all workdocs of the same folder from within a script.

    • SCBCdrTable

      The Cedar table object represents a logical table in a document assigned to a Cedar field of a workdoc.

    • SCBCdrTextblock

      This object represents a TextBlock on a document. A TextBlock can contain one or more lines.

    • SCBCdrWord

      This object represents a textual word of a document.

    • SCBCdrWorkdoc

      The Cedar workdoc object stores all data of one document. The amount of data grows during the processing steps of OCR, classification and extraction.

  • SCBCdrPROJLib
  • Working with the Associative Search Engine (CDRADSLib)
  • Working with the Check Analysis Engine (SCBCdrParaCheckLib)
  • Working with the Format Analysis Engine (SCBCdrFormatEngine)
  • Working with Format Settings (SCBCdrFormatSettings)
  • Working with Batches (SCBCdrBATCHLib)
  • Comparing Strings (SCBCdrSTRCOMPLib)
  • Working with Images (SCBCroIMGLib)
  • Working with CI Documents (SCBCroCiDocLib)
  • Working with Cairo Projects (SCBCroPROJLib)
  • Working with Collections (SCBCroCollLib)
  • Working with Worktext Objects (SCBCroWorktextLib)
  • Working with Verification Forms (DISTILLERVERIFIERCOMPLib)
  • Printing Documents (SCBCroPrintLib)
  • Error Handling
  • Troubleshooting Scripting Issues
  • Encryption

SCBCdrCandidate Methods

The SCBCdrField object provides the following methods.

  • CopyToField
  • RemoveAttractor
footer © Hyland Software, Inc. and its affiliates. All rights reserved.