Show / Hide Table of Contents
  • BC HTML Api reference
    • html-api
      • AnnotationArrowOrientation
      • AnnotationTextAlignment
      • AnnotationTextFontFamily
      • BarcodeOrientation
      • BarcodeThresholdMode
      • BarcodeType
      • BatchEnums
        • Mode
        • Queue
      • CallContext
      • DbClient
      • DbServer
      • FileMimeType
      • FileType
      • IAnnotation
      • IAnnotationProperties
      • IApplication
      • IBarcodeData
      • IBaseControl
      • IBatch
      • IBatchClass
      • IButton
      • ICheckBox
      • IComboBox
      • ICustomThemeConfig
      • IDocument
      • IDocumentClass
      • IField
      • IFieldValidation
      • IFileInfo
      • IFolder
      • IFolderClass
      • IFormType
      • IGroup
      • IIndexClass
      • IITModule
      • IJob
      • ILabel
      • ILicenseGroup
      • IListItem
      • IListView
      • ImageColorMode
      • ImageOperationType
      • INode
      • INodeComment
      • INodeReviewComment
      • INuanceEngineConfig
      • IOCRConfiguration
      • IPage
        • Side
      • IRadioButton
      • IRecognitionProfile
      • IRectangle
      • IRegexValidation
      • IScanProfile
      • ITable
      • ITabView
      • ITextBox
      • IthConfig
      • ITitledPanel
      • IUser
      • LevelName
      • NodeReviewStatus
      • NuanceEngine
      • NuanceLanguage
      • NuanceMode
      • PageSideMode
      • RecognitionEngine
      • RpcService
      • ScanService
      • ScanSource
      • ScriptActionType
      • ScriptResultConsts
      • ScriptResultProp
      • UnloadReason

Interface IthConfig

The configuration of TC HTML.

Properties list

CCTCacheSizeMB CCTUrl CheckUrl CustomLogo DefaultImageOperationValues DisableADFDetectionForOOP DisableOOPHandling InitialCCTDetectDelayMs javascriptFilesBaseUrl LogToServer LogToServerContextID MaxConcurrentServerOps PromptForCCTDownload RendCacheSizeMB RequireCCTOnStartup ReuseCCTSession ScanFromFlatbedIfADFIsOOP ShowStackTraces srvBaseUrl srvStaticFilesBaseUrl SupportsSearch ThemeConfiguration UseCCT UseCheckScanning

Properties

CCTCacheSizeMB

Cache size in MB for images in HTML Client memory while scanning; used only for 8-bit images. Set to zero (0) to disable cache.

Declaration
CCTCacheSizeMB?: number;
Property Value
Type Description
number

CCTUrl

This is the OpenText/Captiva cloud toolkit runtime re-distributable. This is relative to ITH root.

Declaration
CCTUrl?: string;
Property Value
Type Description
string

CheckUrl

The WebSocket URL for SilverBullet Ranger Remote service.

Declaration
CheckUrl?: string;
Property Value
Type Description
string

CustomLogo

URL of an image to be used as a custom logo. It can be relative or absolute and the formats supported are PNG and SVG.

Declaration
CustomLogo?: string;
Property Value
Type Description
string

DefaultImageOperationValues

Default values for image operation actions.

These values will be applied as defaults in the GUI controls, as well as in cases where operations must be applied automatically (view AutoRasterizeWhenNeeded config).

Defaults are:

  • Rasterization.dpi = 300
  • Rasterization.maxEdgeSize = 0
  • Rasterization.binaryDithering = true
  • Rasterization.colorMode = COLOR
  • Rasterization.pageSize = COLOR
  • Rasterization.pageOrientation = COLOR
  • Brightness = 0
  • Contrast = 0

Declaration
DefaultImageOperationValues?: {
        Rasterization?: {
            dpi: 72 | 96 | 100 | 150 | 200 | 250 | 300 | 400 | 600;
            maxEdgeSize: number;
            binaryDithering: boolean;
            colorMode: "COLOR" | "GRAY" | "BINARY";
            pageSize: "LETTER" | "LEGAL" | "A4" | "LEDGER";
            pageOrientation: "PORTRAIT" | "LANDSCAPE";
        };
        Brightness?: number;
        Contrast?: number;
        HoleFill?: FillPunchHolesOptions;
    };
Property Value
Type Description
{ Rasterization?: { dpi: 72 | 96 | 100 | 150 | 200 | 250 | 300 | 400 | 600; maxEdgeSize: number; binaryDithering: boolean; colorMode: "COLOR" | "GRAY" | "BINARY"; pageSize: "LETTER" | "LEGAL" | "A4" | "LEDGER"; pageOrientation: "PORTRAIT" | "LANDSCAPE"; }; Brightness?: number; Contrast?: number; HoleFill?: FillPunchHolesOptions; }

DisableADFDetectionForOOP

Whether to disable the automatic detection of ADF (Automatic Document Feeder) for the reason of determining whether the out-of-paper handling should be disabled. The out-of-paper handling fails to perform properly with scanners that have both a flatbed and ADF. In order to disable the OOP handling for those scanners we need to detect whether the ADF is really used or not; yet some scanners may fail to report that properly. If this happens, the OOP is permanently disabled, something that is not desirable in most cases. Setting this to true allows the OOP handling to operate as expected.

Declaration
DisableADFDetectionForOOP?: boolean;
Property Value
Type Description
boolean

DisableOOPHandling

Whether to disable automatic handling of out-of-paper when scanning. Default value is true. Set it to false to have the scanner stop when it goes out of paper.

Declaration
DisableOOPHandling?: boolean;
Property Value
Type Description
boolean

