Skip to main content
In order to send files from M-Files to FlexiCapture, an M-Files workflow should be created. In this workflow, you need to create a state where a file sending script will be executed. This script will call methods from the connector libraries, which should be installed on the M-Files server. To install the libraries, complete the following steps:
  1. Copy the following files from the M-Files Workflow Activity folder in the distribution package into any folder on the M-Files server:
    • Abbyy.MFiles.FlexiCapture.Activity.dll;
    • Abbyy.Connectors.FlexiCaptureConnector.dll.
  2. Run the Command Prompt as administrator, go to the folder where the libraries were placed in step 1, and execute one of the following commands (to register the library in the registry):
    • If you are using a 64-bit M-Files server version:
  • If you are using a 32-bit M-Files server version:
Then restart the M-Files Server 2018 service.
To remove the Abbyy.MFiles.FlexiCapture.Activity.dll library from the registry, run the Command Prompt as administrator, go to the folder where the libraries were placed in step 1, and execute one of the following commands:
  • If you are using a 64-bit M-Files server version:
  • If you are using a 32-bit M-Files server version:
To update Abbyy.MFiles.FlexiCapture.Activity.dll, you need to unregister the previously registered version of the library and register the new version of the library. For the changes to take effect, restart the M-Files Server service.
If the library is registered successfully, the following keys will be added to the registry:
  • HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Abbyy.MFiles.FlexiCapture.Activity.ConnectionSettings
  • HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Abbyy.MFiles.FlexiCapture.Activity.FlexiCaptureWebClient
  • HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Abbyy.MFiles.FlexiCapture.Activity.MFilesTargetContext
  • HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Abbyy.MFiles.FlexiCapture.Activity.RegistrationParameter
The connector distribution package contains a sample vault named “FlexiCapture Demo Vault.” This sample vault already includes a metadata structure for invoices and two preconfigured workflows, one for unattended processing and one for processing with verification. Unzip the FlexiCapture Demo Vault.zip archive. Import this vault to the M-Files server. In the Index file on the server field, provide the path to the file: \FlexiCapture Demo Vault\Index.xml. Next, add to this vault M-Files users that will be working with it. For the scripts in the workflow to work correctly, you must specify your connection settings to be used to connect to the ABBYY FlexiCapture Application Server. These settings should be specified in the head section of each script. Modify the scripts as follows:
  1. In M-Files Admin, open the FlexiCapture Demo Vault that you have imported and click Workflows.
  2. Select one of the workflows and start editing the In Processing by FlexiCapture state. Then click the Actions tab, select the Run Script option, and click Edit Code….
  1. In the Edit VBScript Code dialog box, specify the following variable values in the code of the script:
    • szFCServerUrl = “http://FlexiCapture”
    • szFCUsername = “Username”
    • szFCPassword = “Password”
If you are using ABBYY FlexiCapture Cloud, modify the script as follows:
  1. In the szFCServerUrl variable, specify the URL of the FlexiCapture Cloud instance that your company is registered in.
  2. Uncomment line 3 of the script and specify the name of your company here:
  1. Specify the credentials to be used for your company’s tenant in ABBYY FlexiCapture Cloud:
    • szFCUsername = “Username”
    • szFCPassword = “Password”
  2. Uncomment line 22 of the script to use the name of your company when connecting to the ABBYY FlexiCapture server:
Make identical changes in the other sample workflow.
The connector distribution package also contains a sample FlexiCapture project named “InvoiceDemoProject,” which is configured to be used in conjunction with the sample vault. For the scripts to run correctly in the FlexiCapture Demo Vault, be sure to complete the steps described in the “Setting up an InvoiceDemoProject project in ABBYY FlexiCapture” section.
A workflow in M-Files can be configured for either or Each configuration requires its own script.
The sections that follow contain scripts used for configuring M-Files workflows. To set batch registration parameters replace the code fragment iBatchId = oClient.SendTarget(szFCProject, szFCBatchType) in this these scripts with the following code:
This code creates Abbyy.MFiles.FlexiCapture.Activity.RegistrationParameter objects for each registration parameter. These objects are assigned the values Name and Value. Next, these objects are sent to an array. To send a file to ABBYY FlexiCapture, the SendTarget_2 method is called, which receives the name of the project, the name of the batch type, and the array containing the registration parameters. For detailed information about using registration parameters, see Registration parameters.