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 the Associative Search Engine (CDRADSLib)
  3. SCBCdrSupExSettings Methods

    The SCBCdrSupExSettings object provides the following methods.

  • 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)
    • SCBCdrSupExSettings Type Definitions

      The SCBCdrSupExSettings object provides the following type definition.

    • SCBCdrSupExSettings Methods

      The SCBCdrSupExSettings object provides the following methods.

      • AddColumn

        This method adds a new column field to the pool.

      • AddFilterAttribute

        This method adds new filters for chosen attribute of the multi-column attribute search. Select attributes from the data source of the Associative Search Engine.

      • AddPhrase

        This method appends a new phrase to the list of phrases to use for the address.

      • ChangeEntry

        This method updates or inserts the content of the entry data to the specified column.

      • ClearFilterAttributes

        This method clears all existing filters of the multi-column attribute filtering.

      • CommitAddEntry

        This method takes effect after execution of StartAddEntry and ChangeEntry.

      • CommitUpdate

        This method closes and save the currently opened pool.

      • GeneratePool

        This method imports the pool from the specified source by the property AutomaticImportMethod.

      • GeneratePoolFromCsvFile

        This method removes the previous pool and generates a new one using CSV file designed in the new format.

      • GeneratePoolFromODBC

        This method removes the previous pool and generates a new one using the ODBC source with the parameters set on the property page.

      • GetClassNameByID

        This method returns the formatted document class name for the pool entry specified by its unique ID.

      • GetEntry

        This method returns the content of a field specified by its index and the column name.

      • GetFormattedValueByID

        This method returns the formatted entry representation for the pool entry specified by its unique ID

      • GetIDByIndex

        This method returns the unique ID of an entry by index.

      • GetIndexById

        This method returns the index of an entry by its unique ID.

      • GetSearchArea

        This method returns an area on the document in which to search.

      • RemovePhrase

        This method removes a phrase from a list of phrases for address analysis specified by its index.

      • SetConnectionPropertiesRMS

        This method sets the URL and connection string for the Remote Matching Service (RMS).

      • SetSearchArea

        This method sets the area on the document in which to search.

      • StartAddEntry

        This method prepares the insertion of a new entry to the associative search pool.

      • StartUpdate

        This method generates and opens a new empty pool, or opens an existing pool for the update.

    • SCBCdrSupExSettings Properties

      The SCBCdrSupExSettings object provides the following property.

    • SCBCdrSupplierExtractionEngine Methods

      The SCBCdrSupplierExtractionEngine object provides the following method.

  • 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

SCBCdrSupExSettings Methods

The SCBCdrSupExSettings object provides the following methods.

  • AddColumn
  • AddFilterAttribute
  • AddPhrase
  • ChangeEntry
  • ClearFilterAttributes
  • CommitAddEntry
  • CommitUpdate
  • GeneratePool
  • GeneratePoolFromCsvFile
  • GeneratePoolFromODBC
  • GetClassNameByID
  • GetEntry
  • GetFormattedValueByID
  • GetIDByIndex
  • GetIndexById
  • GetSearchArea
  • RemovePhrase
  • SetConnectionPropertiesRMS
  • SetSearchArea
  • StartAddEntry
  • StartUpdate
footer © Hyland Software, Inc. and its affiliates. All rights reserved.