The following information details the connectivity and functionality offered by the EzeScan integration with the M-Files ECM solution. It details the available options and how to configure an EzeScan job or Server workflow into the M-Files ECM.

For information on the M-Files ECM solution please refer to the M-Files website -

For information on EzeScan please refer to the EzeScan website -

The minimum requirements for M-Files integration with EzeScan are:

M-Files Desktop (2015.3 or above) is required to be installed on the EzeScan PC/Server.

M-Files Desktop installation will install COM API required for EzeScan Connector.

Developed for Ezescan Release: 4.3


It is assumed that the operator has read about or is familiar with EzeScan Job, KFI and UPLOAD modules. If not please refer to the EzeScan PRO, KFI and UPLOAD guides. It is also assumed that the operator is experienced with the M-Files product.

Configuring Connection Settings

When configuring a Job, KFI or Upload to use M-Files, connection settings panel must be filled in.

TIP: If only using a single Vault, it is recommended that the M-Files connection settings be configured globally.

  1. Click Admin menu, choose Workstation Options.
  2. Click EDRMS tab and choose M-Files option from the drop down list that appears.
  3. Enter the following information:
    1. Network Address - Enter M-Files server address as an IP number or computer name.
    2. User – Enter user name used for M-Files
    3. Password – Enter password for M-Files
    4. Protocol – Select a protocol to be used in server communication.
      • Supported protocols: TCP/IP, SPX, Local Procedure Call (LPC), HTTPS
    5. Endpoint – Enter the communication port on which the server listens for calls.
    6. Vault Name – Enter the M-Files Vault Name.
  4. Click on Save button to complete and close the Workstation options screen.

KFI Field Settings

The KFI Field Settings allow the operator to browse M-Files data during KFI indexing so the operator can select a value and other object types to be applied to the document.


The following functionality requires that the EzeScan workstation be licensed for the EDRMS as well as KFI and UPLOAD modules.

Enabling browse options

The M-Files settings must be configured before a KFI field can use the browse functionality.

  1. Open the respective KFI (press F7) form.
  2. Click the EDRMS tab.
  3. Select the M-Files from the list of available EDRMS’.
  4. Enter the connection settings as per the instructions in Section 3 Configuring the Connection Settings.
  5. Click the fields tab.
  6. To enable a field to access M-Files you need to:
    1. Click the edit link under the Properties for the filed.
    2. Click the M-Files tab.
    3. Select the Enable M-Files Browse Button checkbox
      The browse parameters will become active –

Configuring browse parameters

Choose the following browse option:

Browse ModeThis option determines the lookup type to perform when the Browse button (F3) is pressed during indexing. The default option is Vault Objects.
Selected Object

This option displays list of Vault Objects available for selection. Select an Object. Values of the selected object will either be available as list or search form on the KFI field.

Display As ListCheck this option to display the lookup results as a list of values on the field (or cell in Line Items) for the operator to select from, otherwise leave unchecked to display a search form.

Upload Settings

The UPLOAD module will obtain the KFI output data to pass into M-Files saving the document into the respective location and applying the (KFI’s) metadata information.


The following functionality requires that the EzeScan workstation be licensed for the EDRMS as well as KFI and UPLOAD modules.

Configuring connection and property parameters

  1. Open the Upload Form (F8).
  2. Select the M-Files from the list of available EDRMS’.
  3. Enter the connection settings as per the instructions in Configuring the Connection Settings or Use Global Connection Settings.

Configuring built-in fields

The common upload fields will appear after choosing the M-Files option in the Upload Properties pane (See screenshot below). To obtain the Class specific upload fields change the Field Value “1 – Other document” to required M-Files class and click Auto Populate button.

The Class upload fields are listed below. Each field can have its input set using the Source Field cell. Please refer to Applying KFI Output Data to the Target Field Data to see how this can be configured to allow data mapping.

Configuring custom fields

The M-Files connector can obtain all metadata fields from a M-Files Class object type.


You must have the Upload Properties configured (either Global or Specific settings) as well as the Class being used by the Upload, as shown below…

Click the Auto Populate button at the bottom of the screen.

This will result in the M-Files connector returning a list of custom fields that relate to the respective M-Files Class object type.

It is then a matter of setting the source values of those fields to the target values of the custom fields.

Applying KFI output data to target field data

To pass through the KFI output data into the Upload module the operator is required to set the source field data to the target field data.

  1. In the Upload type, set the Column names from option to the name of the KFI job Type.
  2. In the Field Mappings Grid, the operator can apply the Source Field settings to the Target Field settings.
    In the example below the M-Files Target Field Customer is being populated by the KFI Source Field Customer ID. The M-Files Target Field Age is set to a static value of “15”.
  3. When all the mappings are complete, click Apply.
  4. Click OK to save the changes.

Display Record Number After Saving Record

To enable this setting, please refer to the How to articles.