Cloud Migration
- Michael Yang
1. Preparation for migration
Normally there are several steps you need to follow to migrate all your Easy Heading macros from Server/Data Center instances to Cloud for your pages.
1.1. Understand the differences between Data Center app and Cloud app
The functions and limitations are quite different between Data Center app and Cloud app because Confuence Cloud platform has some technical limitations on app development.
| Data Center app | Cloud app |
|---|---|---|
Floating Table of Contents displayed as a Column on the right side | ✔ | ✔ |
Floating Table of Contents displayed in Popup only when user move cursor hover on the floating icon | ✔ | ✔ |
Support Edit Mode | ✔ | ✖ |
Expand/Collapse Heading blocks on the page/blog (display mode) | ✔ | ✖ |
Automatically adjust the height of the sidebar and width of the page content when the size of web browser window is changed | ✔ | ✖ (need to set fixed pixel Sidebar Width and Max Height. User is able to change Max Height by dragging the bottom of the sidebar and save it in cookie.) |
Apply the plugin to a whole Space | ✔ (use wiki macro in space header/footer) | ✖ |
Byline link below title (shortcut to add/edit macro without entering edit mode) | ✖ | ✔ |
Related Links | ✔ (only support manually adding links) | ✔ (support manual links and filtering page links with labels) |
Number the Headings | ✖ | ✔ |
The parameter names are different between Data Center app and Cloud app, so during the migration process we need admin permission to modify the page contents to update the parameter names of the existing Easy Heading macros.
1.2. Upgrade your app to latest version of Data Center app
Since the version 3.3.0 of the Data Center app, it start supporting Cloud Migration, you should upgrade to the latest version.
If you are using Easy Heading Macro for Server, you have to uninstall it and install Easy Heading Macro for Data Center. Easy Heading Macro for Server is still free but is not supported any more since its final version 2.2.4. Easy Heading Macro for Data Center has converted to paid-app since Nov 2022.
Uninstalling the Server app and installing Data Center app won’t impact your existing macros. They are using the exact same codes and database (Active Object).
1.3. Upgrade Confluence Cloud Migration Assistant to latest version
Use the tool “Confluence Cloud Migration Assistant“ (CCMA) to do the migration for Easy Heading Macro. It supports Automated path (currently on Stage 1).
1.4. Needed Permission for the Migration
The user Easy Heading Macro requires “View” and “Add” permission to the pages and blogs of the spaces to be migrated. The migration process will have to update the storage view of the macros from server format to cloud format.
2. Steps for migration
2.1. Test migration in your sandbox environment
Because the migration process will update the contents of your pages so you must do testing in sandbox environment. We cannot guarantee that no potential issues would happen because the page content may contain unexpected content and even other macros which may have conflicts with our macro.
If you found any errors during your testing, please create a support ticket with the link below so we can do troubleshooting for you.
https://shineatlas.atlassian.net/servicedesk/customer/portal/5
2.2. Do migration in your production environment
Once you done testing in sandbox environment you can do migration in your production environment. Please don’t delete your spaces and pages in your Data Center instances before verifying the migrated contents are working well in your Cloud instance. In this way you can redo the migration after fixing problems.
2.3. Admin tool for migration remedy
After migration in your production environment, if there are still some pages failed to be converted, you could use the Migration Remedy admin tool to convert the remaining server macros to cloud macros without re-migrating only for the addon.
This is helpful especially when you have large number of spaces which the Easy Heading Macro app user doesn’t have Edit permission.
You can find this tool at: Apps → Manage apps → EASY HEADING MACRO → Admin Tools
(To use this tool you must have Edit permission to all spaces that you are migrating for)
3. Important Notice
Our Server macro has different storage view with Cloud macro so we have to convert and update all the pages/blogs which contain the server macros. This updates will take place during app migration process.
Because the reason above, after the migration the Last updated below the page title for all updated pages will show the user named Easy Heading Macro.
For any new parameters which only exists for cloud app, it will use default parameters when they are migrated from server to cloud. So please go to Default Parameters for Cloud to configure the parameters as admin user before migration.
We support Dual license for this app like Atlassian Products. We can provide free promotion for your Data Center for 1 year for your Cloud Migration. You can raise a support ticket or send email to us.
4. Trouble Shooting
The most possible error you may encoutered during the migration would be lack of permission to edit the page by the Easy Heading Macro. You can check it in the page of “Space tools - Permissions”.