Get the Confluence Storage Format

The Confluence Storage Format is the technical under-the-hood view of a Confluence page. It’s what WikiTraccs “sees” and transforms when performing the Confluence to SharePoint migration.

How to view the storage format for a Confluence page? See your options below.

Option 1: Configure WikiTraccs.GUI to save the storage format to disk

WikiTraccs knows the storage format of each page it migrates from Confluence to SharePoint.

The storage format by default is only kept in memory and not persisted to a file.

Here’s how to tell WikiTraccs to store the storage format of every page to a file:

Variant 1: Enable via config file in WikiTraccs.GUI

In WikiTraccs.GUI, go to Settings -> Configure Transformation -> Migration and select the Save page storage XML to disk option.

Variant 2: Enable via config file appsettings.json

1. Open the WikiTraccs.GUI folder (this is the folder where WikiTraccs.GUI.exe is stored as well)
2. Create an empty file appsettings.json inside the WikiTraccs.GUI folder
3. Open the appsettings.json file in a text editor and put the following text in there:

   {
       "CustomSettings": {
           "Debug": {
               "SaveTransformationInputToDisk": true
           }
       }
   }
   

4. Save appsettings.json
5. If WikiTraccs.GUI is open: close it and any other (console) windows it opened
6. Open WikiTraccs.GUI and start a migration

Where can I find the exported storage format XML?

After following instructions of one of above variants, WikiTraccs now stores the storage format for every newly migrated page in a file, in the attachment registry.

The attachment registry is a folder where attachments from Confluence are downloaded to, while migrating. You can find it in the AppData folder of your local user account.

The attachment registry path for a Confluence page looks like C:\Users\<username>\AppData\Local\WikiTraccs\<confluenceuserkey>\<confluencebaseurl>\Attachments\<pageid>.

Here’s an example screenshot:

Attachment registry path for Confluence page 118587415.

The storage format for a page is stored in a file that is named like xhtml_before-<spacekey>-<pageid>.xml.

Now you can access the storage format for every page that is part of your Confluence to SharePoint migration.

Option 2: Use an app to view the storage format

Here’s the Atlassian documentation on how to view the storage format: How to retrieve Confluence Storage Format

It boils down to this:

Open a page, choose the three-dot-menu, and choose "View Storage Format".

A new browser window will open, showing the storage format.

Option 3: Use the REST API to view the storage format

You can also use the Confluence REST API to view the storage format of a single page in the browser.

You need two pieces of information to do that:

1. your Confluence base address (examples: https://confluence.contoso.com, https://www.contoso.com/confluence)
2. the page ID of the page to get the storage format for (example: 123212321)

Using above information you now build the REST API address using this pattern:

• CONFLUENCEBASEADDRESS/rest/api/content/REPLACEWITHPAGEID?expand=body.storage,version,container,history,history.lastUpdated,contributors,restrictions,permissions,ancestors&status=current

So, using the Confluence base address https://confluence.contoso.com and page ID 123212321 the address would look like this:

• https://confluence.contoso.com/rest/api/content/123212321?expand=body.storage,version,container,history,history.lastUpdated,contributors,restrictions,permissions,ancestors&status=current

Paste this whole address into the address bar of a browser where you are already logged in to Confluence. This should show textual information about the page (in JSON format). It should contain the text "body":{"storage":{"value":".

When sending information to support, please provide the whole content shown by the browser.