Required Objects and Modules#

The required objects and properties for each module are listed below.

Syntax

Description

Graph Source Object

CtrlSync requires a graph source object. This object is used to maintain a connection to the Microsoft Graph API. This object requires multiple properties and these properties need to be referenced in the CtrlSync configuration. The Graph Source Object type itself is not referenced in the configuration.

Graph Source Classes

In CtrlSync’s configuration, different behaviour is created for the different classes of Graph Source. By default, a single such class will exist when the object is created.

Source URL property

This property is used to reference the MS Teams or MS SharePoint library that the Source object should import files from. This property must be a multi-line text property.

Graph ID property

This property is used to hold a unique identifier to a file from Microsoft Graph. This property must be either a text or multi-line text property.*

Graph data property (optional)

This multi-line text property can be defined and referenced in the configuration in order to store additional data from the Microsoft Graph API. This is usually not necessary.

Source ‘Active’ property

A Graph source requires a Boolean property to determine if it is currently actively synchronizing or not.

Source Reference property

Each data source sets a reference on the documents that it imports, these references requires a single- or multi-select lookup that points to the Graph Source Objects to be defined. Such a property is usually automatically created when the Graph Source Object type is created.

Source Status property (optional)

This multi-line text property can be defined and referenced in the configuration to allow CtrlSync to set a special status message if there is a problem synchronizing files from MS Graph.

Path property (optional)

This multi-line text property can be defined and referenced in the configuration to allow CtrlSync to set their MS file path for any incoming document, such that it can be used in e.g. automation steps.

Custom created-by property (optional)

A lookup-property pointing to the Users value-list can be used to keep track of which user in Microsoft Graph / Teams (if such an overlap exists) created an incoming document. This is useful if e.g. read-only users create documents in Teams/SharePoint and we want to keep track of the author without a attributing the file creation to their M-Files account.

Custom created-by property (optional)

A lookup-property pointing to the Users value-list can be used to keep track of which user in Microsoft Graph / Teams (if such an overlap exists) last modified an incoming document. This is useful if e.g. read-only users create documents in Teams/SharePoint and we want to keep track of the author without a attributing the file modification to their M-Files account.