Before moving your Confluence spaces to Cloud you should migrate any Scroll Exporter macros that are not available on Cloud to their respective Cloud compatible version. This is required if you have used the Scroll Exporter macros with Scroll PDF Exporter before version 4.1.0. and Scroll Word Exporter (formerly Scroll Office) before version 4.0.0.
The affected 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
- Scroll Office Ignore
- Scroll Office Ignore Inline
- Scroll Office Only
- Scroll Office Only Inline
- Scroll Office Indexterm
- Scroll Office Title
- Confluence Server instance (contains the Scroll PDF templates you want to migrate)
- Confluence Cloud instance with Scroll PDF Exporter 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
- Confluence Source Editor installed on Server instance (for Scroll PDF/Word Exporter v5.0.7 and older users)
For users of Scroll PDF Exporter and Scroll Word Exporter 5.1 (and later):
Disabling Collaborative Editing mode is required prior to following the steps below in order to avoid losing any unpublished changes when migrating pages using the Scroll Macro Migration tool.
In the most recent versions of Scroll PDF Exporter and Scroll Word Exporter it is possible to use the integrated Scroll Macro Migration Tool. This tool will automatically detect any pages in a space that contain deprecated Scroll Exporter app specific macros. When pages containing affected macros are identified by the tool, it is possible to easily migrate these macros to the supported Confluence Cloud format. To perform this migration in your chosen space please follow these steps:
- Navigate to; Space Tools > Apps > Scroll Exporter Extensions:
- Select the Start Migration button:
- After the migration task has finished, a success confirmation message will display:
- After completing these steps, the Scroll Macro content in the space remains compatible with Confluence Cloud (if imported). An empty state screen will display once all the pages containing the incompatible Scroll Macros have been migrated:
Migration Tool Information
Things to be aware of:
- Scroll Pagetitle Macro - due to the differences between Confluence Cloud and Server, the Scroll Pagetitle macro does not exist in Confluence Cloud as a Scroll macro. Instead, the same functionality of this macro can be achieved in Confluence Cloud via a setting in the Page tools (•••). This means that when running the Scroll Macro Migration Tool, the Scroll Pagetitle macro will be converted into a property that is recognised in Confluence Cloud. As a result the Scroll Pagetitle macro will be removed from the page(s) in Confluence Server and will not function anymore.
- Scroll Export Button Macro - customized export templates associated with the Scroll Export Button macro in Confluence Server will need to imported into Confluence Cloud for the Scroll Export Button macro to detect the required template again. If the template is not imported into Confluence Cloud, the Scroll Export Button macro will default to a bundled template included with the app. When manually importing the export templates, please ensure you update to the latest server version of the Scroll Exporter app before downloading the templates.
- Migration Process - after running the migration, it may take several minutes for the affected pages in the space to update within the Scroll Exporter Extensions tab.
For users of Scroll PDF Exporter and Scroll Word Exporter 5.0.7 (and older):
If you are using a version of Scroll PDF Exporter or Scroll Word Exporter 5.0.7 or older it will not be possible to automatically migrate the Scroll Macros using the Scroll Macro Migration Tool. We therefore recommend updating to the latest version where this tool is available and you can follow the steps above. If it is not possible to update to a version later than 5.0.7 you can follow the steps below for each page where these macros are used:
- Locate the affected page(s) via the Confluence search, for more details see Atlassian's documentation.
- Edit the page in Confluence
- Open the Confluence Source Editor by clicking the <> button in the top right
- Use the Search / Replace function on the top to apply the following changes:
- Search for scroll-pdf-ignore and replace it with scroll-ignore
- Search for scroll-pdf-ignore-inline and replace it with scroll-ignore-inline
- Search for scroll-pdf-only and replace it with scroll-only
- Search for scroll-pdf-only and replace it with scroll-only-inline
- Search for scroll-pdf-index-term and replace it with scroll-indexterm
- Search for scroll-pdf-title and replace it with scroll-title
- Search for scroll-exportbutton and replace it with scroll-export-button
- Search for scroll-office-ignore and replace it with scroll-ignore
- Search for scroll-office-ignore-inline and replace it with scroll-ignore-inline
- Search for scroll-office-only and replace it with scroll-only
- Search for scroll-office-only and replace it with scroll-only-inline
- Search for scroll-office-index-term and replace it with scroll-indexterm
- Search for scroll-office-title and replace it with scroll-title
- Close the Confluence Source Editor and Save the page
Limitations of manual migration approach for Scroll Macros
When not using the Scroll Macro Migration Tool (available in Scroll PDF/Word Exporter v5.1) there are a few limitations of using the described manual approach. These include:
- It is not possible to preserve the specificity of the Scroll macro for your chosen Scroll Exporter. For example, when searching and replacing a scroll-pdf-ignore macro, the new scroll-only macro parameter will be set to all Scroll Exporters, rather than just Scroll PDF Exporter.
- The Scroll Pagetitle will need to be added manually to the specific pages in Confluence Cloud following the steps here.
Still Unclear? Reach Out to Us
If you need help with any of these migration steps, reach out to us via email@example.com.