Jump to main content

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

Home
Working with the Associative Search Engine (CDRADSLib)
SCBCdrSupExSettings Properties
The SCBCdrSupExSettings object provides the following property.

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.
- SCBCdrSupExSettings Properties
  The SCBCdrSupExSettings object provides the following property.
  - ClassNameFormat
    This property sets or returns the format definition for a document class name.
  - ColumnCount
    This read-only property returns the number of columns of a currently opened pool.
  - ColumnName
    This property sets or returns or sets the name of the column by its index.
  - EnableCandidateEvaluation
    This property sets or returns if a candidate evaluation (so called Second Pass) is permitted.
  - EntryCount
    This read-only property returns the number of entries of the pool.
  - EvalFirstPageOnly
    This property sets or returns if candidate evaluation is performed using the text from first page only.
  - EvalOverSearchAreas
    This property sets or returns if the candidate evaluation is processed using only the text from configured search areas.
  - FieldContentsFormat
    This property sets or returns the format definition for the representation of the engine.
  - FindLocation
    This property sets or returns if address analysis is enabled. If TRUE, the position of the address is found.
  - IdentityColumn
    This property sets or returns the unique ID of a column name.
  - ImportFieldNames
    This property sets or returns if the column names are taken from the first line of a CSV file.
  - ImportFileName
    This property sets or returns if the column names are taken from the first line of a CSV file.
  - ImportFileNameRelative
    This property sets or returns if the name of a CSV file is stored relative to the path of the project file.
  - IsPhraseIncluded
    This property sets or returns if a phrase to find the address is sufficient.
  - IsSearchField
    This property sets or returns if a field is used for an associative search.
  - LastImportTimeStamp
    This read-only property returns the time stamp for the last import.
  - MaxCandidates
    This property sets or returns the maximum number of results of the associative search engine.
  - MinDistance
    This property sets or returns the required minimum distance to the next best candidate for a valid result.
  - MinRelevance
    This property sets or returns the minimum relevance for search results, default value is 0.0.
  - MinThreshold
    This property sets or returns the required minimum value for a valid engine result.
  - NumberKeepLocalCopies
    Use this property to allow additional local copies of the ASE pool for later reuse.
  - ODBCName
    This property sets or returns the name of the ODBC source.
  - Passwords
    This property sets or returns the password of the ODBC source.
  - Phrase
    This property sets or returns the phrase by its index.
  - PhrasesCount
    This read-only property returns the number of phrases used for address analysis.
  - PoolName
    This property sets or returns the name of the associative search pool.
  - PoolPath
    This property sets or returns the name of the path of the associative search pool.
  - PoolPathRelative
    This property sets or returns if the pool is saved relative to the path of the project.
  - PoolVersion
    This property sets or returns the pool version.
  - ProjectPath
    This read-only property returns the path of the project file.
  - SavePoolInternal
    This property sets or returns if a pool is saved within the project file or as separate files.
  - SearchAreaActive
    This property sets or returns if the corresponding search area is active or not.
  - Separator
    This property sets or returns a separator, either a semicolon or comma, that is used for CSV files.
  - SQLQuery
    This property sets or returns an SQL statement used to import ODBC source.
  - UserName
    This property sets or returns the user name required to login in to the ODBC source.
  - VendorTypeColumn
    This property sets or returns the column that defines the vendor type.
- 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 Properties

The SCBCdrSupExSettings object provides the following property.

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