# Global Settings Configuration
Configures global service settings including provisioning behavior, migration options, email, archiving, and Yammer authentication.
Referenced by: Root SharepointCfg.SettingsCfg (singular).
# Overview
SettingsCfg is a container for all global service settings that affect how the provisioning service operates, including provisioning preferences, migration settings, email configuration, and archiving rules.
Nested configurations:
SettingsProvisioningCfg— provisioning-specific settingsSettingsMigrateCfg— migration settingsEmailCfg— email/SMTP configurationYammerAuthenticationCfg— Yammer authenticationArchivingCfg— archiving rules
# Applied when
Global settings are applied when:
- The provisioning service starts; these are root-level configuration settings that affect all provisioning operations
SettingsCfgis always loaded from the rootSharepointCfgobject and applied during service initialization- Settings in this configuration control:
- Provisioning behavior (
SettingsProvisioningCfg) — how sites, libraries, and other objects are created - Migration behavior (
SettingsMigrateCfg) — how data migrations are processed - Email (
EmailCfg) — SMTP server and email notifications - Authentication (
YammerAuthenticationCfg) — Yammer OAuth configuration - Archiving (
ArchivingCfg) — site archiving policies and retention rules
- Provisioning behavior (
- Changes to global settings take effect on the next service restart; already-running provisioning jobs are not affected
# Core settings
# Debug
Type: bool | Default: false | Required: No
Enable debug mode (verbose logging).
# RequestTimeout
Type: int | Default: 900 | Required: No
Request timeout in seconds for operations.
# Provisioning settings
# Provisioning
Type: SettingsProvisioningCfg | Default: — | Required: No
Provisioning-specific settings (see below).
# SettingsProvisioningCfg
# CreateTermIfNotFound
Type: bool? | Default: — | Required: No
Create taxonomy terms if not found.
# CleanupCompletedMonitorDirectory
Type: bool? | Default: — | Required: No
Clean up completed file monitor directory.
# ReadOnlyContentTypeGroups
Type: string (list) | Default: — | Required: No
Content type groups marked as read-only.
# MatterListTitleFormat
Type: enum? | Default: — | Required: No
Matter list title format.
# ClientListTitleFormat
Type: enum? | Default: — | Required: No
Client list title format.
# MyMattersListColumnName
Type: string | Default: — | Required: No
Column name for "My Matters" list.
# MatterListForceSiteUrl
Type: bool? | Default: — | Required: No
Force site URL on matter list.
# Migration settings
# Migrate
Type: SettingsMigrateCfg | Default: — | Required: No
Migration-specific settings (see below).
# SettingsMigrateCfg
# ForceEmailInAutoFilingFolder
Type: bool? | Default: — | Required: No
Force emails into auto-filing folder.
# ForceEmailContentType
Type: bool? | Default: — | Required: No
Force specific email content type.
# UseAzureBlobStorage
Type: bool? | Default: — | Required: No
Use Azure Blob Storage for temporary files.
# CleanupOffice2003Documents
Type: bool? | Default: — | Required: No
Cleanup Office 2003 format documents.
# CleanupOffice2007Documents
Type: bool? | Default: — | Required: No
Cleanup Office 2007 format documents.
# FileSystemCreateShortcuts
Type: bool? | Default: — | Required: No
Create file system shortcuts.
# IgnoreEmailParsingError
Type: bool? | Default: — | Required: No
Ignore errors during email parsing.
# UniqueFileNameSuffix
Type: string | Default: — | Required: No
Suffix for unique file names during migration.
# Email configuration
Type: EmailCfg | Default: — | Required: No
Email/SMTP settings (see below).
# EmailCfg
# UseMsGraph
Type: bool? | Default: — | Required: No
Use Microsoft Graph API for email.
# SmtpServerHost
Type: string | Default: — | Required: No
SMTP server hostname.
# SmtpServerPort
Type: int? | Default: — | Required: No
SMTP server port (typically 25, 587, or 465).
# SmtpUserName
Type: string | Default: — | Required: No
SMTP username (if authentication required).
# SmtpPassword
Type: string | Default: — | Required: No
SMTP password (stored encrypted).
# UseDefaultCredentials
Type: bool? | Default: — | Required: No
Use Windows default credentials.
# EnableSsl
Type: bool? | Default: — | Required: No
Enable SSL/TLS encryption.
# EmailAddressFrom
Type: string | Default: — | Required: No
"From" email address for sent messages.
# PickupDirectoryLocation
Type: string | Default: — | Required: No
IIS SMTP pickup directory path.
# SendEmailWhenError
Type: bool? | Default: — | Required: No
Send email notifications on errors.
# EmailAddressTo
Type: string | Default: — | Required: No
Recipient email address for error notifications.
# Yammer authentication
# Yammer
Type: YammerAuthenticationCfg | Default: — | Required: No
Yammer authentication settings.
# YammerAuthenticationCfg
# AccessToken
Type: string | Default: — | Required: No
Yammer API access token (stored encrypted).
# Archiving configuration
# Archiving
Type: ArchivingCfg | Default: — | Required: No
Archiving rules (see below).
# ArchivingCfg
# Enabled
Type: bool | Default: — | Required: No
Enable archiving functionality.
# PropertyName
Type: string | Default: — | Required: No
Property name used for archiving rules.
# PropertyValues
Type: string (list) | Default: — | Required: No
Property values that trigger archiving.
# Dynamic field value mapping
# DynamicFieldValueMapping
Type: DynamicFieldValueMapping (list) | Default: — | Required: No
Value-replacement rules applied during dynamic name resolution. Each entry maps field values from source systems (e.g., integration plugins, file handlers) to the desired SharePoint values. Supports exact matches, wildcard substring matches, and integration-specific prefixes.
See Dynamic Name for the full reference including built-in date tokens, {PropertyName} substitution, and integration prefix scoping.
# Related
- SharepointCfg — root configuration containing global settings
- Dynamic Name — full reference for dynamic name values and field value mappings