Unitfly Toolkit for M-Files logo color
Table of Contents

After you have successfully installed the application, you should configure REST Object Type Connector. Open M-Files Admin

  1. In the left-side tree view, expand the desired connection to M-Files Server.
  2. In the left-side tree view, expand the Document Vaults node.
  3. Still, in the left-side tree view, expand the vault where you installed the connector and select Object or Value list which you want to connect.
  4. Right click on Object type or Value list and select properties.
  5. Select Connection to external database and choose Application connection.

Field description #

FieldValueDescription
General Settings  
EnabledYes/NoIf set to Yes, automatic refresh of the specified external object type is enabled.
It is recommended that you resolve all warnings and errors before setting this to Yes. Otherwise, the configuration cannot be saved.
Target Object TypeChoose from list ‘Object types’Specifies the object type this configuration is for.
IMPORTANT: You can’t change this value after saving.
Target Value ListChoose from list ‘Value lists’Specifies the value list this configuration is for.
IMPORTANT: You can’t change this value after saving.
Get Object Batch SizeIntegerThis setting controls how many objects are read from the data source at one call.
Note that this setting affects only the call between M-Files Server and the external object type service. Calls between the service and the data source depend on the service used.
Service-Specific Settings  
Service data formatJson (default)Data format
Service-Specific Settings>Service credentials Optional service credentials.
DomainTextDomain
UsernameTextUsername
PasswordTextPassword
Service-Specific Settings>Read endpoint>Settings>URLs[n]  
URLURLRead endpoint URLs.
Service-Specific Settings>Read endpoint>Settings  
HTTP methodOne of the following:
GET
POST
PUT
DELETE
HTTP method
Data transformationYes/NoOptional transformation that will extract array of objects from HTTP response
Transformation expressionJsonPath expressionJsonPath expression returning array of objects.
Service-Specific Settings>Read endpoint>Settings>Query parameters[n] Query string parameters
NameTextName
ValueTextValue
Is pagination?Yes/NoIf set to Yes, this parameter will be used as pagination to get multiple pages of data.
Service-Specific Settings>Read endpoint>Settings>Headers[n] HTTP headers to send with the request.
NameTextName
ValueTextValue
Insert endpoint  
Is supported?Yes/NoSpecify if insert operation is supported.
URLTextURL
HTTP methodOne of the following:
GET
POST
PUT
DELETE
HTTP method
Can return ID on insert?Yes/NoControls whether this connection returns created object ID on insert.
Insert Endpoint>Query parameters[n] Query string parameters
NameTextName
ValueTextValue
Is pagination?Yes/No 
Insert Endpoint>Headers[n] HTTP headers to send with the request.
NameTextName
ValueTextValue
Update endpoint  
Is supported?Yes/NoSpecify if update operation is supported.
URLURLURL
HTTP methodOne of the following:
GET
POST
PUT
DELETE
HTTP method
Update Endpoint>Query parameters[n] Query string parameters
NameTextName
ValueTextValue
Is pagination?Yes/NoNot used
Update Endpoint>Headers[n] HTTP headers to send with the request.
NameTextName
ValueTextValue
Delete endpoint  
Is supported?Yes/NoSpecify if delete operation is supported.
URLURLURL
HTTP methodOne of the following:
GET
POST
PUT
DELETE
HTTP method
Delete Endpoint>Query parameters[n] Query string parameters
NameTextName
ValueTextValue
Is pagination?Yes/NoNot used
Delete Endpoint>Headers[n] HTTP headers to send with the request.
NameTextName
ValueTextValue
Advanced settings  
Trusted hosts[n]TextHost
Column definitions[n]  
Column nameTextName
Column typeOne of the following:
• string
• int
• date
• bool
• double
• DateTime
Column type.
Use column path as nameYes/NoIf set to Yes, column name can be written as dot separated property path. This is useful when retrieving non top level properties from response. For example, column name address.city would retrieve city property from top-level address property.
Column mappings Settings related to mapping source columns to M-Files properties.
IMPORTANT: Do not specify the mappings manually. When you save the configuration, the mappings will be automatically created and updated if the service allows it.
Source ColumnTextSpecify the name of the column to be mapped to M-Files.
Mapping TypeOne of the following:
• Ignore
• Object ID
• Property
Specifies how the source column is mapped to M-Files.
Ignore. The source column is not mapped.
Object ID. The source column is mapped as the external object ID.
Property. The source column is mapped as an M-Files property. To use this mapping type, specify the “Target Property” setting.
Target PropertyProperty definitionDisplayed only if [Property] is selected as mapping type.
Use in Update OperationsYes/NoIf this is set to Yes, this mapping is used in update operations.
 Yes/NoIf this is set to Yes, this mapping is used in insert operations.

Your one-stop hub for Unitfly Toolkit for M-Files!

Unitfly Toolkit Community is live!

News and updates on our products • Frequently asked questions • Support page