InitialCCTDetectDelayMs

Number on milliseconds that are allowed to detect whether CCT service is running or not before displaying a blocking window on top of ITH that prompts the user to download it. This parameter only makes sense if RequireCCTOnStartup is true. default: 3000

Declaration
InitialCCTDetectDelayMs?: number;
Property Value
Type Description
number

javascriptFilesBaseUrl

The URL of the application javascript files. Default: 'http://localhost:8199/client-html/' This setting must be set in cases where the application is unable to determine it automatically.

Declaration
javascriptFilesBaseUrl?: string;
Property Value
Type Description
string

LogToServer

Whether client logging is directed to server or not. default: true;

Declaration
LogToServer?: boolean;
Property Value
Type Description
boolean

LogToServerContextID

This is a string that is sent to the server when remote logging is enabled. It is used in the server's log4j setup to distinguish logging arriving from clients. If you leave this empty it defaults to the client internal IP address. In production environment it may make sense to set this to a user-id or another context value that may help in identifying the browser/user/session that is sending the logging information.

Declaration
LogToServerContextID?: string;
Property Value
Type Description
string

MaxConcurrentServerOps

This is the maximum number of concurrent RPC requests allowed, e.g. invocations of dispatch.invokeOnServer().

Declaration
MaxConcurrentServerOps?: number;
Property Value
Type Description
number

PromptForCCTDownload

Whether to prompt the user to download and install CCT if not found during initialization. If RequireCCTOnStartup is true, the user will get offered a download link of CCT on the CCT required prompt. If RequireCCTOnStartup is false and PromptForCCTDownload is true then a notification is being displayed to the user with the download link of CCT. default: false If RequireCCTOnStartup is true but PromptForCCTDownload is false then the application will block if it doesn't detect CCT but it will not offer a link to download it. Use this configuration if you require CCT but want to control when and how the users install CCT in their local machines or when users do not have installation permissions.

Declaration
PromptForCCTDownload?: boolean;
Property Value
Type Description
boolean

RendCacheSizeMB

Cache size in MB for images/rendition in HTML Client memory; default is 100.

Declaration
RendCacheSizeMB?: number;
Property Value
Type Description
number

RequireCCTOnStartup

Whether the CCT server should be detected and running during initialization. If true, then ITH will block until CCT becomes available. If CCT becomes unavailable at a later point (e.g. after startup), ITH will continue to work. This flag only sets the initial state. default: false

Declaration
RequireCCTOnStartup?: boolean;
Property Value
Type Description
boolean

ReuseCCTSession

Whether to reuse an established CCT session or not.

If true, then on initialization the application will attempt to reuse an existing CCT session. This allows for avoiding reloading a scanner and its settings cutting down the time required for a first scan. This also means that a CCT session will be kept alive for 5 minutes even after the application has unloaded, thus locking the scanner and preventing use from non CCT applications.

If false, then on initialization the application creates a new CCT session destroying any existing ones. It also ends the CCT session upon unloading, releasing the scanner as well. In case a CCT session is not properly unloaded, it will be terminated by CCT itself after 1 minute of non-use.

Default: true

Declaration
ReuseCCTSession?: boolean;
Property Value
Type Description
boolean

ScanFromFlatbedIfADFIsOOP

If the scanner has both ADF and Flatbed, this option will trigger attempting to scan from the Flatbed if the ADF is out of paper on scan start.

Declaration
ScanFromFlatbedIfADFIsOOP?: boolean;
Property Value
Type Description
boolean

ShowStackTraces

Use this if stack traces should be shown in error dialogs.

Defaults to true.

Declaration
ShowStackTraces?: boolean;
Property Value
Type Description
boolean

srvBaseUrl

The URL of the ITH server. Default: 'http://localhost:8199/html-service/rest/v1.0/'

Declaration
srvBaseUrl?: string;
Property Value
Type Description
string

srvStaticFilesBaseUrl

The URL of the static files. Default: 'http://localhost:8199/client-html/static/'

Declaration
srvStaticFilesBaseUrl?: string;
Property Value
Type Description
string

SupportsSearch

Responsible for toggling the Search toolbar icon and functionality.

Declaration
SupportsSearch?: boolean;
Property Value
Type Description
boolean

ThemeConfiguration

Theme Configuration.

ITH is using LESS (http://lesscss.org/) to generate the final CSS that styles the app. This configuration allows to override some LESS variables which will result in changing the colors and look and feel.

Two variables are available for customization, the *base* and the *accent* which are color definitions for the theme.

*base*: color definition is the most basic color that is being used in almost all elements that have color.

*accent*: used to give emphasis to areas/elements that require attention.

The value of this configuration property must be a plain javascript object that includes properties of key-value pair of each definition to customize. For example, to change the base color to green and the accent to yellow configure it as follows:

ThemeConfiguration: { base: "#007700", accent: "#ffff00" }

Declaration
ThemeConfiguration?: ICustomThemeConfig;
Property Value
Type Description
ICustomThemeConfig

UseCCT

Whether ITH will use the CCT or not. If true, ITH will attempt to connect to CCT on startup and will also provide and indicator to the user about the connection status. If false, then no indication whatsoever is given to the user. ITH works totally independently

Declaration
UseCCT?: boolean;
Property Value
Type Description
boolean

UseCheckScanning

Whether ITH will use the RangerManager or not. If true, ITH will attempt to connect to RangerManager on startup and will also provide and indicator to the user about the connection status. If false, then no indication whatsoever is given to the user. ITH works totally independently

Declaration
UseCheckScanning?: boolean;
Property Value
Type Description
boolean
Back to top Generated by DocFX