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. 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.

  4. SCBCdrWorkdoc Named Properties

    The SCBCdrWorkdoc object provides the following named properties.

  • 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.

    • 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.

      • SCBCdrWorkdoc Methods

        The SCBCdrWorkdoc object provides the following methods.

      • SCBCdrWorkdoc Properties

        The SCBCdrWorkdoc object provides the following properties.

      • SCBCdrWorkdoc Named Properties

        The SCBCdrWorkdoc object provides the following named properties.

        • BatchID

          This read-only workdoc property allows you to get the Batch ID in which the current workdoc resides.

        • CreationDate

          This read-only workdoc property returns the creation date of the current workdoc. When a document is placed in a new exception batch, the attribute updates to a new date/time stamp.

        • CreationDateAsFileTimeUTC

          This read-only workdoc property returns the UTC creation date of the current workdoc.

        • ExportPdfVersion

          Use this named property in the vos1677603130912.html or wwq1677603130827.html event to specify the PDF format used for export.

        • IgnoreAnalysisFailures

          This is an optional capability to ignore any errors during BIC’s extraction analysis phase. Otherwise, the extraction analysis stops in the middle of field extraction and does not apply processing for other fields and does not trigger further events.

        • PCAppType

          Use this named property to optimize the check amount extraction rates.

        • PCCheckType

          Use this named property to configure the check type recognition.

        • PCDateHint

          Use this named property to configure the reference date for the check date recognition by the Check Analysis Engine. By default, the program uses the system date.

        • PCReReadAlways

          Use this named property to enable re-analyzing the Check Analysis Engine fields. This is helpful if you need to perform Designer or scripting testing, such as for document rotation. It is also helpful if you change one of the Check Analyses Engine settings. By default, re-analysis is switched off.

        • SkipDocumentReprocessingAfterMerging

          By default, when workdocs are combined in the AppendWorkdoc event, the new combined document is classified and extracted after merging. Set this named property in the AppendWorkdoc event to True to skip reprocessing. In this case, the new combined document has the classification and extraction results of pLastWorkdoc after merging.

        • SkipTableCellMassValidation

          This method allows you to optionally activate special "skip table cell mass validation" mode for validation of table cells. By default, Brainware Intelligent Capture uses "mass validation of invalid cells". This means that when the user presses Enter within an invalid cell, all other invalid cells are automatically re-validated by the system. This behavior can lead to performance problems in Brainware Intelligent Capture projects with a large number (1000+) of invalid cells that must each be corrected manually. It may be also unacceptable if validation routines are unavailable for some of the processed transactions and manual review by the Verifier user is required for all cells.

        • XML_ExportCandidates

          This named property controls whether the list of candidates for each field in the workdoc is exported to the XML file. The text, weight and position of each candidate is exported.

        • XML_ExportWordChars

          This named property controls whether the characters composing OCR words in the workdoc are exported to the XML file. The character code, confidence and position of each character are exported.

        • XML_ExportWords

          This named property controls whether the OCR words in the workdoc are exported to the XML file.

  • 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

SCBCdrWorkdoc Named Properties

The SCBCdrWorkdoc object provides the following named properties.

  • BatchID
  • CreationDate
  • CreationDateAsFileTimeUTC
  • ExportPdfVersion
  • IgnoreAnalysisFailures
  • PCAppType
  • PCCheckType
  • PCDateHint
  • PCReReadAlways
  • SkipDocumentReprocessingAfterMerging
  • SkipTableCellMassValidation
  • XML_ExportCandidates
  • XML_ExportWordChars
  • XML_ExportWords
footer © Hyland Software, Inc. and its affiliates. All rights reserved.