Select Page

Flexi capture Sync Tool

FlexiCapture Cloud enables organizations to accelerate digital transformation by complementing their automation systems with new and advanced cognitive capabilities that liberate the intelligence

WiseTREND DataCapture.cloud Sync Tool


ABBYY FlexiCapture Cloud Sync Tool


ABBYY
FlexiCapture Distributed Edition Sync Tool


+


FCAdminTools UI Tool


Documentation & Release Notes


Latest version download links:

Microsoft Windows OS Contact WiseTREND

Mac OS

Current version: 1.0.21.0

Contact WiseTREND

Please see Installation Instructions below

Last updated: October 29, 2020

Latest build: 1.0.24.0

 

Overview

DataCapture.cloud Sync Tool provides a secure seamless connection between your local environment to the FlexiCapture processing platform running either on-premise or in the Cloud.  This application runs as NT Service 24/7 and can perform the following operations:

  • Upload images from local environment to Cloud for processing
  • Download processing results from Cloud to local environment after processing
    • Download Exception results from Cloud to local environment (for Unattended workflows)
  • Update and synchronize local data/records to Cloud Data Sets (for some projects that support/require data sets)
  • Provide real-time user notificaiotns via e-mail and SMS/text messaging

User Interface (UI) is provided to configure this service.

 

Installation Instructions

 

Windows

During the installation, if you are presented with Windows protection screen, click on More info

 

Then proceed to Run Anyway

MacOs

 

1) Install the package cloud.datacapture.synctooldaemon.pkg

2) Run installation script as root: 

sudo Users/Shared/SyncTool/install_daemon.sh

3) Configuration is located in Users/Shared/SyncTool/config.json. You can change it manually or the SyncTool on Windows to set up the configuration and then copy the configuration file to Users/Shared/SyncTool/

Note: Please note that Windows version uses encryption to store some of the config parameters:

  • Datacapture.cloud username and password
  • Database connection string, table, username and password
  • NotifyUrl authentication information

This encryption mechanism is not available on Mac, because of technical difficulties porting the UI client.

This means – if you copy the configuration from another machine to a Mac, after creating it on Windows, you need to change the encrypted values to the actual values in config.

 

4) after changing the configuration please restart the service with

sudo Users/Shared/SyncTool/restart_daemon.sh

Login Screen

