Settings

You can use settings to configure specific global properties, attributes, and behaviors for synchronization jobs. There are both global settings e.g. for determining the access permissions of individual users and for synchronization jobs to define e.g. certain values such as approval limits.

When creating/entering a setting, the name of the setting (name), the value (value), and the level the setting applies to (hierarchyContext) must be specified at minimum.

The following example shows a setting in JSON format that can be included in a request:

{
    "name":"ShOnlineMetadataExportType",
    "value":"AsJson",
    "hierarchyContext":"SyncJob"
}

Certain settings can only be set or edited by administrators, while other settings can be set or edited by normal users.

The settings can have one of the following permissions:

• None: No access to the setting
• Read: Only read access to the setting
• Write: Can update/create the setting. Read access included
• Delete: Setting can be deleted. Read and write access included
• Admin: Only the administrator has full access

For settings that apply both at the user level and synchronization job level, the synchronization job setting is given priority. If no specific setting is defined for a synchronization job, any next higher user or group setting is used.

The following settings are available:

MaxSyncDocumentSize

This setting indicates a maximum file size for synchronizing documents. If the file size is exceeded, an approval is created for the document.

• Permission: Write
• Validity: UserOrGroup/SyncJob
• Permitted values: A positive integer, encoded as a string.

MaxSyncableDocuments

This setting indicates the maximum number of documents to be synchronized in a synchronization job. If this number is exceeded, an approval is created for the job.

• Permission: Write
• Validity: UserOrGroup/SyncJob
• Permitted values: A positive integer, encoded as a string.

AllowedAccessByUsersOrGroups

This setting determines the users who can log on to ELO Sync. It can only be changed by administrators.

• Permission: Admin
• Validity: Global
• Permitted values: User ID as an integer, encoded as a string.

GroupPermissions

This setting indicates which permission a group or user has, e.g. which system they can access or what type of jobs they can use.

• Permission: Admin

• Validity: Global

• Permitted values: Array containing combinations of the third-party system and job types, e.g. ["OneDrive.Archive","OneDrive.TwoWay","SharePoint.Archive"].

  This setting should preferably be set using the SetUserPermissions endpoint.

ShMetadataMappings

This setting contains the metadata mapping between SharePoint columns and ELO index fields.

• Permission: Write

• Validity: UserOrGroup/SyncJob

• Permitted values: JSON string of an object that has a property 'eloField' with the path to the ELO index field as well as a property 'thirdSystemField' with the path to the column in SharePoint, e.g.:

  {\"eloField\":\"Ordner\\\\ELOINDEX\",\"thirdSystemField\":\"3\\\\Shared Documents\\\\Title\"}"

ShOnlineArchivedEntriesReplacementMode

This setting indicates whether the original document should be retained, deleted, or replaced with a URL file containing the link to the document in ELO with archiving jobs.

• Permission: Write
• Validity: SyncJob
• Permitted values: One of the following values: "None", "ReplaceByUrlFile", or "DeleteEntry"

ShOnlineMetadataExportType

This setting indicates whether and, if so, in which format to export the metadata in. If this setting is set, a corresponding file is stored along with the document with the metadata.

• Permission: Write
• Validity: SyncJob
• Permitted values: One of the following values: "None", "AsJson", or "AsXlsx"

OneDriveArchivedEntriesReplacementMode

This setting indicates whether the original document should be retained, deleted, or replaced with a URL file containing the link to the document in ELO with archiving jobs.

• Permission: Write
• Validity: SyncJob
• Permitted values: One of the following values: "None", "ReplaceByUrlFile", or "DeleteEntry"

ReplaceWithGroupSettings

This setting indicates whether the user settings should be overwritten with group settings.

• Permission: Read
• Validity: Global
• Permitted values: "true" or "false"

EloSyncEulaAgreed

This setting indicates whether the EULA has been accepted. When this value is set to false, certain actions are unavailable.

• Permission: Admin
• Validity: Global
• Permitted values: "true" or "false"

DashboardSetting

This setting includes the dashboard layout with the arranged widgets.

• Permission: Write
• Validity: UserOrGroup
• Permitted values: The dashboard layout, encoded as a JSON string. Not described in more detail here, as the dashboard is not needed when using the REST API.

MaxFolderReferencesDepthPublish

This setting indicates the maximum depth for folder references.

• Permission: Write
• Validity: UserOrGroup/SyncJob
• Permitted values: A positive integer, encoded as a string.

SyncConflictResolutionStrategy

This setting indicates whether conflicts should be resolved automatically and, if so, with which version.

• Permission: Write
• Validity: SyncJob
• Permitted values: "0" (Manually), "1" (UseEloVersion), or "2" (UseThirdSystemVersion)