Sample Configurations
This article contains sample configurations for different purposes.
Configuration via Configuration File
This article is a resource where you can find configuration options for WikiTraccs.
Configuring via configuration file
Note
You have to restart the application to apply changes to settings files.Use WikiTraccs.Console when working with a configuration file.
The configuration is done in the appsettings.json file. When you run WikiTraccs.Console then appsettings.json must be placed in same folder as WikiTraccs.Console.exe. Create the file, if needed.
Note
appsettings.json can also be used together with WikiTraccs.GUI to configure some aspects not available in the GUI. In this case place the configuration file in the WikiTraccs.GUI folder. Note that not all configuration options might be available in this case.Here is a sample of appsettings.json configured for a straightforward content migration (a second sample follows further down, explaining the options):
{
"CustomSettings": {
"TargetTenants": [
{
"HumanReadableId": "Contoso SharePoint",
"SharePointRootUrl": "https://contoso.sharepoint.com",
"ClientId": "76762071-f1a9-4323-a97a-ab24992032fd",
"Tenant": "82fb6e24-c982-4f08-a009-1916ee226643",
"AuthenticationType": "interactive",
"TargetSites": [
{
"HumanReadableId": "WikiTraccs",
"SiteRootUrl": "https://contoso.sharepoint.com/sites/MigrationStore"
},
{
"HumanReadableId": "WikiTraccsDefaultTarget",
"SiteRootUrl": "https://contoso.sharepoint.com/sites/DefaultTarget"
}
]
}
],
"TransformationMappings": [
{
"SourceTenantHumanReadableId": "Contoso Confluence",
"TargetTenantHumanReadableId": "Contoso SharePoint",
"TargetSiteHumanReadableId": "WikiTraccsDefaultTarget"
}
],
"SourceTenantIncludeList": [
{
"TenantId": "https://www.contoso.com/confluence",
"HumanReadableId": "Contoso Confluence",
"SpaceTransfer": {
// note: spaces to migrate are configured via space inventory list in the SharePoint WikiTraccs site
"Enabled": true
}
}
],
"AttachmentRegistryRootPath": "D:\\FileRegistry",
// WikiTracs detects Chrome version automatically
"ChromeDriverVersionOverride": null,
// WikiTracs downloads Chrome web driver to current directory
"WebDriverDirPath": null,
// WikiTracs locates chrome.exe automatically
"ChromeBinaryPath": null,
}
}
Here is a complete and documented sample of appsettings.json showing more options for advanced and multi-pass configuration:
{
"CustomSettings": {
"TargetTenants": [
{
"HumanReadableId": "Contoso SharePoint",
"SharePointRootUrl": "https://contoso.sharepoint.com",
// client ID (application ID) of the registered Azure AD Application
"ClientId": "76762071-f1a9-4323-a97a-ab24992032fd",
// SharePoint tenant ID
"Tenant": "82fb6e24-c982-4f08-a009-1916ee226643",
// how to authenticate with Azure AD; valid options are: "interactive" (supports MFA, use this), "credentials" (no MFA support)
"AuthenticationType": "interactive",
// optional: configuration for AuthenticationType "credentials", not needed for "interactive"
"AuthenticationParameterSetCredentials": {
"CredentialsUserName": "[email protected]",
"CredentialsPassword": "p4ssw0rd"
},
// contains all sites used in the migration; two are mandatory: "WikiTraccs" and "WikiTraccsDefaultTarget"
"TargetSites": [
{
// this is the "management site" for WikiTraccs that contains space inventory, user and group mapping table etc.; the HumanReadableId MUST be "WikiTraccs"
"HumanReadableId": "WikiTraccs",
"SiteRootUrl": "https://contoso.sharepoint.com/sites/MigrationStore"
},
{
// this is the default migration target for spaces that have no other target configured; the HumanReadableId MUST be "WikiTraccsDefaultTarget"
"HumanReadableId": "WikiTraccsDefaultTarget",
"SiteRootUrl": "https://contoso.sharepoint.com/sites/DefaultTarget"
}
]
}
],
// configure migrations here; which source should be migrated to which target
"TransformationMappings": [
{
"SourceTenantHumanReadableId": "Contoso Confluence",
"TargetTenantHumanReadableId": "Contoso SharePoint",
"TargetSiteHumanReadableId": "WikiTraccsDefaultTarget"
}
],
// Confluence configuration
"SourceTenantIncludeList": [
{
// use the Confluence URL as TenantId
"TenantId": "https://www.contoso.com/confluence",
// this can be anything and is used to reference to the source tenant
"HumanReadableId": "Contoso Confluence",
// add page IDs here to force-migrate those pages
"PageIdIncludeList": [
"123456789",
"234567890"
],
// migrate SharePoint pages with transformation errors again
"ReprocessContentWithErrors": true,
// configure content migration here
"SpaceTransfer": {
// uncomment this to switch to principal checking mode; this updates the Created by and Modified by fields of pages; configure user mapping first!
//"Operations": ["checkprincipals"],
// do migrate content
"Enabled": true,
// handle those spaces; note that this will be merged with the spaces selected in the space inventory list in SharePoint:
"SpaceIncludeList": [
{
"SpaceKey": "AGILE"
},
{
"SpaceKey": "ARCHIVE"
}
]
},
// configure permission migration here
"PermissionTransfer": {
// do migrate permissions; note: only enable either SpaceTransfer, or PermissionTransfer, _not_ both at the same time
"Enabled": false,
// migrate permissions for those spaces
"SpaceIncludeList": [
{
"SpaceKey": "AGILE"
}
]
}
}
],
"ReprocessContentWithErrors": false,
// Sometimes there are huge wait times if external images don't time out properly. The number of retries and waits can be tweaked here so this does not slow down too much.
"ExternalDomains": [
{
"UrlStartsWith": "https://docs.docker-cn.com",
"HttpTimeoutRetries": 2,
"HttpTimeoutSecs": 2
}
],
// By default WikiTraccs expects chromedriver.exe to be in the same folder as WikiTraccs. It will be downloaded if not present.
// Here you can change the folder WikiTraccs uses.
"WebDriverDirPath": "C:\\Users\\user\\Documents\\00_Portable",
// Normally WikiTraccs locates chrome.exe automatically.
// Specify an absolute path to chrome.exe if this fails _or_ you'd like to point to a specific Chrome version.
"ChromeBinaryPath": "C:\\Program Files\\Google\\Chrome Beta\\Application\\chrome.exe",
// By default WikiTraccs stores Confluence attachments in the application folder for the current user.
// Override this location here with an absolute path.
"AttachmentRegistryRootPath": "D:\\FileRegistry",
// Only needed in environments where the auto-detection endpoint is blocked; must match the Chrome version (see Troubleshooting > Connectivity for details)
"ChromeDriverVersionOverride": "72.0.3626.52",
// Those options can aid debugging.
"Debug": {
"ClearLocalCacheOnStart": false, // default: false
// Set this to true to save the storage format of every transformed page to disk. This can be useful for troubleshooting.
"SaveTransformationInputToDisk": false // default: false
},
"Features": {
// Trigger update of space inventory? Note that this can also be done from WikiTraccs.GUI.
"FillSpacesList": false,
// Transform page tree macro to static tree of links in SharePoint?
"TransformPageTreeMacro": true, // default: true
// Transform roadmap macro to image placeholder? Note that the image placeholder does not contain all information (e.g. text is missing).
"TransformRoadmapMacro": true, // default: true
// Use a centered dummy image for advanced text control flow around images (>0.1.5)?
"EnableDummyImageFloatResetForImages": true,
// Add a link to the source Confluence page?
"AddLinkToSourcePage": false,
// Mark formerly merged table cells?
"TableCellSpanLayoutMode": "UnmarkedAdditionalSlots" // default: "MarkedAdditionalSlots"
}
}
}
When running WikiTraccs.Console you have to use appsettings.json to configure everything. The program will stop with an error pretty fast if the configuration is missing.
Last modified August 10, 2023