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

    The Cedar Project 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
    • SCBCdrPROJLib Type Definitions

      The SCBCdrPROJLib object provides the following type definitions.

    • SCBCdrProject Methods

      The Cedar Project object provides the following methods.

      • ExtractClassificationField

        In case the ASSA field of the current document class is also the classification field of the project, this method extracts such field.

      • GetHostProperties

        This method allows the user to get information about the current machine, program, and BIC user.

      • GetVerifierProject

        This method returns the Verifier Project.

      • Lock

        This method locks the Project for updating.

      • LogScriptMessage

        This method is obsolete.

      • LogScriptMessageEx

        This method enables the developer to utilize the in-built functionality output messages directly to the core product logs, MMC, or system monitoring notification.

      • MoveDocClass

        This method moves a DocClass specified by its Name to a new ParentDocClass specified by NewParentName.

      • PerformScriptCommandRTS

        This method restarts or stops the Runtime Server through a custom script.

      • ReleaseAllAdsPools

        This method releases the memory used by all ADS pools loaded in memory by RTS or Verifier.

      • ReportLicensingStatus

        This method returns either all license counter information, or just the active license counter information.

      • SecurityUpdateAddUserGroup and SecurityUpdateAddUserGroupPwd

        This method updates or adds the database security credentials. This script call creates or updates the BIC users, roles, and groups.

      • SecurityUpdateCommit

        This method completes the security update process. This script call is required to complete updating the BIC users, roles, and groups.

      • SecurityUpdateStart

        This method instantiates the security update process. This script call is required to begin updating the BIC users, roles, and groups.

      • SecurityUpdateUserParameter

        This method establishes default group settings in Web Verifier for script imported users that do not have the SET role so that they are able to load projects and jobs.

      • ShowValidationTemplates

        This method displays the validation templates and their settings in a given container.

      • Unlock

        This method unlocks the project after updating.

      • UpdateAddressPool

        This method updates the address analysis pool.

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

    • 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

SCBCdrProject Methods

The Cedar Project object provides the following methods.

  • ExtractClassificationField
  • GetHostProperties
  • GetVerifierProject
  • Lock
  • LogScriptMessage
  • LogScriptMessageEx
  • MoveDocClass
  • PerformScriptCommandRTS
  • ReleaseAllAdsPools
  • ReportLicensingStatus
  • SecurityUpdateAddUserGroup and SecurityUpdateAddUserGroupPwd
  • SecurityUpdateCommit
  • SecurityUpdateStart
  • SecurityUpdateUserParameter
  • ShowValidationTemplates
  • Unlock
  • UpdateAddressPool
footer © Hyland Software, Inc. and its affiliates. All rights reserved.