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. SCBCdrPROJLib
  3. SCBCdrDocClass

    A Cedar DocClass object represents a single document class within a Cedar project class hierarchy.

  4. SCBCdrDocClass Properties

    The SCBCdrDocClass object provides the following methods and properties.

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

      The SCBCdrPROJLib object provides the following type definitions.

    • SCBCdrProject Methods

      The Cedar Project object provides the following methods.

    • SCBCdrProject Properties

      The Cedar Project object provides the following properties.

    • SCBCdrDocClass

      A Cedar DocClass object represents a single document class within a Cedar project class hierarchy.

      • SCBCdrDocClass Methods

        The SCBCdrDocClass object provides the following methods and properties.

      • SCBCdrDocClass Properties

        The SCBCdrDocClass object provides the following methods and properties.

        • ClassificationField

          Use this property to set or return the name of the field used for the classification.

        • ClassificationRedirection

          This property to set or return the name of the target DocClass.

        • ClassifySettings

          This read-only property returns a collection of chosen classification engines and their settings for this DocClass.

        • DerivedDocClasses

          This read-only property returns a collection of all DocClasses derived directly from this DocClass.

        • DisplayName

          This property sets or returns the display name of the DocClass currently not used. If the property is empty, the DocClass name is used.

        • Fields

          This read-only property provides access to FieldDefs of a DocClass.

        • ForceSubtreeClassification

          This property sets or returns if the classification to the subtree of this DocClass is forced.

        • ForceValidation

          This property sets or returns the Force Validation mode.

        • Hidden

          This property sets or returns whether the DocClass is visible in the Project designer.

        • ManualTableTrainingMode

          This property sets or returns the option for manual table extraction training mode.

        • Name

          This property sets or returns the name of the Document Class

        • Page

          This read-only property returns the Page object of this DocClass with all defined zones and their OCR settings.

        • Parent

          This read-only property returns the parent DocClass of the actual DocClass.

        • SubtreeClsMinDist

          This property sets or returns the minimal distance to the classification weight of the derived DocClasses.

        • SubtreeClsMinWeight

          This property sets or returns the minimal classification weight of the derived DocClasses.

        • UseDerivedValidation

          This property sets or returns a Boolean value, when derived validation rules are used.

        • ValidationSettingsColl

          This read-only property returns a collection of all activated validation engines

        • ValidationTemplateName

          This property sets or returns the name of the validation template.

        • ValidClassificationResult

          This property sets or returns if this DocClass is a valid classification result or if it is omitted for classification.

        • VisibleInCorrection

          This property sets or returns if a project class is available for classification. You can modify this property prior to classification correction for a Verifier by setting the property to TRUE if the class is available for classification correction, or FALSE if the class is unavailable for classification correction.

    • SCBCdrDocClasses

      This collection contains all defined DocClass objects of the Cedar project.

    • SCBCdrFieldDef

      A Cedar FieldDef object represents the definition of a single FieldDef inside a Cedar DocClass

    • SCBCdrFieldDefs

      This collection contains all defined FieldDef objects of a single DocClass.

    • SCBCdrLicenseInfoAccess

      The Licensing Information Access object allows direct retrieval to the active licensing object. You can directly query any licensing component in a custom script.

    • SCBCdrSettings

      The Cedar Settings object stores arbitrary strings for usage in script.

    • SCBCdrScriptModule

      This is a global object at the project level. All script module events occurred at project level belong to this object.

    • SCBCdrScriptAccess

      Brainware Intelligent Capture provides a public interface "SCBCdrScriptAccess" for external access to the project and class level custom script pages. The interface can be queried from the main "SCBCdrProject" interface available in Brainware Intelligent Capture custom script. Using this interface it is possible to get, modify and dump project and class level scripts.

  • 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

SCBCdrDocClass Properties

The SCBCdrDocClass object provides the following methods and properties.

  • ClassificationField
  • ClassificationRedirection
  • ClassifySettings
  • DerivedDocClasses
  • DisplayName
  • Fields
  • ForceSubtreeClassification
  • ForceValidation
  • Hidden
  • ManualTableTrainingMode
  • Name
  • Page
  • Parent
  • SubtreeClsMinDist
  • SubtreeClsMinWeight
  • UseDerivedValidation
  • ValidationSettingsColl
  • ValidationTemplateName
  • ValidClassificationResult
  • VisibleInCorrection
footer © Hyland Software, Inc. and its affiliates. All rights reserved.