Web.config Options and Associated Resource File Parameters - Brainware Intelligent Capture - Foundation 23.1 - Foundation 23.1 - Brainware - external

Brainware Intelligent Capture Installation

Platform
Brainware
Product
Brainware Intelligent Capture
Release
Foundation 23.1
License

This topic lists Web.config file options you can modify to enable, disable, or customize features.

For more information about the event options, refer to the Brainware Intelligent Capture Scripting Guide.

Option Description
ADOCommandExecutionTimeOut

Defines the timeout in seconds for executing stored procedures in the database.

Possible values

Any valid integer

AllowAccessToDocumentsToIndexOnly

For more information, see About Navigation to Documents for Indexing.

Possible values

True: Enable navigation to indexable documents only

False: Enable navigation to out-of-workflow documents.

The default value is False.

BatchViewPageSize

Defines the number of batches per page that display in the Web Verifier batch list.

Possible values

Any valid integer

The default value is 20.

client script mode

Defines the parameter to compress the script file that is sent to the browser from the server.

Possible values

Test: Testing or debugging of Web Verifier client side script on browser.

Release: Used in production environment to minimize the file size of the client side script that assists in improving page loading performance.

cacheScripts in the <clientScript> element

Defines the Ext. script caching behavior.

Possible values

True: Used in Ext.Loader.setConfig parameter to enable caching.

False: Used in Ext.Loader.setConfig parameter to disable caching.

ClientSideDocumentCacheSize

Defines the number of pages to cache in the current document.

Possible values

Any valid integer

The default value is 0.

connectionStrings The database connection string.
convertedScriptCaching

Add this configuration in the <project.controller>\<project> node along with mpdDistance and mpdThreshold.

Possible values

True: Enables script conversion caching to reduce initial project loading time.

False: Disables script conversion caching to slow down initial project loading time.

The default value is True.

Note: You also need to set this value to "true" in the Brainware.system.project.exe.config setting to enable script conversion caching.
DialogWidth

Defines the default width, in pixels, of message boxes in Web Verifier.

Possible values

Any valid integer

The default value is 400.

document cacheSize in the <document.controller> element

Specifies the number of workdoc objects to pre-load. This accelerates opening documents within the batch.

You cannot disable pre-loading, but minimize the number of pre-loaded documents to 2, that means one current and one pre-loaded.

Possible values

Any valid integer

The default value is 5.

document maxPagesToPreload in the <document.controller> element

Defines the number of document pages to pre-load.

First and last pages always pre-load, and remaining cache slots fill with pages that have field candidates starting from the lower index.

The following actions take place on page images when a document loads in the background.

  • Pre-load the page
  • Convert the page to PNG
  • Save the page to the database

Possible values

Any valid integer

The default value is 5.

DocumentImageCacheTime

Specifies how long document images are cached in the web browser.

The default value is 20 minutes.

DocumentViewPageSize

Defines the number of folders for Verifier to display in the document tree view when using Show Selected Batch mode. Additional batches display in subsequent navigation panels.

Possible values

Any valid integer

The default value is 10.

EnableProfiler

Whether to enable the Web Verifier profiler.

The profiler collects and records the duration of user actions, such as commands and their internal sub-operations.

Possible values

True / False

The default value is False.

externalGroupIdColumn

Whether the external group ID column displays in Web Verifier.

Possible values

True / False

The default value is False.

externalBatchNameColumn

Whether the external batch name column displays in Web Verifier.

Possible values

True / False

The default value is False.

focusChanged

Whether to enables the focusChanged event for fields in the verification view.

The event triggers when the user presses the Enter key in a field.

The setting has no effect on the FocusChanged event if the <mouseClicked> attribute is set to true.

Possible values

True / False

The default value is True.

HelpLink Links to Web Verifier Help.
httpHeaderBasedSso Controls the single sign-on (SSO) user authentication mode.
login header in the <httpHeaderBasedSso> element Corresponds to the HTTP header attribute name that contains the SSO authenticated user name.

The SSO service uses this attribute to send the user name.

Enabled in the <httpHeaderBasedSso> element

Whether to use the Web Verifier SSO feature.

