[BPMN Modeler] Cloud Migration
Features described on this page
Feature | Hosting Type | Release Version |
|---|---|---|
Cloud Migration - Automated Path with Cloud Migration Assistant | Server | DATA CENTER Cloud | 3.55.0-ENTERPRISE 3.55.0-C10-ENTERPRISE 3.0.0-CLOUD |
Cloud Migration - Automated Path (CMA) SERVER | DATA CENTER Cloud
|3.55.0-ENTERPRISE / 3.55.0-C10-ENTERPRISE, 3.0.0-CLOUD|
To be able to perform the below guide, please upgrade to the latest Releases on both, Confluence Data Center & Cloud:
Data Center:
Confluence 8/9: 3.55.0-ENTERPRISE or above
Confluence 10: 3.55.0-C10-ENTERPRISE or above
Cloud:
3.0.0 or above
The migration process requires the Confluence User BPMN Modeler Enterprise in Confluence Cloud to have sufficient permissions to VIEW and UPDATE Confluence pages and attachments. Please check your individual page permissions if you encounter problems (see [BPMN Modeler] Cloud Migration | Assessing the app migration)
BPMN Modeler Enterprise supports automatic Cloud Migration via Confluence Cloud Migration Assistant.
Workflow
Once added to the app migration plan, the Confluence Cloud Migration Assistant will perform the following steps:
Migrate your selected Confluence Spaces to Cloud
Inform BPMN Modeler Enterprise about the migration and start the app migration process
BPMN Modeler Enterprise app migration will consist of two chronological phases:
Macro Upgrade: In this phase, legacy “BPMN Modeler” macros on Confluence pages are upgraded to “BPMN Modeler Enterprise” macros.
Diagram Migration: In this phase, links within BPMN diagrams, such as links to Confluence pages, other diagrams or attachments are repaired to work seamlessly in your new Confluence Cloud environment. For more details, see [BPMN Modeler] Cloud Migration | Diagram Migration How it works
Please note that it can take up to 15 minutes for the app migration phases to be started once the prior phase is done. Also, the progress is updated only every several minutes.
Assessing the app migration
Once a migration phase is finalized, an overall status is indicated as either COMPLETE or FAILED. Note that a FAILED migration can be re-run any time. This allows to simply re-run the phase after taking necessary actions on the Cloud instance. To re-run a complete migration, please create a new app migration in Confluence Migration Assistant.
Please carefully study each migration’s log file even if the migration indicates complete to asses its success rate in detail.
Macro-Upgrade Logs
During the macro-upgrade phase, migrated Confluence pages are checked for the presence of legacy “BPMN Modeler” macros. The procedure will upgrade these macros in Confluence Cloud to “BPMN Modeler Enterprise” macros with a Confluence page update. Thus, the Confluence User “BPMN Modeler Enterprise” needs to have sufficient permissions to:
VIEW and UPDATE the Confluence page the diagram resides on
It is expected that most customers will not have any legacy macros left on their instances. Failed macro upgrades will only be indicated in the log file. The overall macro-upgrade status will not be set to “failed” to not block the diagram-migration phase.
It is possible to manually replace a legacy “BPMN Modeler” macro by creating a new “BPMN Modeler Enterprise” macro on the page with the exact same diagram name. The chosen diagram name determines which of the “.bpmn” file Confluence page attachments the macro picks up to display.
Diagram-Migration Logs
The diagram migration will check all Confluence pages with BPMN Modeler Enterprise macros for diagrams with repairable links. To assess and possibly repair a link in a diagram, the Confluence User “BPMN Modeler Enterprise” needs to have sufficient permissions to perform the following steps:
VIEW and UPDATE the Confluence page the diagram resides on
VIEW and UPDATE the related diagram’s attachment on this page
VIEW the linked content, such as pages or attachments
Depending on the different problems that can occur, the overall migration status is determined as follows:
failed If viewing or updating a Confluence page or its diagram attachment failed (most likely due to insufficient app user permissions)
COMPLETE If none of the above occurred, but migrating a single link within a diagram failed (most likely due to insufficient app user permissions on the linked resource) → To identify failed link migrations, please inspect the diagram-migration log file for entries with [Status: partial]!
COMPLETE If no errors occurred
Please note that even with a status failed , the procedure may have performed diagram migrations where possible.
Assessing the Diagram Migration
To assess your diagram migration in detail, the log file includes a more granular migration status for each processed Confluence page.
[Status: failure] - this outcome led to the overall migration status FAILED . So if your logs include an entry with that status, this is the reason why the migration is considered failed. You now have the possibility to fix potential permission problems and re-run the migration again.
[Status: partial] - some links within the diagram could not be migrated correctly but there were no issues to inspect or update the diagram itself. It could also be the case that linked resources were not part of your current or any prior migration and thus could not be repaired. Therefore, we do not consider failed link migrations as a failed migration in a broader sense. Please consult the Migration Report in the log file for details and possible solutions. To re-run the partial migration after fixes were applied (most likely app user permissions or migration of linked content), please set-up a new app migration within the Confluence Migration Assistant. All diagrams will be tried to be migrated again.
[Status: success] - no problems were identified.
Migration Report JSON
All log entries include a Migration Report in JSON format after the [JSON] keyword. This report includes details about occurred problems, drilled down to diagram-link level. To investigate the issues, please review this report and make necessary changes. Afterwards, re-run the migration.
Note that the Migration Report is valid JSON, but it might be necessary to replace all doubled double-quotes (““) with single double-quotes (“) before parsing.
Migration Report Structure
In the Migration Report above, we can see that
The Confluence Page “Insurance Processes” contained 1 BPMN Diagram “Handle Windshield Claim”
Two diagram versions were updated (the latest attachment version, and a diverging “currently published” version (see [BPMN Modeler] Cloud Migration | Diagram Migration How it works).
The overall migration status is “partial” → There were links in the diagram that could not be repaired
For simplicity, we investigate only problems of the migration of the latest attachment version here:
One link could not be repaired because the linked page (Data Center page id 63275009) could not be matched in Confluence Cloud. Possible reasons are:
The Confluence User “BPMN Modeler Enterprise” has no permission to VIEW the corresponding Cloud page
The Data Center page was not part of your current or any prior migration plan
The corresponding Cloud page was deleted
One link could not be repaired because the linked attachment “view-restricted-attachment-1.pdf” could not be found in Confluence Cloud. Possible reasons are
The Confluence User “BPMN Modeler Enterprise” has no permission to VIEW the corresponding Cloud attachment
The attachment was deleted in Cloud
The Data Center page containing the attachment was not part of your current or any prior migration plan (not applicable here, since we were able to map Data Center page 73400375 to Cloud page 42729555)
Diagram Migration - How it works
Our app primarily consists of two components: The macro on the Confluence page (i.e., the diagram you create) and a related Confluence page attachment “.bpmn” file. Essentially, the macro displays a specific version of the related diagram attachment. Every time a diagram is changed and saved, a new attachment version is created in the Confluence page attachments.
The “diagram-migration” phase updates either the latest and/or the currently published diagram attachment version. If the currently published version was updated, the macro is updated as well to now publish the migrated version. This happens through one Confluence page update for all macros on the page.
Note: Due to an arbitrary number of possible diagram versions, only the two versions (latest/published) are migrated. All other diagram versions are not processed.
The table below shows which attachment versions are updated during the “diagram-migration” phase in different scenarios:
Scenario 1: No links to repair in neither latest nor published version
| Example Version | Has reparable links? | Attachment Version is updated? | Macro/Page is Updated? |
|---|---|---|---|---|
Latest version | v3 |
| (v1 still published) | |
Published version | v1 |
Scenario 2: Published version and latest version have links to repair
| Example Version | Has reparable links? | Attachment Version is updated? | Macro/Page is Updated? |
|---|---|---|---|---|
Latest version | v3 |
| ->v5 | (v4 now published) |
Published version | v1 |
| ->v4 |
Scenario 3: Only latest version has links to repair, published version does not
| Example Version | Has reparable links? | Attachment Version is updated? | Macro/Page is Updated? |
|---|---|---|---|---|
Latest version | v3 |
| ->v4 | (v1 still published) |
Published version | v1 |
|
|
Scenario 4: Published version has links to repair, latest version does not
In this case, the latest attachment version is still updated to remain the “latest” version.
| Example Version | Has reparable links? | Attachment Version is updated? | Page is Updated? |
|---|---|---|---|---|
Latest version | v3 |
| ->v5 | (v4 now published) |
Published version | v1 |
| ->v4 |