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 that are set via a configuration file.
Configuring via configuration file
Note
You have to restart the application to apply changes to settings files.The configuration file works with both WikiTraccs.GUI (the blue window) and WikiTraccs.Console.
The configuration is done in the appsettings.json file. When you run WikiTraccs.GUI then appsettings.json must be placed in same folder as WikiTraccs.GUI.exe. 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 be used together with WikiTraccs.GUI to configure many settings not available in the GUI. Note that not all configuration options might be available. Get in touch if some setting doesn’t seem to be applied.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 Entra ID Application
"ClientId": "76762071-f1a9-4323-a97a-ab24992032fd",
// SharePoint tenant ID
"Tenant": "82fb6e24-c982-4f08-a009-1916ee226643",
// How to authenticate with Entra ID; valid options are: "interactive" (supports MFA, use this), "credentials" (no MFA support), "devicelogin".
"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": [
{
// You MUST use the Confluence base URL as TenantId
"TenantId": "https://www.contoso.com/confluence",
// By default, when using interactive Confluence login, the Confluence base URL (as specified by the TenantId) will be opened in a browser.
// If you need to use an address for authentication that is different from the base URL, you can specify this here. This is optional.
"AuthUrl": "https://www.contoso.com/confluence/login.action?force_azure_login=false",
// 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, and also place a pre-downloaded exe there.
"WebDriverDirPath": "C:\\Users\\user\\Documents\\00_Portable",
// 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",
// 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",
// 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
// Skip connection checks when starting transformation in WikiTraccs.GUI?
"SkipConnectionCheckInWikiTraccsGui": false,
// Ignore errors when preparing a site as migration target (not recommended!)?
"SkipPreparationResultCheck": false,
// Skip caching of API responses (space inventory content, Confluence API calls) that would otherwise be cached for some time (often only some minutes)?
"BypassCaches": 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)?
// note: this becomes obsolete in newer versions, due to updates to SharePoint pages by Microsoft; don't bother
"EnableDummyImageFloatResetForImages": true,
// Add a link to the source Confluence page?
"AddLinkToSourcePage": false,
// Mark formerly merged table cells?
"TableCellSpanLayoutMode": "UnmarkedAdditionalSlots", // default: "MarkedAdditionalSlots"
// add attachments section to each page (if there are attachments)?
"AddAttachmentsSection": true,
// migrate footer comments (will become page content)?
// release notes: https://github.com/WikiTransformationProject/wikitraccs-releases/releases/tag/v1.9.0
"MigrateFooterComments": true,
// try to resolve hard links?
// release notes: https://github.com/WikiTransformationProject/wikitraccs-releases/releases/tag/v1.6.4
"ResolveHardLinks": true,
// migrate Confluence blog posts to SharePoint
"MigrateBlogposts": true,
// promote migrated blog posts as SharePoint news; note: this may cause notifications for users
"PromoteBlogposts": true
},
"WiggleRoom": {
// set the maximum wait time for callouts to Jira for resolving issue links and issue tables
// set this to -1 to disable reaching out to Jira while migrating pages from Confluence to SharePoint; this is handy when the Jira application link is no longer functional
// release notes: https://github.com/WikiTransformationProject/wikitraccs-releases/releases/tag/v1.11.12
"JiraMaxWaitTimeSec": 60,
// set the maximum number of parallel uploads when migrating attachments from Confluence to SharePoint
// handle with care, a number too high will quickly get you throttled by Microsoft
"ParallelFileOperationsCount": 2,
// number of seconds to wait after a failed page provisioning (e.g. due to connection loss); a multiplier will be applied by WikiTraccs with each try, this is the base value
"WaitTimePerProvisioningRetryBaseSec": 20,
// number of times a page provisioning is retried after failing for whatever reason (e.g. connection loss)
"ProvisioningRetriesCount": 4,
// number of results to get with call to the content API (non-body, with expansions)
// ATTENTION: setting this too high will make content be missing from the migration!
// there are system limits baked into Confluence: 200 is the maximum for retrievals with non-body expansions, which is used by WikiTraccs when bulk-retrieving information about pages
"PageRetrievalPageSizeOverride": 200,
// number of IDs to bundle into one CQL query that will be used to retrieve pages for the content ID selector
// ATTENTION: choosing a number too high will lead to a Server Error from Confluence; lower the number if that is the case
"PageRetrievalByContentIdsCqlPageSizeOverride": 500
}
}
}
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 7, 2024