Overview

This document explains how to plan your Scaffolding migration.

Confluence Cloud currently does not support nested macros (See CONFCLOUD-68323).

This means integration with other apps by way of nesting will be limited.

This Atlassian documentation lists the Confluence macros that go through changes when converted to the new editor in Confluence Cloud.

On this page:

1 Overview
2 Prerequisites
- 2.1 Upgrade the Scaffolding app
- 2.2 Find all the Scaffolding macros
  - 2.2.1 Option 1: Use the Macro Usage details page
  - 2.2.2 Option 2: Use the SQL query below
  - 2.2.3 Relevant page titles SQL
  - 2.2.4 Relevant template SQL
- 2.3 Prepare the Scaffolding data in server
- 2.4 Create a staging instance, and perform a test migration on sample data
  - 2.4.1 Test migration with staging instance
  - 2.4.2 Test data by creating sample space
- 2.5 Schedule the migration window
- 2.6 Next Steps
- 2.7 Questions?

On this page:

1 Overview
2 Prerequisites
- 2.1 Upgrade the Scaffolding app
- 2.2 Find all the Scaffolding macros
  - 2.2.1 Option 1: Use the Macro Usage details page
  - 2.2.2 Option 2: Use the SQL query below
  - 2.2.3 Relevant page titles SQL
  - 2.2.4 Relevant template SQL
- 2.3 Prepare the Scaffolding data in server
- 2.4 Create a staging instance, and perform a test migration on sample data
  - 2.4.1 Test migration with staging instance
  - 2.4.2 Test data by creating sample space
- 2.5 Schedule the migration window
- 2.6 Next Steps
- 2.7 Questions?

Prerequisites

Review the following documents before starting the migration:

Upgrade the Scaffolding app

Update the Scaffolding app to at least version 8.25.0 through the UPM inside the Confluence administration console.

Click the global admin icon.
Click Manage apps.
Search for Scaffolding.
Ensure the app is updated to the most recent version.

Find all the Scaffolding macros

Ensure that the site search indexes are current.
Choose one of the 2 options below to assess data compatibility between the Scaffolding Server and the Cloud:

Option 1: Use the Macro Usage details page

The Macro Usage page will give you the number of Scaffolding macros on your site and the pages that contain them.

Navigate to Administration > Macro Usage.

look under Scaffolding.
Record:
1. the number of Scaffolding macros on your site.
2. identify how many cannot be migrated.

Select the macro links to show you all pages containing those macros.

Option 2: Use the SQL query below

Use the sample SQL queries below to help you gather all pages and templates that contain unsupported Scaffolding macros.

Relevant page titles SQL

This SQL will provide a list of impacted page authors and the relevant page titles that currently contain Scaffolding macros that are unavailable in the Cloud.

select s.spacekey, s.spacename, c.title as "Page Title", um.username
from content c, spaces s, user_mapping um left join cwd_user cu on um.username = cu.user_name
where c.spaceid = s.spaceid and c.contenttype = 'PAGE' and c.prevver is null and c.content_status = 'current'
and c.creator = um.user_key
and c.title in
(SELECT c.title
FROM CONTENT c
JOIN BODYCONTENT bc
    ON c.contentid = bc.contentid
JOIN SPACES s
    ON c.spaceid = s.spaceid
WHERE c.prevver IS NULL
    AND c.contenttype IN ('PAGE', 'BLOGPOST')
    AND bc.body LIKE '%ac:name="hidden-data"%'
		or bc.body LIKE '%ac:name="repeating-data"%'
		or bc.body LIKE '%ac:name="get-data"%'
		or bc.body LIKE '%ac:name="excerpt-data"%'
		or bc.body LIKE '%ac:name="eval-data"%'
		or bc.body LIKE '%ac:name="set-data"%'
		or bc.body LIKE '%ac:name="label-options"%'
		or bc.body LIKE '%ac:name="group-data"%')
order by s.spacekey, c.title

Relevant template SQL

This SQL will provide a list of impacted page authors and the relevant template titles that currently contain Scaffolding macros that are unavailable in the Cloud.

select s.spacekey, s.spacename, p.templatename as "Template Title", um.username
from pagetemplates p 
left join spaces s on p.spaceid = s.spaceid
left join user_mapping um on p.creator = um.user_key
--left join 
where p.prevver is null
--and p.creator = um.user_key
and p.content LIKE '%ac:name="hidden-data"%'
        or p.content LIKE '%ac:name="repeating-data"%'
        or p.content LIKE '%ac:name="get-data"%'
        or p.content LIKE '%ac:name="excerpt-data"%'
        or p.content LIKE '%ac:name="eval-data"%'
        or p.content LIKE '%ac:name="set-data"%'
        or p.content LIKE '%ac:name="label-options"%'
        or p.content LIKE '%ac:name="group-data"%'
order by s.spacekey, p.templatename ;

Prepare the Scaffolding data in server

Check the main templates that others are using and remove the structures that are incompatible with Cloud. The following documentation can help you with this step:
- macro differences and feature differences
- Cloud migration best practices

Detailed step-by-step instructions are available on this page - Global Template is not automatically migrated to Cloud.

Create a staging instance, and perform a test migration on sample data

Test migration with staging instance

Create a Staging environment licensed by a developer license.
Create a snapshot of the current Confluence server, and clone it for the staging instance.

Test data by creating sample space

Identify a space that contains:
1. Space templates that are widely used in your organization and use Scaffolding macros.
2. Pages with Live Templates that are using the Space templates.
Clone the contents of that space to a new space.
Now you are ready to migrate.
Prepare a migration window as highlighted below.
Go through the Test migration as highlighted in Step 1: Plan your Scaffolding migration | Find all the Scaffolding macros and Step 1: Plan your Scaffolding migration | Prepare the Scaffolding data in server

Schedule the migration window

To estimate the time you will need for the migration steps, we recommend reviewing all of the steps before executing.

Depending on the size of the data and the complexity of the existing template configuration, it may take a few hours to complete these steps.

Next Steps

Proceed to with Cloud Migration.

Questions?

Contact us via our support portal.

Step 1: Plan your Scaffolding migration