Configuration
SP Toolkit offers extensive configuration options to customize migrations for your specific needs. From batch sizes to version handling, every aspect is configurable.
Migration Mode
Control what gets migrated
| Setting | Description | Default |
|---|---|---|
| Structure + Data | Complete migration including schema and items (default) | Selected |
| Structure Only | Create list schema without data | Unselected |
| Data Only | Migrate items to existing list | Unselected |
Throughput Presets
Balance speed vs. throttling risk
| Setting | Description | Default |
|---|---|---|
| Conservative | Batch size 25, 500ms delays. Best for throttling-prone tenants. | Unselected |
| Balanced | Batch size 100, 100ms delays. Good for most scenarios. | Selected |
| Aggressive | Batch size 500, minimal delays. Large datasets only. | Unselected |
Version History
Control version migration
| Setting | Description | Default |
|---|---|---|
| migrateFileVersions | Enable file version history migration | false |
| maxFileVersions | Maximum file versions to migrate (0 = unlimited) | 0 |
| maxListItemVersions | Maximum list item versions to migrate | 0 |
Conflict Handling
How to handle conflicts
| Setting | Description | Default |
|---|---|---|
| createMissingLists | Auto-create lists that don't exist in target | true |
| createMissingFields | Auto-create fields that don't exist in target | true |
| overwriteExistingLists | Delete and recreate existing lists | false |
| skipErrors | Continue migration on individual item failures | true |
Performance
Fine-tune migration performance
| Setting | Description | Default |
|---|---|---|
| batchSize | Items per batch (50-5000) | 100 |
| useEfficientMode | Enable streaming/batched migration engine | true |
| maxRetries | Maximum retry attempts for failed operations | 5 |
Incremental Migration
Skip unchanged items
| Setting | Description | Default |
|---|---|---|
| incrementalMode | Delta detection strategy (none, timestamp, hash) | none |
| skipUnchangedItems | Skip items that haven't changed since last migration | false |
Advanced Settings
Rich Text Options
- HTML normalization and cleanup
- Asset reference URL rewriting
- Embedded link detection
Attachment Options
- Enable/disable attachment migration
- Per-attachment retry logic
- Size tracking and reporting
User Field Options
- preferEmail - Try email resolution first
- preferLoginName - Try login name construction
- allowPartialMatches - Enable username extraction
- createFallbackDisplayNames - Create text fallbacks
Lookup Field Options
- Auto-detect circular dependencies
- Deferred backfill for circular lookups
- Title index caching
- Custom lookup target mapping
Migration Profiles
Save your configuration as reusable profiles for consistent migrations.
Profile Features
- Save all migration options to a named profile
- Load profiles instantly when starting new migrations
- Export/import profiles for team sharing
- Includes field mappings and data transform rules
Example Profiles
Settings Persistence
Auto-Save
Migration options and UI preferences are automatically saved to browser localStorage per user and site.
Session Restoration
Wizard state is restored on page reload, including expanded sections, filters, and advanced options.
Unload Protection
Browser warning prevents accidental navigation away during active migrations.
Configuration Best Practices
Start Conservative
Begin with smaller batch sizes (50-100) and increase once you confirm stable performance.
Test Structure First
Use "Structure Only" mode to validate field compatibility before migrating data.
Cap Versions for Large Libraries
Set maxFileVersions to a reasonable limit (e.g., 10-50) for document libraries with extensive history.
Enable Skip Errors
Keep skipErrors enabled for large migrations to prevent one bad item from stopping the entire process.