Adding Connections from M-Files Hubshare to M-Files

Note: You must have organization-level admin rights to do this.
Note: Connections between M-Files Hubshare and M-Files require REST API configuration for the M-Files Server. For M-Files widgets to operate correctly, also the gRPC connection needs to be configured for the M-Files Server. It is strongly recommended that the M-Files Server for your M-Files Hubshare enviroment has both REST API and gRPC in use. For more information about gRPC setup, refer to Setting Up M-Files to Use gRPC in M-Files Customer Support Portal.

To add M-Files widgets in hubs, the M-Files extension must be active and at least one M-Files connection must be added for the extension. For more information about the connection configuration options and information about federated authentication and using certificates, refer to M-Files Integration in M-Files Hubshare in M-Files Customer Support Portal.

To activate the M-Files extension and add an M-Files connection:
  1. On the navigation bar, select the user icon and select Settings.
  2. In the Administration section, select M-Files integration.
    Result:The M-Files integration page opens.
  3. Enable Enable.
  4. Click New configuration.
    Result:The Configure dialog opens. In the dialog, the mandatory fields show an asterisk (*).
  5. In the General tab, enter the necessary information for the connection:
    Setting Description
    Configuration name Give a name to the configuration.

    It is recommended to name the configuration with the name of the M-Files vault to which the connection is configured.
    Server URL Enter the URL of the M-Files Vault, for example, https://testvault.com.

    Use the REST API URL that is defined in the Advanced tab of the M-Files vault properties dialog for the classic M-Files Web.
    Vault GUID Enter the Vault GUID without curly brackets, for example 990827D8-8AF2-4A4EB121­4C1A8AD8ECD0.

    This is the M-Files Unique ID that is defined in the General tab of the M-Files vault properties dialog.
    gRPC Domain Enter the gRPC Domain for the M-Files Server.

    Use the Web URL that is defined in the Advanced tab of the M-Files vault properties dialog for M-Files Web.

    Note: If classic M-Files Web and M-Files Web are configured to use the same URL, you only need to specify Server URL in M-Files Hubshare.
    gRPC Port Specify the gRPC Port. The default ports are 443 and 7766.
    Do not use REST API fallback If enabled, M-Files Hubshare does not use the REST API when the gRPC API is unavailable. This can cause that some features are not available.
    Note: When you use the REST API to connect M-Files Hubshare to M-Files :
    • The M-Files widget can show a maximum of 200 items.
    • The REST API URI query string is limited to 2000 characters. This can cause no results to shown in the M-Files widget.

    For optimal performance and functionality, enable the gRPC connection on the M-Files server and make sure that Do not use REST API fallback is enabled.

  6. Select the Authentication tab.
  7. In the Authentication tab, select one of the authentication options.
    If you select the Use identity provider authentication option, you can select to use a user account or an application account. By default, the user account option is selected. To use an application account, enable the option Use an application account.
  8. Enter the necessary authentication information.
  9. Optional: If you selected the Use identity provider authentication option, click Connect.
    Result:The configuration is connected to the selected user or application account.
  10. Select the Security tab and enter the necessary information.
  11. Click Save.
The configuration is now ready to be used in an M-Files widget configuration.