Scroll HTML Exporter
4.6 4.5 4.4 4.3 4.2 Cloud Data Center
4.6 4.5 4.4 4.3 4.2 Cloud Data Center

Migration Path

Before you move your Confluence spaces to Cloud, migrate any Scroll Exporter macros that are not available on Cloud to their Cloud-compatible version. The affected Scroll HTML Exporter macros are:

  • Scroll HTML Ignore

  • Scroll HTML Ignore Inline

  • Scroll HTML Only

  • Scroll HTML Only Inline

  • Scroll HTML Indexterm

  • Scroll HTML Title

  • Scroll Export Button

  • Scroll Pagetitle

Admins can use the Macro usage option in the Confluence administration to see which macros are still in use.

Prerequisites

Migration Steps

1. Migrate export templates

Scroll HTML Exporter v4.6 or later

There are two ways to migrate your export templates from Data Center to Cloud:

  • Use the Confluence Cloud Migration Assistant (CCMA): With Scroll HTML Exporter v4.6 and later, the CCMA migrates your space templates automatically when you migrate the space. Global export templates are also migrated automatically.

or

  • Download and import: Go to the template overview where your export templates are stored, globally or in a space. Download each export template. The file has the .data extension. Then click Upload in the matching template overview on Confluence Cloud to import the file.

Scroll HTML Exporter v3.10.4 or earlier

Scroll HTML Exporter v3.x does not integrate with the Confluence Cloud Migration Assistant (CCMA). Because of technical differences in the templating process, you cannot migrate v3 export templates from Data Center to Cloud.

Instead, create new export templates. Use Scroll HTML Exporter v4.x on Confluence Data Center, or recreate the templates with Scroll HTML Exporter on Confluence Cloud. Learn how to create export templates.

After you set up your export templates, you can make further changes to the export output of the template theme. To do this, use the custom template customization option for post-export changes.

2. Migrate Scroll Exporter-specific macros

For users of Scroll HTML Exporter 4.6 and later

On Data Center, the Scroll Macro Migration Tool is part of Scroll Exporter Extensions, which is bundled with each Scroll Exporter app. On Cloud, Scroll Exporter Extensions is a separate app.

The migration covers the Scroll macros of all Scroll Exporter apps. If you use more than one Scroll Exporter app, you do not need to repeat it for each app. For more details, see migrating Scroll macros with Scroll Exporter Extensions.

Multiple Spaces to Migrate?

To run the macro migration for several spaces at once, download one of these scripts: Python script or JavaScript script.

Disable Collaborative Editing mode before you follow the steps below. This is required. Otherwise, you can lose unpublished changes on the pages that the tool migrates.

The Scroll Macro Migration Tool automatically detects all pages in a space that contain deprecated Scroll Exporter macros.

If the person running the migration only has view permissions in a space, they cannot see the list of affected pages (see Step 1 below). They also cannot convert the macros, because this requires edit permissions.

We recommend that a member of the confluence-administrators group runs the migration. They can see all affected pages and migrate the legacy Scroll macros.

If an admin has enabled read-only mode on the Data Center instance (for example, for site maintenance), the Start Migration button is grayed out and cannot be selected.

To migrate the affected macros in a space to the Confluence Cloud format, follow these steps:

  1. Go to Space Tools > Apps > Scroll Exporter Extensions.

  2. Click Start Migration.

  3. Wait for the migration to finish. A success message appears.

  4. When all pages with incompatible Scroll macros are migrated, an empty list appears. The Scroll macros in the space are now compatible with Confluence Cloud.

Migration Tool Information

Things to be aware of:

  • Scroll Pagetitle macro: In Confluence Cloud, the Scroll page title is not a macro. It is an action in the page tools menu (•••) called Set Scroll Page Title. The migration tool converts each Scroll Pagetitle macro into this setting.

  • Scroll Export Button macro: If the Scroll Export Button macro uses a customized export template, import that template into Confluence Cloud. Otherwise, the button uses a bundled template that comes with the app. Before you download templates for a manual import, update your Scroll Exporter app to its latest Data Center version.

  • Migration process: After the migration, it can take several minutes until the list of affected pages in the Scroll Exporter Extensions tab updates.

Still Unclear? Reach Out to Us

If you need help with any of these migration steps, reach out to us via help@k15t.com.

Last updated: