Install and use the M-Files workflow activity

Sending files from M-Files to ABBYY FlexiCapture requires an M-Files workflow that contains a state where a file-sending script runs. That script calls methods from the connector libraries, so the libraries must be installed on the M-Files server first.

Install the connector libraries on the M-Files server

Copy the libraries to the server

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

Run the Command Prompt as administrator, go to the folder where you placed the libraries, and run the command for your server architecture.For a 64-bit M-Files server:

%SystemRoot%\Microsoft.NET\Framework64\v4.0.30319\RegAsm.exe Abbyy.MFiles.FlexiCapture.Activity.dll /codebase

For a 32-bit M-Files server:

%SystemRoot%\Microsoft.NET\Framework\v4.0.30319\RegAsm.exe Abbyy.MFiles.FlexiCapture.Activity.dll /codebase

Restart the M-Files server

Restart the M-Files Server 2018 service.

Successful registration adds the following keys 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

Unregister the library

Run the Command Prompt as administrator, go to the folder where you placed the libraries, and run the command for your server architecture. For a 64-bit M-Files server:

%SystemRoot%\Microsoft.NET\Framework64\v4.0.30319\RegAsm.exe Abbyy.MFiles.FlexiCapture.Activity.dll /u

For a 32-bit M-Files server:

%SystemRoot%\Microsoft.NET\Framework\v4.0.30319\RegAsm.exe Abbyy.MFiles.FlexiCapture.Activity.dll /u

Update the library

To update Abbyy.MFiles.FlexiCapture.Activity.dll, unregister the previously registered version and then register the new version. Restart the M-Files Server service for the changes to take effect.

Import the FlexiCapture Demo Vault

The connector distribution package contains a sample vault named FlexiCapture Demo Vault. It already includes a metadata structure for invoices and two preconfigured workflows, one for unattended processing and one for processing with verification.

Unzip the vault archive

Unzip the FlexiCapture Demo Vault.zip archive.

Import the vault

Import the vault to the M-Files server. In the Index file on the server field, provide the following path:

\FlexiCapture Demo Vault\Index.xml

Add users to the vault

Add the M-Files users who will work with the vault.

Specify the ABBYY FlexiCapture connection settings

For the scripts in the workflow to work correctly, specify the settings used to connect to the ABBYY FlexiCapture Application Server. These settings go in the head section of each script.

Open the workflows

In M-Files Admin, open the FlexiCapture Demo Vault that you imported and click Workflows.

Open the state script

Select one of the workflows and start editing the In Processing by FlexiCapture state.
Click the Actions tab, select the Run Script option, and click Edit Code.

Set the connection variables

In the Edit VBScript Code dialog box, specify the following variable values:

szFCServerUrl = "http://FlexiCapture"
szFCUsername = "Username"
szFCPassword = "Password"

Repeat for the other workflow

Make identical changes in the other sample workflow.

Additional settings for ABBYY FlexiCapture Cloud

Set the Cloud instance URL

In the szFCServerUrl variable, specify the URL of the ABBYY FlexiCapture Cloud instance that your company is registered in.

Set the tenant name

Uncomment line 3 of the script and specify the name of your company:

szCompany = "Company" '(Optional) Set tenant name.

Set the tenant credentials

Specify the credentials used for your company’s tenant in ABBYY FlexiCapture Cloud:

szFCUsername = "Username"
szFCPassword = "Password"

Apply the tenant name to the connection

Uncomment line 22 of the script so the company name is used when connecting to the ABBYY FlexiCapture server:

oClient.ConnectionSettings.Company = szCompany '(Optional) Set tenant name.

The connector distribution package also contains a sample ABBYY FlexiCapture project named InvoiceDemoProject, configured to be used with the sample vault. For the scripts to run correctly in the FlexiCapture Demo Vault, complete the steps described in Set up the InvoiceDemoProject sample project.

Choose a processing scenario

A workflow in M-Files can be configured for one of the following scenarios. Each configuration requires its own script.

Set batch registration parameters

The scripts on both scenario pages send a file to ABBYY FlexiCapture with this line:

iBatchId = oClient.SendTarget(szFCProject, szFCBatchType)

To set batch registration parameters instead, replace that line with the following code:

' --------------- Send target with registration parameters --------------- '
' Set FlexiCapture batch registration parameters.
Set oRegParam0 = CreateObject("Abbyy.MFiles.FlexiCapture.Activity.RegistrationParameter")
oRegParam0.Name = "Name_0"
oRegParam0.Value = "Value_0"
Set oRegParam1 = CreateObject("Abbyy.MFiles.FlexiCapture.Activity.RegistrationParameter")
oRegParam1.Name = "Name_1"
oRegParam1.Value = "Value_1"
arRegParams = Array(oRegParam0, oRegParam1)
' Sends the target document to FlexiCapture.
iBatchId = oClient.SendTarget_2(szFCProject, szFCBatchType, arRegParams)
' ------------------------------------------------------------------------ '

This code creates an Abbyy.MFiles.FlexiCapture.Activity.RegistrationParameter object for each registration parameter and assigns it a Name and a Value. The objects are then placed in an array. To send the file to ABBYY FlexiCapture, the code calls the SendTarget_2 method, which receives the name of the project, the name of the batch type, and the array of registration parameters. For more information, see Registration parameters.

UiPath

Blue Prism

Automation Anywhere

WinActor

Appian

Pega

M-Files

Laserfiche

NX Manager

Install and use the M-Files workflow activity

Install the connector libraries on the M-Files server

Unregister the library

Update the library

Import the FlexiCapture Demo Vault

Specify the ABBYY FlexiCapture connection settings

Additional settings for ABBYY FlexiCapture Cloud

Choose a processing scenario

Set batch registration parameters

​Install the connector libraries on the M-Files server

​Unregister the library

​Update the library

​Import the FlexiCapture Demo Vault

​Specify the ABBYY FlexiCapture connection settings

​Additional settings for ABBYY FlexiCapture Cloud

​Choose a processing scenario

​Set batch registration parameters

Install the connector libraries on the M-Files server

Unregister the library

Update the library

Import the FlexiCapture Demo Vault

Specify the ABBYY FlexiCapture connection settings

Additional settings for ABBYY FlexiCapture Cloud

Choose a processing scenario

Set batch registration parameters