Scroll PDF Exporter
6.4 6.3 6.2 6.1 6.0 5.15 Cloud Data Center
6.4 6.3 6.2 6.1 6.0 5.15 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 PDF Exporter macros are:

  • Scroll PDF Exporter Ignore

  • Scroll PDF Exporter Ignore Inline

  • Scroll PDF Exporter Only

  • Scroll PDF Exporter Only Inline

  • Scroll PDF Exporter Indexterm

  • Scroll PDF Exporter 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

  • Confluence Data Center instance that contains the Scroll PDF Exporter templates you want to migrate

  • Confluence Cloud instance with Scroll PDF Exporter v6.4 and Scroll Exporter Extensions installed

  • On both instances:

    • Confluence admin permissions if you have global templates you want to migrate

    • Space admin permissions if you have space templates you want to migrate

Migration Steps

1. Migrate export templates

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

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.

2. Migrate Scroll Exporter-specific macros

For users of Scroll PDF Exporter 6.4 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-scroll-exporter-extensions-migrate-all-spaces.py (Python) or js-script-scroll-exporter-extensions-migrate-all-spaces.js (JavaScript).

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. 1.png

  2. Click Start Migration.
    2 - two.png

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

  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.
    5.png


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: