- Info
- Architektur von ABBYY FlexiCapture
-
Verwenden von Skripten in ABBYY FlexiCapture
- Besonderheiten von in .Net-Sprachen geschriebenen Skripten
- Externe Assemblys
- Fenster des Skripteditors
- Objektmodell
-
Skripte für die benutzerdefinierte Anpassung der Verarbeitungsphasen
-
Skripttypen
- Skriptregel
- Autokorrekturskript
- Exportskript
- Benutzerskript (benutzerdefinierte Aktion)
- Skript für Dokumentzusammenstellung
- Benutzerdefiniertes Erkennungsskript
- Phasenregel
- Processing scripts
- Aktualisierungsskript für Datensätze
- Validierungsskripte für Datensätze
- Skript für die Dokumentklassifizierung
-
Event-Handler
- Stapel erstellt
- Batch deleted
- Stapelparameteränderung
- Änderung der Stapelstruktur (Seite hinzugefügt/Seite gelöscht/Dokument hinzugefügt/Dokument gelöscht)
- Seiten verschoben
- Stapel geöffnet/geschlossen
- Stapelintegritätsprüfung
- Dokumentparameter geändert
- Dokumentstatus geändert
- Export abgeschlossen
- Script that is run after rule checks
- Vor der Zuordnung
- Feldüberprüfungsanforderung
-
Objekte
- 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
- Beispielskripte
- Interne Namen der Erkennungssprachen
-
Skripttypen
-
Skripts für die Verarbeitung von Schnittstellenevents
-
Event-Handler
- Bei Schließen des Dokuments
- Bei Schließen des Projekts
- Bei Aktivierung des Dokuments
- Bei Steuerelement des Feldes aktivieren
- Bei Rückgabe von Task
- Bei Benutzerbefehl
- Bei Steuerlement des Felds deaktivieren
- Bei Schließen des Dokuments
- Bei Schließen des Tasks
- Bei Schließen des Projekts
- Bei Bereichsänderung
- Bei Änderung des Taskfenstermodus
- Bei Öffnen des Dokuments
- Bei Taskfenster erstellen
- Bei Taskablehnung
- Bei Bereichssteuerung zeichnen
- Bei Senden des Tasks zur Phase
- Bei Textfeld Überprüfung
-
Objekte
- 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-Handler
- Benutzerskript für Web-Überprüfungsstation
-
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
- Integrieren von Webstationen in Systeme von Drittanbietern
- Konfiguration zusätzlicher Einstellungen und Anpassung von Webstationen
- Custom reports
-
Anhang
- Unterstützte Erkennungssprachen
- Schriftarten für die korrekte Darstellung von Zeichen
- Unterstützte Texttypen
- Unterstützte Barcodetypen
- Unterstützte Eingabeformate
- Exportdateiformate
- Datumsformate
- Alphabet in regulären Ausdrücken
- Schützen von Dokumentdefinitionen und zusätzliche Module
- Glossar
- Patente
- Drittpartei-Technologien
- Technischer Support
- Endbenutzer-Lizenzvertrag (EULA)
Connecting to the Web Services API
To use an API, you must first connect to a Web service. A connection can be established by the "Externer Benutzer" (ID=12) role on the "Benutzerstation" (ID=10) workstation type.
The APIs
You can work with the Web Services API of the ABBYY FlexiCapture 12 Application Server either via SOAP requests, JSON requests or POST requests. The interface to be accessed is determined by the address of the web service:
Method | When to use | Handler value |
SOAP requests | Can be used for any operation | .../API/v1/Soap |
JSON requests | Can be used for any operation | .../API/v1/Json |
POST requests | Can be used to optimize file operations, such as uploading files to the server, uploading files in pieces, getting a check sum, downloading files from the server, etc. | .../FileService/v1 |
Authentication methods
In ABBYY FlexiCapture 12, you can connect to the Web Services API using the standard Windows and Basic authentication methods, as well as using FlexiCapture authentication. The type of authentication is determined by the address of the web service. To use Windows and Basic authentication, include " /API" in the address, and "/FCAuth/API" to use ABBYY FlexiCapture authentication.
Hinweis. Add the suffix in the form of ?Tenant=MyTenantName at the end of the API connection address to specify a tenant.
Examples of Web service addresses with different authentication methods
Windows and Basic authentication | ABBYY FlexiCapture authentication | |
SOAP requests | http:// <ApplicationServer>/FlexiCapture12/Server/API/v1/Soap | http:// <ApplicationServer>/FlexiCapture12/Server/FCAuth/API/v1/Soap |
JSON requests | http:// <ApplicationServer>/FlexiCapture12/Server/API/v1/Json | http:// <ApplicationServer>/FlexiCapture12/Server/FCAuth/API/v1/Json |
POST requests | http:// <ApplicationServer>/FlexiCapture12/Server/FileService/v1 | http:// <ApplicationServer>/FlexiCapture12/Server/FCAuth/FileService/v1 |
4/13/2021 11:12:26 AM