ABBYY FlexiCapture Connect

​

System requirements

​

Setup

​

Configuration file explained

{
  "url": "https://europe.flexicapture.com/",
  "tenant": "testtenant",
  "user": "user1",
  "password": "password1",
  "projects": [
    {
      "name": "project1",
      "import": {
        "directory": "C:\\HotFolder\\Import",
        "fileMask": "*",
        "settings": {
          "region": "US",
          "verification_type": "NoVerification",
          "export_format": "Xml"
        },
        "createDocument": "ForEachFile",
        "period": "00:01:00",
        "schedule": [ "12:00:00", "06:00:00" ]
      },
      "export": {
        "directory": "C:\\HotFolder\\Export",
        "period": "00:01:00",
        "schedule": [ "12:00:00" ]
      },
      "templates": [
        {
          "name": "template",
          "datasets": [
            {
              "name": "DataSet",
              "file": "C:\\HotFolder\\DataSets\\DataSet.csv",
              "period": "00:01:00",
              "schedule": [ "12:00:00" ]
            }
          ]
        }
      ]
    }
  ]
}

​

General settings

• url — The URL of the tenant (for example, https://europe.flexicapture.com).
• tenant — The name of the tenant.
• user — The user name of the service account.
• password — The password of the service account.
• projects — Contains settings for individual projects, such as document import and export parameters and data set synchronization parameters.

​

Project settings

• name — Project name.
• import — Settings for importing documents.
• export — Settings for exporting documents.
• templates — Settings for synchronizing data sets.

​

Import settings

• directory — The path to the folder from which documents are imported.
• fileMask — A file and folder filter. The * and ? wildcards are supported.
• settings — Batch registration parameters.
• createDocument — Possible values are ForEachFile (creates a separate document for each imported file) or Automatically (uses project parameters). To use this function, first select the Automatically when Document Definition is applied option in the ABBYY FlexiCapture project.
• period and schedule — Task schedule. The period property specifies how often the task starts (for example, "period": "00:02:30" starts the task every two and a half minutes). The schedule property specifies the times when the task starts (for example, "schedule": [ "09:00:00", "19:00:00" ] starts the task daily at 9:00 and 19:00).

​

Export settings

• directory — The path to the folder where exported files are stored.
• period and schedule — Task schedule, specified the same way as for import settings.

​

Document Definition settings

• name — The name of the Document Definition related to the given section.
• datasets — The data set synchronization parameters for the Document Definition.

​

Data set synchronization settings

• name — The name of the data set.
• file — The path to the CSV file that contains the master data exported from the ERP system. The first line of the CSV file must contain the names of the data set fields separated by commas, and any values containing commas must be enclosed in double quotes.
• period and schedule — Task schedule, specified the same way as for import settings.

Id,Name,Street,City,ZIP,CountryCode,VATID,IBAN,IBAN,BusinessUnitId
1,MacWay,9 Route d'Eschau,Illkirch-Graffenstaden,67411,FR,1A345678901,FR1420041010050500012M02606,FR7630006000011234567890189,1
2,Bottled Water Ltd,Mary Ann St,Cardiff,CF102EN,GB,123456789,GB29NWBK60161331926819,,2
3,CCcompany Ltd.,2 Wilkins Grove,Welwyn Garden City,AL86JS,GB,234567890,GB27BOFI90212729823529,,3
4,MANZANA solutions,"Calle de la Botanica, 15",Madrid,28000,ES,E73895722,ES9121000418450200051332,,4

​

Store service account credentials in Windows Vault

1

Create or choose a Windows account

Create a new Windows account, or choose an existing Windows account.

2

Register the credentials with cmdkey

Run cmd.exe under that Windows account and run the following command, where https://europe.flexicapture.com#tenant is a combination of the ABBYY FlexiCapture URL and the tenant name:

cmdkey /generic:https://europe.flexicapture.com#tenant /user:userName /password:p@ssword

3

Remove the credentials from the configuration file

Delete the user name and password from the config.json file located in the ABBYY FlexiCapture Connect service directory.

4

Run the service under the Windows account

Run Windows Service Manager (services.msc) and configure ABBYY FlexiCapture Connect to launch under the same Windows account you selected in the second step:

1. In the Services properties, open ABBYY FlexiCapture Connect.
2. On the Log On tab, select This account and enter your Windows account credentials.

1

Open Credential Manager

Open Credential Manager.

2

Remove the credential

On the Windows Credentials tab, expand the credentials that you want to remove and click Remove.

​

Set up export

1

Clear the export root path

On the General tab of the <project> Properties dialog box, make sure that the Export root path field is left empty. For more information, see Project properties.

2

Specify a relative export path

In the Export Settings dialog box, specify the export path relative to the root path specified on the General tab of the <project> Properties dialog box. Because you left this root path empty, specify the directory without the exact root path.

​

Limitations

• Only data sets of up to approximately 500,000 records can be synchronized.
• While updating a data set, users will not be able to look up vendors on the web stations.
• The current version does not recognize Hot Folder import profiles that are based on project settings.
• ABBYY FlexiCapture Connect will export documents from all the batches available on the server. The project settings will not affect the name of the destination directory, which will always have the same name as the originating batch.
• ABBYY FlexiCapture Connect can only export an entire batch, which means that if you disable the Wait for all documents in a batch option in the project’s Workflow Settings, the documents will still not be exported separately.
• The current version cannot export the results from all the documents in a batch into a single file. A separate file is created in the export directory for each document from the batch.
• The current version cannot export the results from all the batches into a single file. A separate file is created in the export directory for each document from each batch.
• The size of imported and exported files is limited to 199 MB.
• Proxy servers are not supported.

​

Troubleshooting