- Introducing ABBYY FlexiCapture
- ABBYY FlexiCapture architecture
-
Using scripts in ABBYY FlexiCapture
- Specifics of scripts written in .Net languages
- External assemblies
- Script editor
- Object model
-
Scripts for customizing processing stages
-
Types of scripts
- Script rule
- Autocorrection script
- Export script
- User script (custom action)
- Document assembly script
- Custom recognition script
- Stage rule
- Processing scripts
- Data set update script
- Data set validation scripts
- Document classification script
-
Event handlers
- Batch created
- Batch deleted
- Batch parameter change
- Batch structure change (page added/page deleted/document added/document deleted)
- Pages moved
- Batch opened/closed
- Batch integrity check
- Document parameter changed
- Document state changed
- Export completed
- Script that is run after rule checks
- Before matching
- Field verification request
-
Objects
- IActionResult
- IAssemblingError
- IAssemblingErrors
- IBatch
- IBatchCheckResults
- IBatchItem
- IBatchItems
- IBatchTypeClassifier
- IBatchTypeClassifierResult
- IBinarizationParams
- IBoxedBoolean
- ICharacterParams
- ICharactersParams
- ICheckmarkGroupValue
- ICheckmarkValue
- IDataSet
- IDataSetQuery
- IDataSetRecord
- IDocument
- IDocuments
- IDocumentExportResults
- IDocumentsExportResults
- IDocumentDefinitionInfo
- IDocumentDefinitionInfoArray
- IEditablePictureObject
- IExportFieldsToRedact
- IExportImageSavingOptions
- IField
- IFieldRegion
- IFieldRegions
- IFields
- IFlexiCaptureTools
- ILocalContrastParams
- IMatchedSectionInfo
- IMatchingInfo
- IPage
- IPageClassificationResult
- IPages
- IPictureObject
- IPictureObjectsInfo
- IPrincipal
- IPrincipals
- IProcessingCallback
- IProject
- IProperties
- IProperty
- IPropertyModificationInfo
- IRecordCheckResult
- IRecordset
- IRect
- IRects
- IRoutingRuleResult
- IRuleContext
- IRuleError
- IRuleErrors
- IRuleTag
- IRuleTags
- IScriptBinaryAttributes
- IScriptDefinitionContext
- ISectionDefinitionInfo
- ISectionDefinitionInfoArray
- IShadowsHighlightsParams
- IStageInfo
- IUserAttachment
- IUserAttachments
- IUserSessionInfo
- IValue
- IVARIANTArray
- TAssemlingErrorType
- TBatchItemType
- TColorToFilter
- TExportFieldType
- TExportType
- TImageCompressionType
- TPageClassificationType
- TPdfAVersion
- TPdfDocumentInfoType
- TPdfTextSearchAreaType
- TPrincipalType
- TProcessingPriority
- TPropertyType
- TRuleErrorType
- TStateType
- Sample scripts
- Internal names of recognition languages
-
Types of scripts
-
Scripts for processing interface events
-
Event handlers
- On Document Closed
- On Project Closed
- On Activate Document
- On Field Control Activate
- On Return From Task
- On User Command
- On Field Control Deactivate
- On Closing Document
- On Task Close
- On Closing Project
- On Region Change
- On Task Window Mode Changed
- On Open Document
- On Task Window Create
- On Task Reject
- On Region Control Draw
- On Task Send To Stage
- On Text Field Validating
-
Objects
- IBoolean
- IBoxedFieldControl
- IDocumentEditor
- IDocumentItem
- IDocumentItems
- IDocumentsCollection
- IDocumentsWindow
- IDrawContext
- IErrorControl
- IErrorControls
- IErrorsWindow
- IFieldControl
- IFieldRegionControl
- IFieldRegionControls
- IFormWindow
- IImageWindow
- IMainMenu
- IMainWindow
- IMenu
- IMenuItem
- IPageControl
- IPageItem
- IPageItems
- IPagesCollection
- IPoint
- ISelection
- IShellRational
- IShellRect
- IShellRects
- ITaskWindow
- ITextEditor
- IToolbar
- IToolbarButton
- IToolbars
- TCommandBarType
- TCommandID
- TDockingType
- TDocumentState
- TErrorType
- TSelectionType
- TTaskWindowMode
- TTextSize
- TUserRole
- TWorkWindowType
-
Event handlers
- User script for Web Verification Station
-
Application Programming Interface (API)
- About the ABBYY FlexiCapture Application Server Web Services API
- Using the Web Services API of the ABBYY FlexiCapture Application Server
-
References
- API Methods
- Data types
- Working with files
- Web Services Mobile API
- Web Services for user account management
- Examples of API Use
- Integrating Web Stations into third-party systems
- Configuring additional settings and customizing Web Stations
- Custom reports
-
Appendix
- Supported recognition languages
- Fonts for correct characters rendering
- Supported text types
- Supported barcode types
- Supported input formats
- Export file formats
- Date formats
- Alphabet used in regular expressions
- Protecting Document Definitions and additional modules
- Glossary
- Patents
- Third-party technologies
- Technical support
- End-User License Agreement (EULA)
Customizing Web Stations
To access the customization view of a Web Station, use the URL below:
http(s)://<server>/Flexicapture12/<station>/WinAuth/Custom
where <server> is the name of a computer where a your web server is installed, <station> is the name of the Web Station, and WinAuth is the Windows authentication parameter.
The customization view is a page with an <iframe> element that opens an embedded version of the corresponding Web Station.
The <iframe> element opens only the workspace of the Web Station, without the header and the footer. The layout of the page can be changed to comply with your company's design guidelines. The page can be additionally customized to include action buttons that will control the contents of <iframe> and web links.
Sample scenarios:
Changing the logo, header, and footer
To change the logo, replace the logo.png file in the customContent directory and, if needed, configure its display in the custom.css file.
Note: You can also edit the page layout by making changes to Index.cshtml.
Changing links to your company website and other resources
You can add links to third-party resources into Index.cshtml.
Changing the Web Station's icon to be shown in the browser window
To change the icon of the Web Station, replace the icon.ico file.
Note: If required, modify the icon parameters and the path to the icon in Index.cshtml.
Changing the name of the page to be shown in the browser window
The name of the page can be set in the <title> tag in the Index.cshtml file.
Hiding the drop-down list of languages
To hide the list of languages, remove the corresponding element from Index.cshtml or hide it by modifying the corresponding style in custom.css.
Note: To set a default language, use the FCUserLang cookie file, where a user interface language can be specified using a standard abbreviation like "en," "ru," etc.
Opening a Web Station
To open a desired Web Station in <iframe>, call one of the following two methods in the onLoad() function in the custom.js file.
- To open the Web Verification Station, call the verify() method.
- To open the Web Scanning Station, call the scan() method.
These methods can also be called from page elements, so as to switch between Web Stations interactively.
Changing the session lifetime
To set the lifetime of an user session, modify the values of the following keys in the web.config file of the corresponding Web Station:
- Set SessionRefreshInterval to 1000.
- Set SessionInactiveLifetimeInMinutes to the preferred time in minutes.
If the user remains inactive for the specified period of time, he/she will be logged out and redirected to the login page.
Since the user page uses embedded versions of Web Stations, you can also use the API messages described in Integrating Web Stations into third-party systems.
02.03.2021 8:10:41