Possible values

True / False

The default value is False.

sessionHeader in the <httpHeaderBasedSso> element The provider-dependent name of the HTTP header that the SSO service uses to send the user session ID.
inactiveUserTimeout Unchangeable attribute.
Note: This attribute does not control the user session timeout. The <sessionState Timeout> parameter controls the user session timeout.
inspectionTimeOut Unchangeable attribute.
Note: This attribute does not control the user session timeout. The <sessionState Timeout> parameter controls the user session timeout.
instanceName The instanceName value displays in the batch list column “Last Module".
Note: The instanceName value must be unique across all installed Web Verifier servers accessing the same database.
itemCopied

Whether to enable the itemCopied event.

Possible values

True / False

The default value is False.

LanguageDisplayName_[ISO]

Customizes the language display names in the language selection menu.

Replace [ISO] by the three letter directory name in [Installation path]\Brainware Intelligent Capture Web Server\Bin\Resources.

Example for Simplified Chinese

<add key="LanguageDisplayName_ZHO" value="中文简体"/>

level

Defines the tracing level.

Possible values

DEBUG: Trace all information and error messages.

ERROR: Trace error messages only.

loadInSeparateProcess Unchangeable attribute.
mouseClicked

Whether to enable the mouseClicked event on fields and tables in the verification view in indexing mode.

Possible values

True / False

The default value is False.

pathToProjectExe

The location of the Designer program Brainware.System.Project.exe. In typical installations, it is not required to modify this value.

Possible values

A valid non-UNC path ending with a “\”.

The default value is [Installation path]\Brainware Intelligent Capture\Bin\.

ReinitScriptEngineAfterScriptErrors

Whether to recover the script engine after a script error in Web Verifier.

Possible values

True / False

The default value is False.

remoteObjectRenewalTimeout

Defines, in seconds, the time to lapse before renewing remote object references. The lower the number the faster unused objects free memory. Increase this value in the event of errors caused by long-running commands, such as field validation.

Possible values

Any valid integer more than or equal to 30.

The default value is 30.

SavePageImageToDatabase

Specifies if page images extracted from document file blobs needs to be saved back to the database.

Possible values

True / False

timeout in the <sessionState> element

Defines, in minutes, the amount of time a user can be inactive before the session ends.

Specify a value less than that of the SSO session. For details, see the product documentation of your SSO provider.

Possible values

Any valid integer.

The default value is 20.

ShowExtendedErrorMessages

Whether to enable stack trace information for Web Verifier error messages.

Error messages display in the trace log file.

Possible values

True / False

The default value is False.

slogan

A text message that displays on the Web Verifier browser header, such as corporate messages, announcements, or the corporate slogan.

Possible values

The default value is an empty string.

Example

<verifier.webclient>

<company slogan="This is a slogan" />

SYSTEM_LONG_DATE_FORMAT The XML key available in each Brainware.Verifier.WebClient.resx file located in [Installation path]\Brainware Intelligent Capture Web Server\Bin\Resources\[language code] .

The key contains the date pattern for the last access date column in the batch list for the respective language.

To use the default system date pattern, leave the value element empty. The time format uses a 24-hour clock.

For Traditional and Simplified Chinese, use the date format in the following example without any Chinese characters.

Example for Chinese

<data name="SYSTEM_LONG_DATE_FORMAT"

xml:space="preserve">

<value>yyyy-MM-dd, hh:mm:ss</value>

</data>

transactionIdColumn

Whether the transaction ID batch column displays in Web Verifier.

Possible values

True / False

The default value is False.

transactionTypeColumn

Whether the transaction type batch column displays in Web Verifier.

Possible values

True / False

The default value is False.

tabPressed

Whether to enable the tabPressed event on fields and tables in the verification view in indexing mode.

Possible values

True / False

The default value is False.

tableCellSelected

Whether to enable the tableCellSelected event.

Possible values

True / False

The default value is False.

usePath

Possible values

True: Use the pathToProjectExe parameter.

False: Use the current directory instead of the pathToProjectExe parameter.

The default value is True.

waitLoadTimeOut Defines the timeout for the initial loading of the project.exe.