Login initial startup screen connects Sync Tool to your either:

  • WiseTREND DataCapture.cloud (https://portal.DataCapture.cloud) account
  • ABBYY FlexiCapture Cloud account
  • ABBYY FlexiCapture Distributed Edition running on your local/hosted server

 

A valid DataCapture.cloud Portal (https://portal.DataCapture.cloud) account and Sync Tool license subscription is required for a successful connection to any supported FlexiCapture, otherwise this message will be presented:

 

Tenant field should be kept as <default> for regular DataCapture.cloud subscriptions.  Tenant field should be changed only if WiseTREND Team provided you with a specific tenant value linked to your account.

Main Window

Start Service / Stop service – starts / stops the service.

 

Save changes and restart service – after any change in the Main Window, this button should be clicked to restart the service and activate current settings.

 

Save Settings / Load Settings – provides options to save / load all settings for backup /restore, for communicating with our Support team, or for transferring to a different computer.

 

View recent log – shows last activities in logging.

 

Gather report for Support – generates a set of materials for assisting Support with troubleshooting specific cases.

 

Documentation Online – shortcut to this documentation document.

 

Select project – selector of a specific project on DataCapture.cloud platform to which automatic actions are assigned in the main window below.

 

Add new task – selector of which task to add to the selected project.

 

Sync Tool runs as an automated background service with 24/7 availability.  Control Panel is the interactive User Interface (UI) to control and monitor the background service.  When any changes are made through the Control Panel, service restart is required for new changes to take effect.

Add new task

Sync Tool supports three (3) automated task types: 

Task Name Task Description / purpose Data flow direction
Upload/Import to Cloud import of images/PDFs into processing local ► DataCapture.cloud
Download from Cloud downloading of data and processed images/PDFs after processing local ◄ DataCapture.cloud 
Dataset update upload and update of records in a project (if supported or needed for a particular project) local ► DataCapture.cloud
Send notification Automated notification(s) to Admin(s) and User(s) via e-mail and SMS/text messaging local ► Admin/User

Upload/Import to Cloud

Import folder – select a local or network folder as source of images.

Filemask – specifies the type of file(s) to be imported from the input folder.

Check the folder every – specifies the interval at which the input folder will be checked.

NOTE: ALL files matching the filemask will be picked up at each interval and loaded into ONE processing batch in a project

Number of files to add to a batch – specifies how batches should be structured and what quantities of files will be loaded

Document separation 

Automatic – let the software split all input files in the same batch into pages and auto-assemble and auto-apply appropriate document definitions.

1 File = 1 Document – provides processing software with pre-assembled documents, so classification of document type happens without document assembly.

Verification enabled

Yes – conventional With User Verification workflow.  Users are expected to use either Web Verification or Windows-based Verification Station to review both Verification and Exception queues.

No – completely automated/unattended process, skips Verification stage, Exceptions still need to be reviewed, users are expected to use either Web Verification or Windows-based Verification Station to review Exception queues.

If image upload is successful  – specifies what to do with successfully imported images, archive them into other sub-folders or delete them automatically.

Download from Cloud

Download to – select a local or network folder to download result data and images.

Do not export batches older than – download from batches older than this setting will be skipped.

Download each document only once – if enabled, Sync Tool will download each result only one.  

NOTE: Sync Tool stores the list of downloaded batches in a user-friendly JSON file located in the same root folder as the download location.  This JSON file can be edited/changed by hand if re-download of any specific batch is needed.

If disabled, Sync Tool will try to synchronize Local <-> Cloud storage using the list of folders available in the download folder.  This may cause multiple re-downloads if results from local storage are removed before they are removed from Cloud.

Download these output formats – specify which file formats to download
NOTE: Not all formats are available in all projects, so some settings here may be ignored.

Download Exceptions queue – this option will write out batches in Exceptions stage instead of keeping them in Exceptions queue for operator’s review.

Depending on your project’s configuration and “Process whole batches” setting of the project (on server side) being turned ON or OFF, and workflow type being “With Verification” or “Automatic/Unattended” this option will operate in the following ways.

  • Processed whole batches:
    • when turned ON in the project configuration (the most common and default operation method), this operation method means the entire batch moves through stages as a whole batch.  If there is one document in a batch that reaches Exception status, or if there is at least one <unknown> document, the whole batch goes into Exception stage.  This mode is useful when you need the documents within one batch being kept together for various reasons.  
  • when turned OFF in the project configuration (upon special request, useful for single-page documents or for pre-assembled 1 file = 1 document processing), this operation method means each document moves through stages independently from the batch status.  If there is one document in a batch that reaches Exception status, or if there is at least one <unknown> document, only that document goes into Exception stage while other good documents continue processing into Export as usual.  This mode is useful when you need the documents within one batch being kept together for various reasons.  

Workflow type “With Verification” or “Automatic/Unattended

See explanation in “Verification enabled” section above

Processed whole batches Workflow type Details of operation Example
ON With Verification

This function to export Exception batches is not available.  

 

By workflow design, Exception batches remain in the Exception queue for operator review.  

 

For exact operation, please see explanation of “Processed whole batches” = ON above.

Batch with 5 documents:

– 3 good documents

– 2 documents reach Exception or are <unknown> doc type

 

Result (in this order)t: entire batch with 5 documents proceeds to Exception queue for operator review.  Exceptions are handled (resolved or removed) and remaining documents can proceed to Export.

OFF With Verification

This function to export Exception batches is not available.  

 

By workflow design, Exception documents remain in the Exception queue for operator review.  

 

For exact operation, please see explanation of “Processed whole batches” = OFF above.

Batch with 5 documents:

– 3 good documents

– 2 documents reach Exception or are <unknown> doc type

 

Result (in this order): 3 good documents are exported and reach Processed status.  Entire batch with 5 documents proceeds to Exception queue for operator review.  2 exceptions are handled (resolved or removed) and remaining 2 documents can proceed to Export. Processed documents are not re-exported.

ON Automatic/Unattended

– A sub-folder is created with the sub-folder name = batch name, and each Exception document (one or multiple per batch) will be saved into this sub-folder.  

– The name and type of the document will be the same as input filename, or an automatically-generated name if original name is not available.  

– Good documents proceed to Export and become Processed status.

– For each Exception document, a TXT file with matching filename and TXT extension will be created next to the document.  This TXT file contains the cause of the exception, if available.

 

Internal note: this process is achieved by writing out Exception documents, deleting them from a batch, and routing the whole batch with remaining good documents into Export.

 

Important note: deletion during processing happens.  Exception documents will not be visible in Processed batches.

Batch with 5 documents:

– 3 good documents

– 2 documents reach Exception or are <unknown> doc type

 

Result (in this order): 2 documents proceed to Exception and get written out.  Exception output contains 2 image files + 2 TXT files with exception explanations.  3 documents proceed to Export and become Processed status.  

OFF Automatic/Unattended

– A sub-folder is created with the sub-folder name = batch name, and each Exception document (one or multiple per batch) will be saved into this sub-folder.  

– The name and type of the document will be the same as input filename, or an automatically-generated name if original name is not available.  

– Good documents proceed to Export and become Processed status.

– For each Exception document, a TXT file with matching filename and TXT extension will be created next to the document.  This TXT file contains the cause of the exception, if available.

Batch with 5 documents:

– 3 good documents

– 2 documents reach Exception or are <unknown> doc type

 

Result (in this order): 3 documents proceed to Export and become Processed status.  2 documents proceed to Exception and get written out.  Exception output contains 2 image files + 2 TXT files with exception explanations.

Actions to take after download

  • Delete successfully processed document from server after download

  • Delete document with processing issues from server after download
  • Notify url Action: Enabling this option will send POST request to the specified URL with document data.

In case of success with the following Json data.

In case of error the following Json data will be sent.

Node Description
ProjectName Name of the processing scenario
PathToExportedFolder Path to the folder where the document was downloaded.
OriginalFileName Name of the original file
BatchId Unique Id of the batch
DocumentId Index of the document inside the batch
Success Whether the document was processed successfully
DocumentData

NOTE: JSON export must be enabled in DataCapture.cloud project to include JSON document data in the body.  If JSON is not enabled as output format, then this section will be empty and no document-specific data will be included.

 

In case of success it contains an array of the document sections. The actual structure of the section and fields depends on the project, template and fields.

In case when document is not exported or document is on exceptions, it contains the error description (see sample)

ExportedFiles

Array of pairs {filename, file content in base 64}

 

sample:

{FileName: “exportedFile.pdf”, FileDataBase64String : “dGhpcyBpcyBmaWxlIGNvbnRlbnQ=”}

DocumentData.ErrorDescription Description of the error for te document
DocumentData.ErrorTypes List of string – error types present in document
DocumentData.PagesErrors List of page error objects
DocumentData.PagesError.PageNumber Number of the page with error
DocumentData.PagesError.PagesError Page error description

  • Execute .bat file

Bat file will run once for each selected file format document was exported to selected plus for each file on exception (if selected)

The following arguments will be passed to the batch file:

%1 full path to the exported file or to the error description file (.json) in case of exceptions queue export

%2 success status = True/False

%3 Project name

%4 Batch name

%5 index of the document in batch

Here is the sample .bat file

@echo Full path to the exported file or to the error description file (.json) in case of exceptions queue export: 

@echo %1

@echo Success status:

@echo %2

@echo Project name:

@echo %3

@echo Batch name:

@echo %4

@echo Index of the document in batch:

@echo %5

pause

NOTE: We currently do not support the spaces in the bat file path or name.

  • Delete downloaded files after – specifies the number of days how long processed batches/documents will be stored

Dataset Update

Sync Tool can update/synchronize data stored in local Databases (ODBC) or CSV files to datasets in the cloud.

  • Database
  • CSV File

Send notification

Notifications are available by e-mail and SMS/text messages and can be sent at different intervals and with different level of details.

Notify Administrators about system-level warnings and errors

  • Setup e-mail notifications

  • Setup SMS-text messaging

Minimal logging level choice indicates the level of details to be included in the notification.  Available options are listed from more detailed (Verbose) to less detailed (Fatal):

Frequency indicates how frequently this e-mail will receive notifications.  Available options are:

Notify Users about process-level events

  • Setup e-mail notifications

  • Setup SMS-text messaging

Active hours: User-level notifications can be setup to be sent during specific days of week and hours of the day, providing an option to notify/involve Users only during their working hours.

Project stage choice indicates which FlexiCapture queue/stage is monitored by this specific notification.  Available options are Verification & Exception, but other custom stages may appear in the selection depending on the Project’s configuration.

 

Frequency indicates how frequently this e-mail will receive notifications.  Available options are:

Future enhancements & Known issues

 

Redesigning how the Sync Tool will install and run with respect to administrator permissions

Support the spaces in the BAT file path or name.

Implementing comparing the database column type against the server dataset types

Plans to remove the restart service dialog for the case where config has not changed

Releases History

1.0.24.0, released October 29, 2020

  • Added possibility to setup email and sms notifications 
  • Removed clear button for logs
  • Added comments to batch list file
  • Disabled mouse drag in NumericUpDown controls
  • Added dataset update timespan configuration in UI
  • Some visual fixes for UI
  • Installation: fixed the installation not remembering the previous location
  • Installation: fixed upgrade deleting the config file sometimes

1.0.23.0, released September 29, 2020

  • Fixed a case of wrong processing when original file name was missing
  • Fix for logs  timestamp containing time earlier that UTC +0 causing ‘View recent logs’ button not working correctly
  • Fixed email logger not sending messages to client sometimes
  • Renamed processed batch info file
  • Added indent to processed batch info file

1.0.22.0, released September 22, 2020

  • Added the following properties to log: FileName, BatchName, Task
  • Added ability to filter logs by property
  • Added ability to filter logs by text
  • Fixed logging level resetting to Information after email logger creation

1.0.21.0, released September 10, 2020

  • Fixed different cleanup tasks having the same Id
  • Fixed downloading only 1 doc from the batch for the case already_exported_batches.json was deleted or the service for configured for the project for the first time

1.0.20.0, released September 10, 2020

  • Fixed a bug with encryption on MacOs
  • Fix for an issues for MacOs version for cases when appdomain was not recreated sometimes
  • Download From Cloud window was made wider
  • Added buffered logging
  • Log messages improvements

1.0.19.0, released August 26, 2020

  • Fix for notify url sample file folder path

1.0.18.0, released August 25, 2020

  • Workaround for server timeout issues
  • More extended logging for task failures
  • Added already exported batches lists to reports
  • Fix for notify url sample folder path

1.0.17.0, released August 11, 2020 

  • Fixes for folder write permission check not working on .net core version
  • Fix for processing status of the batch sometimes not detected correctly inside FlexiCapture
  • Fix for NumericUpDown UI element not binding to the value correctly. (Value was saved but not forwarded back to UI)
  • Fix for taskqueue to prevent the task being stuck in execution mode

1.0.16.0, released August 8, 2020 

  • Default value for “Delete document processed without errors after download” changed to false
  • Added logging level to email notifications. 

1.0.15.0, released August 6, 2020 

  • Fixed a bug with default encryption key on windows

1.0.14.0, released August 4, 2020 

  • MacOs version release
  • Improved the NumericUpDown elements in GUI
  • Various fixes for MacOs platform:
    • Prevent system and hidden files from importing to server
    • Filepath comparisons
    • Removed encryption for osx platform

1.0.13.0, released August 1, 2020 

  • Upgraded to use FlexiCapture 12 R3 U2

1.0.12.0, released July 11, 2020 

  • Added functionality to cleanup Exceptions batches after downloading
  • Added regular server cleanup
  • Added userinfo to notification mail body
  • Fixed a bug where NotifyUrl failed if there are no files in the document export results

1.0.11.0, released June 17, 2020 

  • Reworked authentication for non-portal users for FlexiExtAPI
  • Removed unnecessary constants

1.0.10.0, released June 11, 2020 

  • Fixed a bug where NotifyUrl was not called if connection was bad
  • Added more logs Export task

1.0.9.0, released June 08, 2020 

  • Fixed a bug where batches on the Processed stage with no export results were downloaded multiple times
  • Added logs to the exported batch list

1.0.8.0, released June 06, 2020 

  • Added ‘Gather Logs’ button
  • Added error message for unexpected error on launch

1.0.7.0, released June 05, 2020 

  • Improved log message on failed mappings
  • Bugfix: NotyfyUrl not working if the ‘add files to POST’ is false or no files were downloaded

1.0.6.0, released June 04, 2020 

  • Added ‘View recent logs’ button

1.0.5.0, released June 03, 2020 

  • Added Notifications to email option
  • Added ‘delete files after X days’ option

1.0.4.0, released May 29, 2020 

  • Added import from csv file
  • Fix a bug where some files were not updated during updating to the latest version
  • Changed  documentation link to this document

1.0.3.0, released May 28, 2020 

  • Added functionality to update datasets for private projects. Please contact our support to enable it for your project.
  • Added functionality to update datasets of any structure.
  • NotifyUrl post export action now can send the exported files as base64 strings
  • Execute batch  file post export action – added error message if process was not successful
  • Added import folder marker file
  • Fixed a case when batch was downloaded partially if the service is stopped
  • Small UI textbox length fix 

1.0.2.13, released May 22, 2020 

  • Fixed a bug with 0 templates in projects throwing exception
  • Fix for taskqueue: when task is failed remove it from currently processing tasks
  • Fix for folder selection dialog – renaming when folder caused old folder path to be selected
  • Added ‘view recent logs’ button to UI
  • Added folder selection dialog for ‘move to directory’ option on import

1.0.2.12, released May 20, 2020 

  • Fixed a bug where downloaded file size was zero bytes
  • Added XSD file export format as an option (Please not that not all projects have this format enabled)

1.0.2.11, released May 19, 2020 

  • Json file is now sent in NotifyUrl feature even if it is not set to download
  • Fixed version issue with upgrade from 1.0.2.8

1.0.2.10, released May 13, 2020 

  • Added OAuth 1.0 Authentication to the Notify Url action
  • Added ‘Execute batch file’ functionality
  • If there is only one project in the list it will be selected
  • Added json export checkmark (Currently available only in several projects)

1.0.2.9, released May 11, 2020 

  • Added ‘Notify Url’ functionality

1.0.2.8, released May 11, 2020 

  • Improved performance. Added multi-threaded task queue
  • Renamed ‘Import’ to ‘Upload/Import to Cloud’
  • Renamed ‘Export’ to ‘Download from Cloud’
  • UI text changes

1.0.2.7, released April 28, 2020 

  • Added option ‘Do not export batches older than XX hours’

1.0.2.6, released April 24, 2020

  • Several bug-fixes for Export task and Exception export task
  • Added an option ‘Delete successfully processed document from server after export’ to reduce delay when a lot of batches are exported

1.0.2.5

  • Added functionality to export Exceptions queue to a separate folder
  • Configuration file will not be deleted on uninstall now
  • Fix a bug with concurrent access to an export batch save file

1.0.2.4

  • Added functionality to decrease export timeout for tenant users
  • Default export timeout is back to 120 seconds
  • Added ‘range’ setting to ‘Number of files to add to a batch’ option
  • Added import task  validation on closing Import window

1.0.2.3

  • Added option to delete files files completely after import
  • Small UI change to Task window
  • Added ‘Number of files to add to a batch’ option to import task options
  • Temporary decreased export timeout for performance

1.0.2.2, released April 7, 2020

  • Added button ‘Export batch only once’ checkmark. Enabled by default. Now all already exported batches are marked and will not be exported again even if the directory of the exported batch is deleted.  Enabled by default.
  • Fixed a case where relative path of batch export on the server was not translated to the same relative path in export folder

1.0.2.1

  • Added button ‘Test dataset mapping’, that tries to check if the first record from client’s database could be sent to Customers database without any issues

1.0.2.0

  • Ability to support Customers database for WisePO project (Same database as for Invoice Project)
  • Performance improvements when converting database data to DTOs

1.0.1.0

  • Security improvements: Moved from FlexiCaptureAPI to FlexiExtAPI
  • Deprecation support for old versions
  • Improved DataMappings model and window
  • UI improvements
  • Small bug-fixes

1.0.0.3

  • Added full tenants support to UI
  • Various small bug-fixes

1.0.0.2

  • Various bug-fixes

1.0.0.0

  • Upgrade to FlexiCapture R3
  • Added tenants support
  • Release version

FCAdminTools UI Tool

This interactive interface provides access to all ABBYY’s FCAdminTools through a visual User Interface, eliminating the need to work with CLI command line prompt.  It simplifies and provides advanced additional FlexiCApture control with error checking and reporting available through visual interface.