Versions Compared

Version Old Version 1 New Version Current
Changes made by

Shane Smith

Mariela Mihaylova

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

This document explains how to plan your Scaffolding migration.

Note

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

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

Info

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

On this page:

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledisc
typelist
printabletrue

Prerequisites

Review the

following documents

/wiki/spaces/DEVSCAFC/pages/1534558568 document before starting the migration

: Migrating from Scaffolding Server to Scaffolding Cloud

.

  • Feature differences document.

  • Macro differences breakdown.

  • Unsupported server scenarios upon migrations - Nesting Table Data 

  • Unsupported server scenarios upon migrations - Text Data

    • Click

    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 (blue star) icon.

    • If your pages contain Repeating Data macros, update the Scaffolding app to at least version 8.30.0 or 9.1.0.

    1. Select Administration ( (blue star) )> Manage apps.

    2. Search for Scaffolding.

    3. Ensure the app is updated to the most recent version.

    Find

    all

    the non-migratable Scaffolding macros

    1. Ensure that the site search indexes are current.

    2. Choose one of the

    2

    1. options below to assess data compatibility between the Scaffolding

    Server

    1. Data Center and the Cloud:

    Option 1: Use the Macro Usage details page

    The Macro Usage page

    will give

    can show you the number of Scaffolding macros on your site and the pages that contain them.

    Navigate

    1. Go to Administration > Macro Usage.

    Info
    Or

    You can also access the macro usage information via the shortcut <base-url>/admin/pluginusage.action.

    look

    1. Locate the macros under Scaffolding.

    2. Record

    :

    1. the number of Scaffolding macros on your site.

    identify

    1. Identify how many Scaffolding macros cannot be migrated.

    Info

    In this example, the

    ones

    macros marked

    will not be migrated to the Cloud.Select the macro links

    in red are not migratable to cloud.

    1. Click each macro link to show you

    all

    1. the pages containing

    those macros

    1. the corresponding macro.

    Image Removed
    scaffolding_macros_used.pngImage Added

    Option 2: Use

    the

    SQL

    query below

    queries

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

    This example uses PostgreSQL query syntax

    ; please

    . You must adjust usage according to your database syntax. Also, to avoid performance issues, limit the outcome to a smaller scope if needed (using limit

    may

    can help).

    Relevant page titles SQL

    This SQL

    will provide

    provides a list of impacted page authors and the relevant page titles that currently contain Scaffolding macros that are unavailable in

    the Cloud

    cloud.

    Expand
    titleQL query to find impacted pages...
    Code Block
    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

    provides a list of impacted page authors and the relevant template titles that currently contain Scaffolding macros that are unavailable in

    the Cloud

    cloud.

    Expand
    titleSQL query to find impacted templates
    Code Block
    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 InfoKnow your Scaffolding structure and data in server to anticipate incompatibilities in Cloud after migration. As the Scaffolding server is more versatile than Scaffolding Cloud, it is important that admins understand what's inside their scaffolding structure, and anticipate what is not migratable. 

    for migration

    Check the main templates and pages that

    others

    your users are using and remove the structures that are incompatible with

    Cloud. The following documentation can help you with this step:

    Due to CCMA Limitations: Global templates will not be migrated automatically and have to be manually migrated instead. (Bug report:  MIG-190 - Consider making the Confluence Assistant migrating Global Templates)

    Tip

    As a workaround, you can copy all Global Templates manually into Space Templates before the migration, in order to migrate them to Cloud. You may copy the migrated templates back to Global templates after the successful migration.

    Detailed step-by-step instructions are available on this page - Global Template is not automatically migrated to Cloudcloud. For information about the unavailable migration scenarios, refer to the /wiki/spaces/DEVSCAFC/pages/1534558568 document.

    Create a staging instance

    ,

    and perform a test migration on sample data

    Tip

    This is a recommended best practice step.

    Test migration with a staging instance

    Expand
    titleBest practices to do a test migration with a Staging staging instance...

    1. Create a Staging environment licensed by a developer license.

    2. Create a snapshot of the current Confluence server, Data Center instance and clone it for the staging instance.

    Test data by creating a sample space

    Expand
    titleBest practices to create test data by creating a Sample sample space

    1. Identify a space that contains:

      1. Space templates that are widely used in your organization and use Scaffolding macros.

      2. Pages with Live Templates Template macros that are using the Space space templates.

    2. Clone the contents of that space to a new space.

    3. Now you are ready to migrate.

    4. Prepare a migration window as highlighted below.

    5. Go through the Test migration as highlighted in https://appfire.atlassian.net/wiki/spaces/SCAFSSCAFC/pages/edit-v2/477607990#Find1356071387#Find-all-the-Scaffolding-macros and https://appfire.atlassian.net/wiki/spaces/SCAFSSCAFC/pages/edit-v2/477607990#Prepare1356071387#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 might take a few hours to complete these steps.

    Tip

    We advise you It’s a best practice to schedule a maintenance window in your organization to perform the migration in your organization.

    Next Steps

    Proceed to with

    Cloud Migration

    /wiki/spaces/DEVSCAFC/pages/1534297749.

    Questions?

    Contact us via our support portal.