Skip to content

Connection configuration

Reached from Connection Configurations on Main configuration.

Settings

Connection Source ClassRequired

Type
M-Files class

Select the M-Files class that represents the source of connections.

Use black-list or white-list for classes

Type
One of a list
Default
black-list

Choose whether to use a black-list or white-list for class selection.

  • black-list
  • white-list

Class white-list

Type
List of Class entry
Default
[]

Shown when Use black-list or white-list for classes is White.

If not empty, this is used to select classes to apply to documents emitted by a data source. You cannot use the white-list to apply black-listed classes!

Settings on each entry — 1 of them

Class black-list

Type
List of Class entry
Default
[]

Shown when not (Use black-list or white-list for classes is not Black).

Prevents the selected classes from being applied to any document emitted by a data source. Black-listed classes will never be applied, even if they are contained in the white-list.

Settings on each entry — 1 of them

Default Document Class

Type
M-Files class

The default document class that is applied to incoming documents if the application and mappers fail to apply any other class.

Default Workflow

Type
Workflow and starting state
Default
null

An optional default workflow and state to be applied to new documents.

Settings in this group — 2 of them

Error Workflow

Type
Workflow and starting state
Default
null

An optional error workflow and state to be applied to documents if an error occurs.

Settings in this group — 2 of them

Make error assignments?

Type
Yes or no
Default
False

Create an error assignment for the owner of a data source, whenever an error occurs when downloading a file.

Source Error Assignment Class

Type
M-Files class

Shown when Make error assignments? is Yes.

The class to be used for source error assignments.

Document Error Assignment Class

Type
M-Files class

Shown when Make error assignments? is Yes.

The class to be used for document error assignments.

Default Named Access Control List

Type
M-Files named access control list
Default
null

The default named access control list to be applied to new documents.

Prevent checkouts

Type
Yes or no
Default
True

Whether checking out documents from data sources should be prevented when the data source is still active.

Propagate server-driven edits

Type
Yes or no
Default
False

If enabled, document changes performed by server (system) processes — such as workflow transitions or automation — will be propagated to the external source. This queues a background check-in task for every server-driven mutation on documents synced through this connection. You must also set 'Prevent checkouts' to No on this connection — otherwise server-driven checkouts will fail. We recommend isolating documents that need server-edit propagation in a dedicated connection configuration.

Copy properties from data sources?Required

Type
Yes or no
Default
True

If set to No, properties will never be copied from a data source to its documents. Any configured properties in the Property white-list or black-list will be ignored. (the default is to copy properties).

Use black-list or white-list for properties.

Type
One of a list
Default
black-list

Choose whether to use a black-list or white-list for properties.

  • black-list
  • white-list

Property white-list

Type
List of Property entry
Default
[]

Shown when Use black-list or white-list for properties. is White.

If not empty, this is used to copy only this list of properties from a data source to all the documents that it emits. You cannot use the white-list to copy black-listed properties!

Settings on each entry — 1 of them

Property black-list

Type
List of Property entry
Default
[]

Shown when not (Use black-list or white-list for properties. is not Black).

Prevents the selected properties from being copied from a data source to any document that it emits. This is is *in addition* to CtrlSync's own special properties, like Graph URL, etc. which will never be copied. It's a good idea to blacklist all properties set by property-mappers and use each mapper's default property instead. Black-listed properties will never be copied, even if they are contained in the white-list.

Settings on each entry — 1 of them

Path Property

Type
M-Files property
Accepts
Multi Line Text

A property used to save the external path to the document. Optional.

Path Mappings

Type
List of Path property mapping
Default
[]

Mappings used to determine metadata from the path of the document in the source.

Settings on each entry — 7 of them

Name Mappings

Type
List of Name property mapping
Default
[]

Mappings used to determine metadata from the file name of the document.

Settings on each entry — 6 of them

Graph Property Mappings

Type
List of Graph property mapping
Default
[]

Mappings used to determine metadata from the graph properties of the document in the source.

Settings on each entry — 5 of them

Path Exclusions

Type
List of Path exclusion
Default
[]

Mappings used to exclude files and changes from specific folders.

Settings on each entry — 3 of them

Created-by property

Type
M-Files property
Default
null
Accepts
Lookup

A property to indicate who created a document in the data source.

Modified-by property

Type
M-Files property
Default
null
Accepts
Lookup

A property to indicate who last modified a document in the data source.

Apply Automatic Metadata (Experimental)

Type
Yes or no
Default
False

Whether to apply automatic metadata from intelligence services to documents synchronized from this data source. If enabled, the metadata will be applied after all other properties and the class have been set. This may result in additional properties being set, or even the class being changed, based on M-Files' automatic metadata rules. Use with caution, as this may have unintended consequences. The default is No (disabled).

Column Configurations

Type
List of Column configuration

Configurations for columns to be created and synchronized for the connection.

Settings on each entry — 7 of them

Deletion Policy

Type
One of a list
Default
Prevent

The policy to apply when deleting documents from the data source. The default is to prevent deletions of documents when they are associated with an active connection.

  • None
  • Prevent
  • Allow
  • AllowWithProperty

Generated from CtrlSync 0.26.6.0.