Confluence Migration Toolkit
Confluence Migration Toolkit
All the tools that you need to successfully migrate from Confluence to XWiki. Includes technical support on XWiki, all Pro Apps and recommended extensions. Try it free!
| Category | Other |
| Rating | |
| Support |
XWiki SAS
|
| License | GNU Lesser General Public License 2.1 |
| Minimal XWiki version supported | 13.10 |
| Sources | Issues |
Migrate your Confluence data, page history, users, permissions, attachments and metadata in just a few minutes using this set of dedicated tools. All the applications that you need to migrate are automatically installed.
Once your migration is done, enjoy the long term technical support covering XWiki, all Pro Apps, supported extensions and community extensions (best effort).
To migrate from Confluence to XWiki you will need:
- an XWiki instance with administrator access (advanced user, view hidden pages)
- access to your XWiki instance's configuration files, if you are running XWiki on your premise
- a Confluence server XML backup file
Please follow the instructions in the "Documentation" tab for a full breakdown of each step.
- Confluence Migrator
- Comparison between Confluence and XWiki concepts
- Batch migration
- Post Migration fixes
- Pro Macros
- Metadata migration
- Documentation archive
Confluence Migrator
Prerequisites
- an XWiki instance with administrator rights
- access to your XWiki instance's configuration files (if you are running XWiki on premise)
- Confluence Migration Toolkit installed on your XWiki instance
- administrator access to the Confluence instance that you wish to migrate content from or a server XML backup file
Once you have installed the Confluence Migration Toolkit, please follow the steps below.
Go to the Confluence Migrator Pro application, open the prerequisites section and perform the necessary configuration in order to make sure the XWiki instance will support the data migration.
If a prerequisite is met, a checkmark will appear next to its respective line in the dedicated section.
Data migration
Data is imported from Confluence using their XML backup. There are two kinds of XML backups:
- (Full) Site backup. this exports everything from a Confluence instance, including all spaces, users and groups. They are suitable for small sites. For larger sites, exports will likely fail, possibly after a few hours or days of producing the export, and if it succeeds, it may not be practical to import such a large package in XWiki
- Space backups. Each space can be backed up individually. They don't contain users or groups, which will need to be imported through another mean (using LDAP, Active Directory or Azure AD for instance). They are suitable for larger sites. We have a feature to import them by batches. On the Confluence side, the production of backups can be scripted.
Upload export packages into XWiki
In order to migrate your data, first attach the Confluence backup files in the dedicated section of the migrator.
You will be able to attach multiple files and start the data migration from any of them. It is also possible to use a space export. If your Confluence backup fails to upload please make sure that your XWiki instance has enough storage and memory, and also that the attachment limit is not too low. If you are using XWiki in the Cloud, please contact the support team, in order for them to perform the necessary configuration.
Once you have identified the export file that you wish to use, click on "Select package". You will be redirected to the title page, where you can name your migration and configure the import options.
Select export packages from the server
Alternatively, if the Confluence export packages are placed on a machine that XWiki has access to, please use the "Select an export from server" option:
If you wish to modify the default import configuration, for example, to skip user import or to not preserve history, click on "Advanced migration options". Please see below the documentation on each parameter of the Advanced migration options.
Once you are satisfied with the configuration, click on "Save & View". You will be redirected to the package analyser step. The analysis of the package may take a while if the export is very large.
Once the analysis of the package is done, the list of spaces will appear. You can select all, multiple or one space and search for a space based on their key. If a single space export is used, this step is skipped.
After you have selected all the spaces that you wish to migrate in this run, click on "Confirm". You will be redirected on the import log page. The process of importing and moving the pages into their correct location may take a while if the export is very large.
Finally, when the data migration is done, you will be redirected to the report page, where you will see the pages that have been successfully imported, along with the ones affected by errors and links issues.
You will be able to also later review the report by clicking on the migration page in the application's homepage. Moreover, you can run multiple migrations in parallel and see their status.
Advanced migration options
You can fine-tune your migration by configuring the advanced migration options. Please see below the details on each parameter:
Properties of the input filter stream (Confluence XML)
The Confluence XML package provides many parameters to customize a confluence import.
| Parameter name | Description | Example value | Default value | |
|---|---|---|---|---|
| Import archived documents | Confluence exports can contain archived documents. XWiki doesn't have a concept of archived document. This parameter lets you optionally import archived documents as regular XWiki documents instead of ignoring them. | false | ||
| Import archived spaces. | Confluence exports can contain archived spaces. XWiki doesn't have a concept of archived space. This parameter lets you optionally import archived spaces as regular XWiki spaces instead of ignoring them. | false | ||
| Import attachments | If you don't want to import document attachments, set this to false. | true | ||
| Base URLs | The list of base URLs leading to the Confluence instance. They are used to convert wrongly entered absolute URLs into wiki links. The first URL in the list will be used to compute page URLs used in the conversion report if the the 'Store Confluence details' property is used. This parameter is used to convert (fix) absolute URLs present as links in the documents that will get imported. The bases of this URLs should be input in this field so that they are converted from the Confluence to the XWiki links. For example, adding in this field www.<myconfluence>.com/wiki/spaces will convert absolute links such as www.<myconfluence>.com/wiki/space/KEY/page into www.<myxwiki>.com/bin/view/KEY/page. | N/A | ||
| Blog Space name | This field defines the name of the space under which blog posts will be imported. By default, a "Blog" space will be created under "SPACE KEY". | Blog | ||
| Import blog posts | This field decides whether to import blog posts or not. By leaving the default value "true", blog posts will be imported. By changing the value to "false", blog posts will not be imported. | true | ||
| Cleanup mode | The mode to use for cleaning up temporary files produced when parsing the Confluence package.
| SYNC ASYNC in the Confluence Migrator Pro Application | ||
| Produce rendering events for the content | Parse the content to produce rendering events (if the output filter supports them). This is needed in very specific conditions. We do not recommend modifying this parameter unless you know what you are doing. | false | ||
| Import contents | This parameter defines whether to import the body and set content of regular documents and blog posts (if blog posts are imported). We do not recommend modifying this parameter. | true | ||
| XWiki Conversion | This parameter defines whether to convert
This is needed in very specific conditions. We do not recommend modifying this parameter unless you know what you are doing. In particular, XWiki may not be able to render your imported documents and links will probably be broken if you disable this. | true | ||
| Default locale | This parameter defines the locale that will be used for the imported documents. Usage example: you have a xwiki instance that you want to be localized with both en and fr. The default locale for your instance is en. You have a Confluence instance that has its content in French. You import from Confluence to XWiki and all the created documents will have their locale set to your xwiki default locale (en) and the content brought from Confluence wwill be in French. Ideally, you set the parameter default locale to "fr" so all the imported documents will have their locale equal to "fr". Now, if you want to also have an English version of the documents, you create it and translate it. | fr | N/A | |
| Page name validation | This parameter defines whether the pages should be validated against and converted using XWiki's current page naming strategy. This works if the XWIKI CONVERSION field is set to "true". This is needed in very specific conditions. We do not recommend modifying this parameter unless you know what you are doing. In particular, XWiki may not be able to render your imported documents and links will probably be broken if you disable this. | true | ||
| Excluded pages | List in this field the Confluence pages to ignore from the import. The format is a comma separated list of page IDs where each number is a page id. See also the Ranges and the Included pages parameters. | 543234,123123,65423 | ||
| Group Format | The group format to use to transform a Confluence group names to XWiki group names. String ${group} will be replaced with the group Confluence name; String ${group._clean} same with the special characters removed.| ${group._clean} | | |||
| User Format | The user format to use to transform a Confluence user names to XWiki user names. String ${username} will be replaced with the user Confluence name; String ${username._clean} same with the special characters removed. If this parameter is left empty, forbidden characters (spaces, dots, forward slashes) will be replaced by _ || | |||
| Import history | Set this to false if you want to discard previous revisions of documents (for performance, space or import speed concerns) | true | ||
| Home redirect | When non nested import is used, home pages are renamed so they can be the home page of spaces in XWiki. If set to true, redirects are output so links to these pages are not broken. When nested import is used, this parameter is ignored. | true | ||
| Included pages | This field allows you to specify pages that should be imported. The format is a comma separated list of page IDs where each number is a page id. See also the Ranges and the Excluded pages parameters. | 543234,123123,65423 | ||
| Macro content syntax | This parameter defines the target syntax to be used. This is needed in very specific conditions. We do not recommend modifying this parameter unless you know what you are doing | N/A | ||
| Max Page count | if you want to limit the number of imported pages, set this to the desired number. -1 disable any limitation | -1 | ||
| Import non-blog content | This field defines whether to import non-blog contents (normal documents) or not. When this parameter and the IMPORT BLOG POSTS are set to "true", both regular pages and blog posts get imported. Set this parameter to "false" if you wish to import only blog posts present in an export package. | true | ||
| Object ID ranges | Ranges of Confluence objects to read. Can be used to restore an interrupted migration. Several comma-separated ranges can be given. Note that the order used for these ranges are not increasingly big ids, but in the order they are processed by the Confluence module. This order may change between versions of the parser, but is guaranteed to be the same between different runs using the same version of the Confluence module. Ranges must not overlap. Overlapping ranges are not supported, may lead to surprising results and their behavior is not guaranteed to be stable. In the same vain, ranges must be ordered in the parsing order. |
| ||
| Prefixed macros | This field stores an allowlist of macros that should be prefixed. A few macros exist both in XWiki and in Confluence under the same name. In order to allow the usage of the bridge macros (dedicated to displaying content in the same manner as it was in Confluence), those macros should be prefixed so that the bridge macros (e.g. "confluence_gallery") are used and not the original XWiki macro (e.g. "gallery"). We do not recommend modifying this parameter. | attachments,gallery,chart | ||
| Import favorites | Import Confluence favorites into the Favorites Application. Requires the Favorites Application to be installed. | true | ||
| Translated content support | Whether pages containing different languages should be converted to translated XWiki documents. If disabled, the supported language macros will be converted to the contentTranslation macro. An implementation of this macro can be found in the Book Versions application. | true | ||
| Import rights |
| true | ||
| Root | The wiki or space in which pages will be imported. Note: Make sure your set 'Users wiki' accordingly | wiki:sub, space:sub:RootInSubWiki, MyRootInCurrentWiki, My.Migration, sub:My.MigrationInSubSpace. | ||
| Space renaming format | Specifies the format used to rename a space in case of a name conflict. The placeholder ${spaceKey} is replaced with the conflicting Confluence space name. If the resulting name still conflicts, underscores _ are appended as needed. | ${spaceKey}_ | ||
| Overwrite protected spaces | A comma-separated list of XWiki spaces that should not be overwritten during a Confluence import. If a Confluence space conflicts with a protected space, a new space will be created. The new space name will follow the Space renaming format, with underscores added if further conflicts occur. | FAQ | ||
| Overwrite protection mode | Defines how conflicts with existing XWiki spaces are handled. There are 3 available modes:
| NONCONFLUENCE | ||
| Title spaces from their home page | Title spaces using the Confluence home page titles instead of the Confluence space names. Home pages in Confluence are usually named something like "Home" or "SPACENAME Home", which is not very helpful. In Confluence, spaces are named and that's usually what you want as the title of spaces in XWiki. However, if you happen to have useful home page titles, you may want to set this to true. Space name are always taken from Confluence space keys regardless what you choose here. | false | ||
| Store Confluence details | This parameter specifies whether to store Confluence metadata in migrated documents as objects. This is usually useless, but in some cases, this metadata can be useful for debugging purposes and might end up useful to support CQL-based Confluence macros like spacebylabel or detailssummary in the future. | false | ||
| Import tags | Set this to false if you don't want Confluence labels to be migrated to XWiki tags | true | ||
| Unknown macro prefix | This field defines the prefix to be used for the macros specified in the "Prefixed macros" field. See also the Unprefixed macros parameter. We do not recommend modifying this parameter. | confluence_ | ||
| Use Confluence Resolvers | When there is a link to a page not present in the imported package, use Confluence resolvers present in the wiki. | false | true | |
| Unprefixed macros | This field stores a denylist of macros that should not be prefixed. We do not recommend modifying this parameter. If set (not empty), takes precedence over "Unknown macro prefix": any macro that is not listed in the Unprefixed macros will be prefixed and the Unknown macro prefix will be ignored. If you want to prefix absolutely all macros, set this to an unlikely macro name. | N/A | ||
| User id mapping | A mapping between Confluence user id located in the package and wanted ids. Similar to Group name mapping, this field stores a list of A=B couples separated with a pipe character (|) where A is the name of a Confluence user and B is the desired user name in XWiki. | user1=User1|charliedo=CharlieDo|ConfluenceAlice=Alice|ConfluenceBob=Bob | ||
| Produce user references | This parameter defines if links to user profiles should be created for existing Confluence user profile links. | false | ||
| Group id mapping | This field offers the option to specify a list of A=X relations where A is a Confluence group id and X is a Confluence group name. A will be understood as Confluence group X. These sets are separated using the pipe character (|). This is the same format as for the User id mapping. When using a Confluence space export, this information is missing and macro parameters which refer to group ids won't be converted correctly. This parameter helps work around this issue by providing the missing information. This parameter is used to migrate macros referring to Confluence groups in their parameters using their ids instead of their names. | a39e82d8-1c93-4395-9358-dc67f2ffa3ef=balsamiq-mockups-editors|a39e82d8-1c93-4395-9358-dc67f2ffa3ef=administrators|a78122a5-a46d-497e-904c-3cffd763de31=site-admins | ||
| Group name mapping | This field offers the option to specify a list of A=X relations where A is a Confluence group name and X is a XWiki group name. Confluence group A will migrated to XWiki group X. These sets are separated using the pipe character (|). This is the same format as for the User id mapping. When using a Confluence space export, this information is missing and macro parameters which refer to group ids won't be converted correctly. This parameter helps work around this issue by providing the missing information. | atlassian-addons=|balsamiq-mockups-editors=MockupEditors|group1=MyGroup | administrators=XWikiAdminGroup|site-admins=XWikiAdminGroup|_licensed-confluence=|confluence-users=XWikiAllGroup|users=XWikiAllGroup|confluence-administrators=XWikiAdminGroup|system-administrators=XWikiAdminGroup | |
| Import users | Import the users found in the Confluence package. If this parameter is set to true, user profiles present in the export package will be imported into XWiki. Setting this parameter to "false" may be needed if you use a central user directory service like LDAP or Active Directory, in which case you need to decide on a careful user migration strategy. See also the "Import groups" parameter. | true | ||
| Import groups | Import the groups found in the Confluence package. If this parameter is set to true, groups present in the export package will be imported into XWiki. Setting this parameter to "false" may be needed if you use a central user directory service like LDAP or Active Directory, in which case you need to decide on a careful user migration strategy. See also the "Import users" parameter. | true | ||
| Users wiki | The wiki where users and groups are located. You can specify here the wiki in which users and groups are located. | N/A (current wiki) | ||
| Verbose | This field defines whether to create detailed import logs or not. If you are using the Confluence Migrator Pro Application, we do not recommend modifying this parameter. | true | ||
| Link Mapping | This field defines the link mapping to use to produce the correct links to pages missing from the Confluence package. Note: In Confluence Migrator Pro, this parameter is hidden and automatically managed. | { "spaceKey1": { "page title 1": "Space.Doc1", "page title 2": "Space.Doc2" }, "spaceKey2": { "page title 3": "Space.Doc3", "page title 4": "Space2.Doc4" }, "spaceKey:ids": { "42": "Space.Doc5" }, ":ids": { "43": "Space.Doc6" } } | ||
| Confluence Instance Type | The type of Confluence instance used to produce the backup package being imported. There are some differences in how content is managed, anchors for example are not the same. Knowing the right Confluence instance will improve the fidelity of the import. Detecting the right type of instance will be attempted if an empty value is provided. Possible values: SERVER, CLOUD. It is recommended to leave this empty, as the data is in the export packages and if it's not present, then SERVER can normally be implied | SERVER |
Imported macros
At the end of each migration you will obtain a list of all the macros present in the imported package and their supported status (supported, partial, not supported). On the Confluence Migrator Pro's homepage the summary of all the macros, along with their number of occurrences is displayed:
Macro migration
XWiki and Confluence both have their sets of macros, usually used to present content in a particular manner. In order for a macro used in Confluence to display in the same manner in XWiki, the macro has to have the same name and supported parameters. In an effort to make the transition as easy as possible for organizations that migrate from Confluence to XWiki, the Pro Applications team has dedicated significant efforts to make sure the Confluence macros are converted to an equivalent XWiki macros. We also have developed macros that closely match the most used Confluence macros: Pro Macros. For some macros that are harder to migrate to native equivalent, we have developed what we call bridge macros. We propose native XWiki alternatives for them, to be used post migration. All bridge macros are prefixed with "confluence_" and the unprefixed version is also supported for compatibility reasons, for users that migrated before the prefix was introduced.
For the macros for which we do not support migration and that are used on the Confluence instance, the wiki content will be imported, but they will not be displayed in XWiki identically to the Confluence counterpart. In view mode, an error message will appear, while in wiki edit mode, the syntax and content of the macro will be visible. As the wiki content will be imported and stored, if one of the currently unsupported macros will become available in the Pro Macros package, the content will subsequently be displayed identically to the Confluence counterpart following the update and introduction of said macro in the Pro Macros.
If one or multiple macros are required, the Client may choose to sponsor the development of those macros. Please contact sales@xwiki.com if you would like to inquiry about the development of certain macros.
We document how we migrate each Confluence macro in our Confluence macro documentation:
Below is a table that shows how well we support the migration for each Confluence macro.
| Macro name | Migration supported | Comments |
|---|---|---|
| expand | Yes | |
| details | Yes | |
| toc | Yes | |
| jira | Partial | Parameters : server, columns id, columns, jqlQuery, serverId. Depends on the parameters supported. |
| children | Yes | Basic version of the macro is available. Some parameters are missing. |
| recently-updated | Yes | |
| anchor | Yes | |
| panel | Yes | |
| view-file | Yes | |
| status | Yes | |
| info | Yes | |
| create-from-template | No | Already included in the standard «Create» wizard of XWiki. Should not be migrated |
| code | Yes | |
| contentbylabel | Yes | |
| include | Yes | |
| tasks-report-macro | Yes | Part of the Task Manager (Pro) application |
| display-footnotes | No | |
| pagetree | Yes | |
| detailssummary | Yes | |
| warning | Yes | |
| tip | Yes | |
| note | Yes | |
| attachments | Yes | |
| column | Yes | |
| excerpt-include | Yes | |
| section | Yes | |
| excerpt | Yes | |
| pagetreesearch | Yes | |
| profile-picture | Yes | |
| contributors | Yes | |
| livesearch | Yes | mapped to Search Location Macro |
| roadmap | No | |
| blog-posts | No | Migrate to the Blog application. Complexity depends on the parameters to migrate |
| noformat | Yes | |
| viewxls | Yes | |
| gliffy | Yes | |
| table-filter | No | |
| ui-expand | No | |
| mathinline | Yes | |
| calendar | No | Configurable calendar macro. Date macro exists. |
| change-history | Partial | Same information as the History panel, which is displayed by default in the page. The migration will imply removing the change history macro and using the history tab. |
| ui-button | No | |
| style | No | Migrate to SSX |
| jirachart | No | Improvements of the JIRA macro |
| div | No | |
| gadget | No | |
| navmap | Yes | Macro is migrated to "contentbylabel" with parameters, obtaining the same list of links to pages. The visual result is not identical. |
| widget | Partial | Embed macro should be used after migration |
| pivot-table | No | |
| viewppt | Yes | |
| table-chart | No | |
| listlabels | in progress | |
| scroll-ignore | No | |
| viewpdf | Yes | |
| auitabspage | No | |
| auitabs | No | |
| status-handy | No | |
| jira-key | No | Migration to the XWiki JIRA macro, which is already capable to display the status of a single issue. |
| content-report-table | Yes | |
| multiexcerpt | Yes | |
| ui-tab | No | |
| ui-tabs | No | |
| chart | No | |
| table | No | |
| auihorizontalnav | No | |
| plantuml | Partial | |
| unmigrated-wiki-markup | No | |
| numberedheadings | No | |
| popular-labels | No | Migration to tag cloud |
| bgcolor | No | |
| table-excerpt-include | No | |
| ui-text-box | No | |
| table-joiner | No | CQL parser required |
| multiexcerpt-include | Yes | |
| table-excerpt | No | |
| outgoing-links | No | |
| task-list | Yes | Part of the Task Manager (Pro) application |
| userlister | Yes | |
| confluence-advanced-macros | No | |
| footnote | No | |
| viewdoc | Yes | |
| live-template | No | |
| drawio | Yes | |
| pagestatus | No | |
| confluence-information-plugin | No | |
| jira-jqlQuery | No | Migration to the XWiki JIRA macro, which is already capable to execute JQL queries |
| ui-step | No | |
| ui-steps | No | |
| multimedia | Yes | |
| tasklist | Yes | Part of the Task Manager (Pro) application |
| html | Yes | in some instances macro call is html-macro |
| survey | No | |
| markdown | No | |
| tooltip | No | |
| spreadsheets | No | |
| gallery | Yes | |
| vote | No | |
| hideelements-macro | No | |
| scroll-exportbutton | No | |
| unmigrated-inline-wiki-markup | No | |
| mathblock | Yes | |
| scroll-pagebreak | No | |
| toc-zone | Yes | |
| incoming-links | No | |
| htmlcomment | Yes | XWiki HTML macro should be used after the migration |
| insight-objects-macro | No | |
| linkgraph | No | |
| dbbox | No | |
| report-info | No | |
| report-table | No | |
| timestamp | No | |
| pageapproval | No | |
| scroll-pagetitle | No | |
| scroll-tablelayout | No | |
| auiprogress | No | |
| auiprogressstepstatic | No | |
| get-metadata | No | |
| favpages | No | |
| loremipsum | No | |
| polls | No | |
| add-label | No | |
| contributors-summary | No | |
| profile | Yes | |
| mockup | Yes | |
| scroll-landscape | No | |
| add-page-form | No | |
| shared-block | No | |
| scroll-imagemap | No | |
| json-from-table | No | |
| add-page | No | |
| lucidchart | No | |
| multivote | No | |
| table-plus | Partial | |
| center | No | Migrate to XWiki syntax. |
| rw-search | No | |
| scroll-only | No | |
| metadata | No | |
| user-macro | No | |
| tel | No | |
| oitlogo | No | |
| link-to | No | |
| scroll-title | No | |
| jiraissues | No | |
| list-permitted-users-macro | No | |
| workflowreport | No | |
| sharelinks-urlmacro | No | |
| scroll-portrait | No | |
| search | No | |
| unit | No | |
| card | Yes | Existing tabs macro should be used after the migration |
| deck | Yes | Existing tabs macro should be used after the migration |
| wireframe | Yes | |
| rss | No | |
| tr | No | Migrate to XWiki syntax |
| ui-children-cards | No | |
| pagebreak | No | |
| tableplus | No | |
| link-window | No | |
| plantumlrender | No | |
| conditionalcontent | No | |
| auimessage | No | |
| metadata-from | No | |
| flowchart | No | |
| auibutton | No | |
| th | No | Migrate to XWiki syntax |
| sv-translation | No | |
| topusers | No | |
| include-shared-block-inline | No | |
| questionslist-macro | No | |
| inc-drawio | Yes | Diagram macro should be used after the migration |
| span | No | Macro to generate wiki syntax |
| globaltimeline | No | |
| include-shared-block | No | |
| discussion-information-box | No | |
| discussion-contributors | No | |
| childtabs | No | |
| discussion-list | No | |
| redirect | Yes | |
| latex | No | |
| lastmod | No | Equivalent to recently updated macro |
| portfolio-for-jira-plan | No | |
| usage | No | |
| spaceaccessusersminimal | No | |
| space-attachments | No | |
| countdown | No | |
| recently-updated-dashboard | No | "legacy macro" according to confluence docs, which seems to recommend the "recently updated macro" instead |
| collapsible-panel | No | |
| join-event | No | |
| join-event | No | |
| playsql-query | No | |
| choose-label | No | |
| english | No | |
| scroll-ignore-inline | No | |
| pocketquery | No | |
| tbd | No | |
| cql-search | No | |
| italian | No | |
| page-info | No | |
| pageactivity | No | |
| img | Yes | Migrate to XWiki syntax |
| highlight | No | |
| pagetreecreator-button | No | |
| csv | No | |
| progress-bar | No | |
| index | No | |
| pagetreecreator-default-value | No | |
| csv-table | No | |
| align | No | |
| alert | Yes | Message macro should be used after migration |
| json-table | Partial | |
| mermaid-macro | No | |
| visio | No | |
| button | No | Similar generic macro available |
| spacegraph | No | |
| talk | No | |
| spaces | No | |
| popular | No | |
| iframe | Yes | Migrate to XWiki syntax + HTML macro |
| excel | Yes | View File macro should be used after migration. Single sheet display is not currently supported. |
| divbox | No | Could be translated to standard wiki syntax |
| miro | No | Advanced embed : possibility to define how to display Miro drawings |
| viewfile | Yes | |
| cheese | No | |
| scroll-office-ignore | No | |
| new-anchorpage | No | |
| scroll-content-block | No | |
| related-labels | No | |
| contact-qr-code | No | |
| fancy-bullets | No | |
| auibuttongroup | No | |
| create-page | No | |
| ancestor-labels | No | |
| viewpdf | Yes | |
| space-breadcrumbs | No | |
| discussion-summary | No | |
| metadata-report | No | |
| discussion-space-contributors | No | |
| space-metadata | No | |
| aui-tab-group | No | |
| handy-tip | No | |
| ptc-template-properties-macro | No | |
| excerpt-includeplus | Yes | |
| upcoming-events | No | |
| localtab | No | |
| parent-link | No | |
| html-include | No | |
| localtabgroup | No | |
| creation-infos | No | |
| event-calendar | No | |
| content-by-user | No | |
| scroll-pdf-ignore | No | |
| roundrect | Yes | Panel macro should be used after migration |
| pagetreecreator-multi-button | No | |
| pre | No | |
| cloak | No | Re-use the existing show/hide macro |
| toggle-cloak | No | Re-use the existing show/hide macro |
| link-page | No | |
| attachment-table | Yes | Confluence Attachments macro should be used after migration |
| talk-report | No | |
| math | No | |
| handy-carousel | No | |
| auidialog | No | |
| spaceaccessusers | No | |
| tabs-group | No | |
| tab-pane | No | |
| document-states-report | No | |
| include-version | No | |
| alias | No | |
| handy-post-organizer | No | |
| horizontal-nav-group | No | |
| horizontal-nav-item | No | |
| nav-group-advanced | No | |
| nav-item-advanced | No | |
| lozenge | No | |
| ui-image | No | |
| google-calendar | No | |
| mathdisplay | No | |
| network | No | |
| ptc-tag-description | No | |
| recently-used-labels | No | |
| tracking-info | No | |
| includeplus | No | |
| plantumlreader | No | |
| spreadsheet-table | No | |
| child-counter | No | |
| version-history | No | |
| space-details | No | |
| scroll-office-only | No | |
| mathblock-ref | Yes | |
| search-box | No | |
| ptc-template-page-properties-macro | No | |
| priority1 | No | |
| rw-users | No | |
| clickable | No | |
| question-answer-list-macro | No | |
| scroll-office-only-inline | No | |
| imagemap | No | |
| checkbox-list | No | |
| confluence-button | No | |
| include-children | No | |
| scroll-pdf-only | No | |
| create-space-button | No | |
| latex-formatting | No | |
| map | No | |
| priority2 | No | |
| checkbox | No | |
| german | No | |
| auihorizontalnavpage | No | |
| handy-reminder | No | |
| im | No | |
| markdown-from-url | No | |
| page-status | No | |
| confluence-open-api | No | |
| database-structure | No | |
| document-stats-report | No | |
| sv-pagetree | No | |
| scroll-only-inline | No | |
| priority3 | No | |
| recently-updated-dashboard-category | No | |
| rw-pagetree | No | |
| rw-news | No | |
| navitabs | No | |
| global-reports | No | |
| flowchartrender | No | |
| scroll-bookmark | No | |
| orpheaned-links | No | |
| metadata-values | No | |
| timeline-template | No | |
| zeiterfassung | No | |
| confiform | No | |
| confiform-value | No | |
| ptc-jira | No | |
| listallgroups | No | |
| mugshot-gallery | No | |
| pageapproval-report | No | |
| space-metadata-list | No | |
| metadata-list | No | |
| noprint | No | |
| ui-children | No | |
| pagetitle | No | |
| page-view-macro | No | |
| vertical-nav-group | No | |
| vertical-nav-item | No | |
| sp-infobulle | No | |
| scroll-indexterm | No | |
| scroll-office-index-term | No | |
| scroll-office-ignore-inline | No | |
| workflow-reporter | No | |
| metadata-calculate | No | |
| database-info | No | |
| playsql-chart | No | |
| vbcp-macro | No | |
| confiform-entry-register | No | |
| course-list | No | |
| format-text | No | |
| page-permissions | No | |
| scroll-to-top | No | |
| gatracking | No | |
| space-news | No | |
| rw-users-space | No | |
| rw-favpages | No | |
| spaceadmins | No | |
| childrenbylabel | No | |
| surveydisplay | No | |
| french | No | |
| japanese | No | |
| increment-metadata | No | |
| space-metadata-from | No | |
| metadata-table | No | |
| atlassian | companion | |
| diagramly | No | |
| subpages | No | Equivalent to children macro |
| wiki-markup | No | |
| rate | No | |
| aui-pages-by-label-tab | No | |
| searchandsortbydate | No | |
| contributor | Yes | |
| ptc-jira-automation | No | |
| bibtex-display | No | |
| tbody | No | |
| userloginlist | No | |
| space_administrators | No | |
| labeltabs | No | |
| canadian-en | No | |
| lock-content-macro | No | |
| currency-converter | No | |
| view-generic-group-rule-execution-logs | No | |
| view-export-rule-execution-logs | No | |
| handy-post-organizer-content | No | |
| chinese | No | |
| english-us | No | |
| layout | Yes | |
| td | No | Migrate to XWiki syntax |
| composition-setup | No | Cannot be migrated. Specific to the Composition extension |
| float | Partial | XWiki syntax should be used after migration |
| jira-chart | No | |
| banner | No | |
| showcase | No | |
| show-card | No | |
| bibtex-reference | No | |
| getbitbucketadmins | No | |
| getitrackusers | No | |
| jql-table | No | |
| lastupdateddate | No | |
| mathjax-block-macro | Yes | |
| mathjax-inline-macro | Yes | |
| monthcalendar | No | |
| prezi | No | |
| privacy-mark | No | |
| rest-table | No | |
| table-enhancer | No | |
| wasdalink | No | |
| database-query-compact | No | |
| csv-export | No | |
| google-map | No | |
| tableenhancer | No | |
| dynamic_checkboxes | No | |
| signature | No | |
| graphity | No | |
| gallery | Yes | |
| enhanced-profile | No | |
| umgebungsliste-vvp | No | |
| members-page-disclaimer | No | |
| activeusers | No | |
| mail-form | No | |
| subspaces | No | |
| text-data | No | |
| list-data | No | |
| date-data | No | |
| number-data | No | |
| user-options | No | |
| list-option | No | |
| attachment-data | No | |
| label-options | No | |
| report-column | No | |
| local-reporter | No | |
| text-sort | No | |
| report-empty | No | |
| checklist-wiki | No | |
| checklist-excerpt | No | |
| checklist-label | No | |
| easy-dropdown-menu-predefined | No | |
| easy-dropdown-menu | No | |
| / shortcut | No | |
| pdfpagebreak | No | |
| odoo-connect | No | |
| forecast | No | |
| popular-pages | No | |
| tagcloud | No | Cloud of Tags XWiki alternative |
| getcustomername | No | |
| getsalesopportunity | No | |
| getusername | No | |
| unitube | No | |
| requirement | No | |
| requirement-baseline | No | |
| requirement-property | No | |
| requirement-report | No | |
| requirement-report-pages | No | |
| jira-confluence-issue-field-macro | No | |
| jira-confluence-issue-macro | No | |
| chart-plugin | No | |
| hautonumheadmacro | No | |
| listables | No | |
| leanix-widget | No | |
| folder-attachments | No | |
| sa-page-version | No | |
| html-macro | No | |
| cnfl-code-snippet | No | |
| lref-onedrive-embedded-file | No | |
| lref-onedrive-files-list | No | |
| decisionreport | No | |
| lref-onedrive-file | No | |
| simple-qa-export-view | No | |
| simple-qa-overview | No | |
| hover | No | |
| multiexcerpt-macro | Yes | |
| multiexcerpt-enhanced-permissions | No | |
| multiexcerpt-include-macro | Yes | |
| markdown-url | No | |
| markdown-attachment | No | |
| css-class | No | |
| css-style | No | |
| marked | No | |
| drawio-sketch | No | Editor with a custom skin |
| show-if | Yes | |
| hide-if | Yes | |
| viewport-redirect | No | |
| viewport-url-redirect | No | |
| viewtracker | No | |
| recently-viewed | No | |
| viewtracker-report | No | |
| mail-input | No | |
| responses-table | No | |
| checkbox-button-group | No | |
| mail-date-picker | No | |
| hide | No | |
| sql-query | No | |
| sql | No | |
| cache | No | |
| future | No | |
| table-data | No | |
| hidden-data | No | |
| um_relatedcontentbylabel | No | |
| aui-button | No | |
| um_signuplist | No | |
| um_space_viewers | No | |
| um_group_userinfo_table | No | |
| um_siblingtabs | No | |
| um_reloadnsec | No | |
| um_child_tabs | No | |
| um_linktosiblings | No | |
| um_group-permissions | No | |
| um_user-permissions | No | |
| removewatchesforuser | No | |
| um_user_group_individual_permissions | No | |
| um_include_child_pages | No | |
| content-reporter | No | |
| date-sort | No | |
| report-block | No | |
| report-body | No | |
| report-image | No | |
| repeat-filter | No | |
| date-filter | No | |
| text-filter | No | |
| grouping-reporter | No | |
| user-reporter | No | |
| report-on | No | |
| content-filter | No | |
| issue | No | |
| report | No | |
| button-handy | No | |
| easy-dropdown-menu | No | |
| aura-divider | No | |
| tabs-group | No | |
| tab-pane | No | |
| horizontal-nav-item | No | |
| horizontal-nav-group | No | |
| vertical-nav-group | No | |
| vertical-nav-item | No | |
| progress-bar | No | |
| tableenhancer | No | |
| text-area | No | |
| radio-buttons | No | |
| check-box | No | |
| pulse-button | No | |
| includeplus | No | |
| excerpt-includeplus | Yes | |
| ui-text-box | No | |
| ui-expand | No | |
| customcss | No | |
| confiform-table | No | |
| confiform-list | No | |
| confiform-card | No | |
| confiform-calendar | No | |
| confiform-table-merger | No | |
| confiform-field | No | |
| sp-macro-panels | No | |
| progress-bar-advanced | No | |
| tabs-tabsgroup | No | |
| gu-blognavigation | No | |
| gu-language-dropdown | No | |
| gu-spaceadmin | No | |
| st | No | |
| status-list | No | |
| users-report | No | |
| admin-report-plugins-usage-full | No | |
| all-space-admins | No | |
| gu-language-dropdowns | No | |
| gu-tear-off-calendar | No | |
| mail-clear | No | |
| mail-label | No | |
| bv-blogtree | No | |
| easy-dropdown-menu-edit-mode | No | |
| gu-space-logo | No | |
| mail-submit | No | |
| mail-success | No | |
| list-all-users | No | |
| mttopusers | No | |
| bv-random-user-list | No | |
| gu-dropdowns | No | |
| label-picker | No | |
| mail-textarea | No | |
| bv-favpages-box | No | |
| junitreport | No | |
| sp-link | No | |
| bv-quicklink-wrapper | No | |
| bv-top-likes | No | |
| group-permissions | No | |
| gu-button-add | No | |
| gu-dropdown | No | |
| gu-loremipsum | No | |
| spacejump | No | |
| gu-attachmentlist | No | |
| gu-tabs | No | |
| sp-list | No | |
| bv-recently-updated-box | No | |
| gu-blog-posts | No | |
| top-stories | No | |
| gu-css-helper | No | |
| gu-rotatingimage | No | |
| disable-numbered-headings | No | |
| gu-tab | No | |
| gu-block | No | |
| gu-button-theme | No | |
| bv-quicklink | No | |
| gu-menu | No |
By Confluence plugin
Permission migration
When migrating Confluence permissions to XWiki rights, here is what happens:
Page permissions
Permissions set on a Confluence page are converted to XWiki rights set on the corresponding document following this table:
| Confluence permission | XWiki right |
|---|---|
| VIEW | VIEW on the corresponding page and its children (in a XWikiGlobalRights object on the WebPreferences document corresponding to the page) |
| EDIT | EDIT on the page (in a XWikiRights object on the corresponding WebHome document) |
| SHARE | (ignored, we don't have any corresponding right in XWiki) |
Space permissions
Permissions set on a Confluence space are converted to inherited XWiki rights set on the corresponding WebPreferences page of the space in XWikiGlobalRights objects, following this table:
| Confluence permission | XWiki right |
|---|---|
| VIEWSPACE | VIEW |
EDITSPACE | EDIT |
| REMOVEBLOG REMOVEPAGE | DELETE |
| COMMENT | COMMENT |
ADMINISTRATECONFLUENCE | ADMIN |
| (other) | (ignored) |
Note that Confluence propose many fine-grained permission for which XWiki don't have corresponding rights (including, but not limited to: EXPORTSPACE, EXPORTPAGE, REMOVEMAIL, REMOVEOWNCONTENT, CREATEATTACHMENT, REMOVEATTACHMENT, REMOVECOMMENT, PROFILEATTACHMENTS, ARCHIVEPAGE). If such a feature is needed, some custom solution needs to be found.
View right propagation, edit right handling and differences in permission management
In Confluence,
- rights can only be further restricted. We can't open up rights in a sub page. When permissions are set to pages, they can only limit the number of users to which they grant rights. It's not possible to allow more people than those who can access parent pages. This means that if on Page A, VIEW restriction is set for Group A, and on Sub Page B, VIEW right is set for Group B, only people that are both in Group A and in Group B are allowed to see Sub Page B. It is not enough to be in Group B. We'll have to do with the fact that the migrated Sub Page B will be allowed to the whole Group B, and we'll document this discrepancy between Confluence and XWiki, unless someone is willing to setup custom right management in XWiki, which is not advisable in most cases and can surprise users who already know XWiki, and support teams
- edit rights can be granted to users on pages , but they won't be able to edit those pages if they don't have edit permissions on the space.
In XWiki, rights will be opened up. All users of group be will be able so see Sub Page B, and a user will be able to edit a page if edit right is set for this user, even if the user didn't have edit rights on the space in Confluence.
Comparison between Confluence and XWiki concepts
During a Confluence migration, Confluence elements are migrated to the XWiki elements that are the most similar to them. Here's a table that match Confluence elements to their XWiki counterparts:
| Confluence element | XWiki element | Remarks | |
|---|---|---|---|
| User | User profile in the XWiki space | Confluence user ids can be mapped to specific XWiki user names with the user id mapping input stream property. User ids are also used for comments and permission migrations. See Documentation on the Confluence Input filter stream parameters. | |
| Groups | Goups in the XWiki space | Group names can be mapped to specific XWiki group names with the group mapping input stream property. Group names are also used during permission migrations. See Documentation on the Confluence Input filter stream parameters. | |
| Labels | Tags (XWiki.TagClass objects) | Each label has its own XWiki tags object.
In Confluence, a label belongs to a user. We drop this information. | |
| Page Favorites | - | We don't support favorites, which are implemented using the label named "favourite" | |
| Space Favorites | - | We don't support space favorites. | |
| Comments | Comments (XWiki.XWikiComments objects) | ||
| Space | An XWiki space and all its children often a root space, though not necessarily if the "root space" parameter of the migrator is used | The confluence space key is, by default, translated to a XWiki entity name, following the XWiki page name validation, at the root of the wiki or in the space set in the "root space" parameter. Note: A confluence space is not the same thing as an XWiki space.
Confluence users might be confused by this subtle semantic difference and could cause misunderstandings between us and the clients. | |
| Space description | Nothing | The space descriptions are discarded. We don't have such a thing in XWIki | |
| Space Home page | XWiki WebHome Document | Space home pages are migrated to the top level WebHome page in the migrated space. | |
| Space document | XWiki WebHome Document | Documents are migrated as XWiki WebHome documents in their own space. Their name is built from their title in confluence (optionally and by default converted to a valid name in the page naming strategy of XWiki).
The creation author, the creation date and the title of the document are set from the revision author, the revision date and the title present in the Confluence Page object. Note: the "Preserve version" output filter stream parameter needs to be set to true for dates to be kept after migration, or the document date will be set to the time at which the document was migrated. The creation author can also be overridden using an output filter stream parameter. Output filter stream parameters are hidden from the Confluence Migrator Pro UI. For the content, the confluence syntax are translated into XWiki syntax, including macros. Some macros need special handling and are imported in a specific way (especially if for some Confluence macro named X, there exists a XWiki macro named X that does not do the same thing. Then X is renamed to a macro Y that implement X with similar functionality as in Confluence, either in XWiki Standard or in the Pro Macros). | |
| Document history | XWiki document revisions | Optional and by default. | |
| Space Permissions | XWiki rights objects in a WebPreferences document | See Confluence to XWiki permission mapping. | |
| Document Permissions | XWiki rights objects in the document | ||
| Blog space | Same as space | ||
| Blog descriptor | XWiki WebHome document with a Blog.BlogClass object | At the time of writing, title is set to the blog space name, postsLayout is set to "image" and is displayType is set to "paginated". | |
| Blog posts | XWiki Document with a Blog.BlogPostClass object | Blog posts are migrated as Blog.BlogPostClass objects, each in its XWiki terminal documents. At the time of writing, title is set to the blog post title, published is set to 1, content is set to the content, hidden is set to 0 | |
| Attachment | Attachment | If the actual attachment file is not found in the export package, the attachment won't be imported at all. Confluence XML 9.78.0+ Attachments history is imported. | |
| Confluence object id | Converted object title or name | All confluence object has an integer id. This id isn't kept in XWiki. When applicable, its key (for spaces) or title (for documents) is used instead and converted (using page name validation for document and space names). | |
| Language macros (multilingual support) | Multilingual documents | The way it works in Confluence: in the same document, you add macros named french, or english (Ieach supported language probably has a macro of its name, unprefixed). Then, when you display the document, only the parts matching your language are displayed. There's an "All" mode that displays everything. If the Translated content support is enabled (which is the default; see input-parameters), pages containing different languages are converted to translated XWiki documents. If the support is disabled, all the content is migrated, leaving these language macros as is (with a confluence_ prefix by default), in one document. |
Batch migration
Batch migrations
Migrating an entire Confluence site in one go is often impractical: creating a site export from Confluence might take too long, and importing a huge package in XWiki can cause issues.
For these reasons, we designed the batch migration feature, which let you initiate several (space) migrations at the same time. The migrations will run one after the other unattended so you don't have to wait for each migration to finish to manually start the next one.
To use this feature, you will need to be able to put all the space exports you want to migrate on the server hosting your wiki, at a location XWiki can read.
How to create a batch migration, step by step
In the Confluence Migrator Pro home page, open the "Create or copy batches to import multiple Confluence exports" section. Then, click on the "New batch" button.
Enter the path where the space exports can be found optionally select an existing migration from which you wish to retrieve the migration parameters, then click "Confirm".
Give a name to your batch, select the exports you want to migrate, and click on "Create the batch".
You can review the parameters of the batch, and then click "Run the migrations". In the following page, you will be able to choose how to run the migrations (dry run, to test the feature, or actual run)
The following screen is where you actually run the batch. If you want to check if everything is okay before running the migrations, you can choose "dry run", which will not actually perform the migrations but only simulate them.
The next screen lets you know the name of the migrations that are running. Click on the name of your batch ("My test" in this example).
This leads to the status page of the batch. You can know which migrations are done, which migration is running and which migrations are waiting. You can visit each migration separately.
That's it! Make sure you review each migration and check it ran correctly and no issue requires attention.
Post Migration fixes
There are fixes you need to apply after migrating your content, especially if you are migrating several spaces separately.
Reference fixing
In particular, you need to fix references. The reason is that when migrating a space that has links to documents that are in spaces that are not migrated yet, the migrator doesn't have all the data it needs to build proper links. After migrating these target spaces, links can be fixed.
To do this, go to the "Post migration fixes" tab.
Then, click on the "Manage broken links and missing Confluence references". You land on the reference fixer home page:
Click on "Create a reference fixing session":
Then, you can select one or several migrations to fix. The other fields can be left empty.
Alternatively, instead of selecting migations, you can provide an XWiki space in which all children pages are to fix. If you do this, do not forget to also provide the base URL of your former Confluence instance.
Then, and click "Save and view":
Review the settings, and then you can click on Dry run to try out the fixing. When you are happy with the results, you can perform the actual fixing by clicking on the "Run" button.
This will give you a report, in which you can review the logs as well:
Pro Macros
Here, we document the macros provided by the Pro Macros package that can be used outside the context of a Confluence Migration.
- Button
- Contributors
- Content Report Table
- Excerpt
- Excerpt Include
- Expand
- Microsoft Stream
- Panel
- Profile Picture
- Show if / Hide if
- Status
- Tab and Tab-group
- Taglist
- Team
- Recently Updated
- User List
- User Profile
- View File
Button
Insert a noticeable, clickable button on your XWiki page to highlight links and create call to actions.
Parameters
| Name | Description | Default |
|---|---|---|
| label | The label of the button. | - |
| url | A link or a page reference. | - |
| color | The color of the button. | White |
| width | The width of the button specified in pixels, percentage or other valid CSS value (ex. 30px, 30%, 30em). If no value is specified, the width will be determined by the length of the label. | - |
| newTab | Denotes whether the page will be opened in a new page or not. | false |
| icon | Icon associated with the button, placed before the label. |
Examples
{{button label="Store" url="http://store.xwiki.com" color="#889cb8"/}}
{{button label="Store" url="http://store.xwiki.com" color="#889cb8" newTab="true" icon="page"/}}
{{button label="Store" url="http://store.xwiki.com" color="#889cb8" newTab="true" icon="page" width="100%"/}}
Results in
Contributors
Contributors macro shows the contributors of a given page based on defined parameters.
Parameters
| Parameter | Name | Default | Description |
|---|---|---|---|
| include | Include | authors |
Several values can be given, separated by commas. Values "labels" and "watches" are not supported in this bridge macro. |
| order | Order | count | Possibles values:
|
| reverse | Reverse | false | reverse the order specified in the order parameter. |
| limit | Limit | no limit | Show at most the given number of contributors. |
| mode | Mode | inline | Possible values are:
|
| showCount | Show count | false | Show the contribution count for each user. |
| showLastTime | Show last time | false | Show the last contribution time for each user. |
| page | Page | current | The page for which to list the contributions. If both page and space are empty, the current page is used. |
| spaces | Spaces | current | Space(s) containing the page specified in the page parameter, or the space(s) to search. Several spaces can be specified using commas. @global and @ALL will search in the whole wiki. |
| scope | Scope | specified page only | Possible values:
|
| showPages | Show Pages | false | Show the list of pages used to build the list of contributors |
| noneFoundMessage | None Found Message | default message | The message to show when no contributors are found. |
Examples
Results in
Content Report Table
This macro provides a content report in a table format based on tags .
Parameters
| Parameter | Description | Required | Default |
|---|---|---|---|
| labels | The tags to report on, separated by comma. | Yes | |
| spaces | The space (parent page) names to report on, separated by a comma and a blank space (e.g: "Test, XWiki") | No | |
| maxResults | Maximum Number of results (pages). | No | 20 |
Examples
Results in:
Excerpt
The Excerpt macro allows the user to mark part of the page's content for use by other macros. The macro can also be used to hide part of the content of a page.
Parameters
| Parameter | Description | Default |
|---|---|---|
| hidden | If true, the content of the macro will be hidden. | false |
| name | The name of the excerpt, for named includes. | false |
| allowUnprivilegedInclude | Allow this excerpt to be seen even for people who don't have view rights on this page when included | false |
Example
|=Title1|=Title2|=Title3
|Text1|Text2|Text3
{{/excerpt}}
Results in:
Example of hidden excerpt:
My hidden content.
{{/excerpt}}
Excerpt Include
The Excerpt Include macro allows the user to include contents from other pages marked by other macros with the Excerpt Macro.
Parameters
| Parameter | Description | Mandatory |
|---|---|---|
| 0 | The page to include | Yes |
Example
Expand
This macro allows you to insert an expandable section, with a title and content.
Parameters
| Parameter | Name | Description | Default |
|---|---|---|---|
| title | Title | Title of the section, displayed when the section is collapsed | |
| content | Content | Content visible when the section is expanded |
Example
In pharetra fermentum est, non dapibus orci congue eget. Curabitur scelerisque dui vitae sagittis aliquam. Etiam tincidunt mattis ultrices. Integer felis magna, sodales sit amet finibus id, efficitur nec nulla. Ut volutpat tellus id bibendum scelerisque. Fusce ut massa nulla. Donec ullamcorper elit vitae metus condimentum, sed varius eros luctus. Etiam elit mi, finibus sed nibh a, facilisis eleifend orci.
{{/expand}}
Results in:
Microsoft Stream
This macro provides a way for embedding a Microsoft Stream video in a page.
Parameters
| Parameter | Name | Description | Required | Default |
|---|---|---|---|---|
| url | URL | The URL to the Microsoft Stream video. | Yes | |
| width | Width | The viewer width. Can be specified either in pixels (for example, 400px) or as a percentage of the available page width (for example, 50%). | No | 500px |
| height | Height | The viewer height. Can be specified either in pixels (for example, 400px) or as a percentage of the available page height (for example, 50%). | No | 300px |
| alignment | Alignment | Position of the video relatively to its container. Accepted values are left, center and right. | No | |
| start | Start At | Start video at a specific time (use HH:MM:SS as time format). | No | 00:00:00 |
| showinfo | Show Info | Show the video info on thumbnail. | No | true |
| autoplay | Auto Play | Whether the video should start automatically or if the user must play it. | No | false |
| textWrap | Text Wrap | Wrap text around the video. This applies only to left and right alignment. | No | true |
Example
Results in:
Panel
The Panel macro allows you to display XWiki content inside a visually appealing panel. You can customize its size, colours and border.
Parameters
| Parameter | Name | Default value | Description |
|---|---|---|---|
| title | Title | - | If specific a title section is added with the specific text |
| bgColor | Background color | - | If specific sets the background color of the content of the panel |
| width | Width | - | If specified sets the width of the panel (300px or 50%) |
| height | Height | - | If specified sets the width of the panel (300px or 50%) |
| classes | CSS classes | - | If specified adds css classes to the panel |
| borderColor | Border color | white | If specified sets the panel border color |
| borderStyle | Border style | solid | If specified sets the css border style |
| borderWidth | Border width | 1px | If specified sets the border width in pixels |
| borderRadius | Border radius | 8px 8px 0px 0px | If specified replaces the default border radius |
| titleBGColor | Title background color | - | If specified sets the title section background color |
| titleColor | Title text color | - | If specified sets the title text color |
Examples
Simple panel
Content of the panel
{{/panel}}
Results in:
Simple panel with border and size
Content of the panel
{{/panel}}
Results in:
Panel with title and colors
Content of the panel
{{/panel}}
Results in:
Panel with title and colors and border
Content of the panel
{{/panel}}
Results in:
Panel with bootstrap classes
Content of the panel
{{/panel}}
Results in:
Profile Picture
Display avatars of the members of a team.
Parameters
| Parameter | Name | Description |
|---|---|---|
| User | User | The reference to the user. |
Examples
Show if / Hide if
Show or hide content depending of the specified conditions.
Parameters for Show-if / Hide-if
Note the parameter for Show-if and Hide-if are exactly the same. Only the effect will be inverted.
| Parameter | Name | Description | Required | Default |
|---|---|---|---|---|
| matchUsing | Match using | Set if we must match all contraints or only one. If set to "all", then all items set must match. | No | Any |
| authenticationType | Authentication type | The type of user to match, using authentication type:
| No | None |
| users | Users | The list of user(s) to match. | No | - |
| groups | Groups | The list of user group(s) to match. | No | - |
| displayType | Display type | The type of display to show this content. I could be:
| No | None |
Examples
Show if user is authenticated
{{/show-if}}
{{hide-if groups="XWiki.XWikiAdminGroup"}}
Hide if the user is in Admin groups
{{/hide-if}}
Status
The Status macro helps you highlight the status of an item using a colored box. You can customize both the text and the background color. The background can be either lightly colored, or dark, depending on your preference. The macro can be used inside other macros.
Parameters
| Parameter | Name | Default value | Description |
|---|---|---|---|
| title | Title | The color name | The text of the status. If not specified, the color name will be displayed (e.g.:"Grey"). |
| colour | Color | Grey | The color of the status (text color and background color). The following colors are available: "Blue", "Green", "Grey", "Purple", "Red" and "Yellow". |
| subtle | Subtle | False | The aspect of the status: either white text on dark color background or dark color text on light color background. It should be filled with "true" or "false". |
Examples
{{status title="Improvement" colour="Green" subtle="true"/}}
Tab and Tab-group
Create tab in your page content. Tab-group is the container for the tab elements.
Parameters for Tab
| Parameter | Name | Description | Required | Default |
|---|---|---|---|---|
| label | Label | Label for the tab. | Yes | - |
| default | Default | If true, this tab will be the first show by default. | No | false |
| id | Id | A unique ID for this tab | No | - |
| cssClass | CSS class | The custom CSS class for the tab. | No | - |
| cssStyle | CSS Style | Custom CSS style values. | No | - |
| nextAfter | Next after | The number of seconds this tab will stay visible before moving to the next one. If not set, no transition will be done automatically. | No | - |
| effectType | Effect type | The transition animation for this tab | No | None |
| effectDuration | Effect duration | The transition animation duration to apply on change of tab. | No | 0 |
Parameters for Tab-group
| Parameter | Name | Description | Required | Default |
|---|---|---|---|---|
| id | Id | The id of the element | No | Random |
| tabLocation | Tab location | The location of the element. | No | - |
| width | Width | The width of the main element with the CSS unit | No | - |
| height | Height | The height of the main element with the CSS unit | No | - |
| cssClass | CSS Class | A custom css class to decorate the tabs | No | - |
| nextAfter | Next after | The number of seconds this tab will stay visible before moving to the next one. If not set, no transition will be done automatically | No | 0 |
| loopCards | Loop cards | If true, the tab will loop back to the beginning from the last tab. | No | false |
| effectType | Effect type | The transition animation between each tab | No | None |
| effectDuration | Effect duration | The transition animation duration to apply on change of tab | No | 0 |
Examples
{{tab label="First tab"}}
== First tab content ==
* List 1
* List 2
{{/tab}}
{{tab label="Second tab"}}
== Second tab content ==
|=Table column 1|=Table column 2
|Raw 1|...
{{/tab}}
{{/tab-group}}
Taglist
A macro that will show a list with all the tags that are present on your instance.
Parameters
| Parameter | Description | Required | Default |
|---|---|---|---|
| spaces | Comma-separated list of spaces that are used to filter the tags. | No | |
| excludedTags | Comma-separated list of tag that are excluded from the final output. | No |
Example Usage
spaces='Sandbox'
excludedTags='content-report'
/}}
Team
A macro that displays avatars of the members of a team, filterable by numerous parameters.
Parameters
| Parameter | Name | Description | Default |
|---|---|---|---|
| tag | Tag | Tag that users need to have to be shown | |
| users | Users | Restrict to this list of user names (don't prefix with the wiki identifier) | |
| size | Size | The size (height and width) of an avatar | 60 |
| showUsernames | Show Usernames | The name of users should be displayed under their avatars | false |
| letterAvatarBgColor | Letter Avatars Background Color | The background color of the letter avatars | #0A6 |
| letterAvatarFontColor | Letter Avatars Font Color | The font color of the letter avatars | white |
| disableLetterAvatars | Disable Letter Avatars | Don't use letter avatars and display a default avatar instead | false |
| requireExternalAuth | Require External Auth | The user should be searched in LDAP or OAuth | false |
| limit | Limit | The maximum number of people to show (0 turns off the limit) | 100 |
| scope | Scope | The scope of the query used to find users. "global": in the main wiki. "local": in the current wiki. "both": in both the main wiki and the local wiki. "auto": find out from the wiki settings. Has no effect in the main wiki. | auto |
Examples
All users
Results in:
All users, no LDAP or OpenIDC requirements, bigger
Results in:
All users, no LDAP or OpenIDC requirements, some colors
Results in:
All users, with LDAP or OpenIDC requirements
All users with names, disable tools
Results in:
All users with names, disable letter avatars, only in the main wiki
Results in:
Recently Updated
This macro allows you to display the most recently updated pages, blog posts, and attachments. You can filter by space, labels (tags), author (last editor) and you can further customise the display through the maximum number of results, theme, show user profile and hide title parameters.
Parameters
| Parameter | Description | Required | Default |
|---|---|---|---|
| types | Comma-separated list of types (page, blogpost, comment or attachment), possibly prefixed with "-". | No | all types |
| spaces | Comma-separated list of spaces, possibly prefixed with "+" or "-", or special value like @self, @global or @all. | No | @self |
| author | Comma-separated list of authors. | No | |
| labels | Comma-separated list of tags, possibly prefixed with "+" or "-". | No | |
| max | Maximum number of results. | No | 15 |
| theme | Appearance of the macro (concise, social, sidebar). | No | concise |
| width | Width of the macro in percentage. | No | 100% |
| hideHeading | Whether to hide the text "Recently Updated" as title | No | false |
| showProfilePic | Whether to show the profile picture of users | No | false |
Example
Results in:
User List
The macro allows displaying a custom list of users in a table with a set of configurable properties.
Parameters
| Parameter | Name | Description | Default |
|---|---|---|---|
| users | Users | List of users to be displayed | |
| properties | Properties | List of user properties to be displayed | avatar,username |
Example
Results in:
User Profile
The macro allows to display a user with their attributes in a box.
Parameters
| Parameter | Name | Description | Default |
|---|---|---|---|
| reference | Reference | Reference to a user page | |
| properties | Properties | List of user properties to be displayed, separated by a comma | company,email,phone,address |
Example
Results in:
View File
The View Files macro allows you to embed an Office or a PDF document inside an XWiki page or display a thumbnail for office documents and other types of attachments such as images and videos. You will need to attach the document to the page.
Parameters
| Parameter | Description | Required | Default |
|---|---|---|---|
| display | Kind of display. "button" for a button, "thumbnail" for a thumbnail, "full" to render the document in place | no | thumbnail (button in inline mode) |
| name | The attachment reference to display | if att-filename is not given | |
| width | The width of the view in % or px (e.g. 100%, 100px) | no | 100% for the full view or 100px for the thumbnail |
| height | The height of the view in % or px (e.g. 100%, 100px) | no | 1000px for the full view or 100px for the thumbnail |
| att-filename | Alias of name, here for compatibility reasons | If name is not given |
Example
{{view-file display="button" name="migration-gif-2.mp4"/}}
{{view-file display="full" name="XWikiSAS.pdf" height="600"/}}
Results in
Metadata migration
Starting from version 1.36.0, Confluence Migrator Pro provides a tool to import metadata from the Metadata for Confluence plugin to the Metadata Pro application.
First, export data from Metadata for Confluence. You will get a json file for each space.
Then, head over to the migrator. You'll find it from the "Other migration tools" tab in the Confluence Migrator Pro's home page.
Click on the "Browse" button to select a json file to migrate. When the file is uploaded, click on "Select Package".
To validate the creation of the migration session, click on Save and View. You can customize how sets will be named and where they are migrated to, but we suggest leaving the defaults.
When you are ready, click on "Start migration".
Then, you'll see a progress bar and you will be able to follow the migration steps. We strongly advise monitoring the logs to check if everything goes well.
When the job finishes, refresh the page to check the report and whether the numbers of import sets, fields and values check out.
Documentation archive
As the migrator evolved, some documentation became obsolete. We are keeping it around in an Archive document.
Installation Steps
This paid extensions requires 13.10 or above. In order to install the extension, follow the next steps inside your XWiki instance (on cloud or on premise).
Navigate to the Extension Manager
In the Applications Panel click on "More Applications..." and then "Install new applications...". Alternatively navigate directly to the Administration and select the "Extensions" section.
Install the Extension
Search for the extension you wish to install and use the Install button to install it.
Get a License
Navigate to the "Licenses" section of the Administration, fill your details, look for the extension you just installed in the live table and click the buttons to get a trial license or to buy a license.
Install the License
If you have selected a trial license then you're good and there's nothing else to do. Your trial license is automatically installed.
However if you've selected to buy a license you'll be redirected to a page to perform the payment. At the end you need to come back to the "Licenses" administration section and click on the "Check for Updates" button. This will download and apply the license you bought.
Use the Extension
Start using the Extension! Refer to the extension's documentation to know how to use it.
Installing Paid Apps on Subwikis
If you want to install an application on the whole farm (main wiki + subwikis), you can do so directly from the main wiki’s Extension Manager, as seen below:
Extensions can also be installed only on a particular subwiki by global admins. Subwiki admins will not be able to install these extensions due to their limited rights.
Options
The price is per year and varies depending on the support level and the number of users.
| Support / Users | 25 | 50 | 100 | 250 | 500 | 1000 |
|---|---|---|---|---|---|---|
| Business | ||||||
| Business 3 years | ||||||
| Enterprise | ||||||
| Enterprise 3 years |
Benefits
What do you get when you purchase an XWiki extension?
1/3 years license
By purchasing an XWiki extension license, you ll benefit from it during one or three years, depending on the chosen engagement period.
Free updates
You benefit from all the extension updates during one year. You are always up to date.
Support included
If you are facing an issue, you can reach the XWiki support. Our team is always available to help.
How to Buy
To buy, install this extension from inside your XWiki instance and follow the instructions.
Release notes
v1.1.1
Update Confluence Migrator Pro to version 1.41.1
v1.1.0
Updates:
- Licensor to version 1.32
- Confluence Migrator Pro to version 1.41.0
- Macro PDF to version 2.7
- Diagram Application to version 1.23
- URL Shortener Application to version 1.3
XWiki 15.10 or later is now required to install the Confluence Migration Toolkit.
v1.0.40
Fix offline installation issues related to the licensor versions.
v1.0.39
Update:
- Confluence Migrator Pro to version 1.40.0
- Pro Macros to version 1.30.1
- Task Manager to version 3.10.2
- Application Licensing to version 1.31.1
v1.0.38
Update:
- Pro Macros to version 1.30.0
- Confluence Migrator Pro to version 1.39.0
v1.0.37
- Update dependency on the Pro Macros to version 1.29.1
- Update dependency on the Diagram application to version 1.22.11
- Update dependency on the dockerJava to version 3.7.0
- Update dependency on the plexus-archiver to 4.11.0
v1.0.36
- Update Confluence XML to version 9.91.0
- Update Confluence Migrator Pro to version 1.38.0
- Update Diagram Pro to v1.22.10
- Update Task Manager Pro to v3.10.1
- Update Pro Macros to v1.29.0
v1.0.35
- Update dependency on the Diagram application to version 1.22.7
- Update dependency on theTask Application to version 3.10.0
- Update dependency on the Confluence XML package to version 9.90.0 and on Confluence Migrator Pro to version 1.37.0
v1.0.33
Update dependencies:
- Blog to version 9.15.9
- Licensing to version 1.30.1
- Confluence Migrator Pro to version 1.36.0
- Confluence XML to version 9.89.0
v1.0.32
Updated dependencies:
- Blog application v9.15.2
- Licensing Application v1.30
- Task Manager v3.9.3
- XWiki Pro v13.13.4
- Pro Macros v1.28.0
- Confluence XML v9.88.4
- Confluence Migrator Pro v1.35.7
v1.0.31
Update dependency on Pro Macros to version 1.27.3
Update macrofullcalendar.version to v2.4.6
Update dependency com.xwiki.confluencepro:application-confluence-migrator-pro-ui to v1.35.5
Update dependency com.xwiki.pdfviewer:macro-pdfviewer-ui to v2.6.2
Update dependency org.xwiki.contrib.confluence:confluence-resolvers to v9.88.3
v1.0.30
Updated dependencies:
- Confluence migrator Pro v1.35.4
- XWiki Pro Macros v1.27.2
- XWiki Pro v13.13.3
- Confluence XML 9.88.2
v1.0.29
Updated dependencies:
- Confluence Migrator Pro v1.35.2
- Confluence XML v9.88.0
- Full calendar v2.4.5
- Task Managet v3.9.2
v1.0.28
Updated dependencies.
- Confluence Migrator Pro v1.34.5
- Pro Macros v1.26.19
- XWiki Pro Package v13.13.2
- MacroFullCalendar v2.4.3
- Task Application v3.7.1
- Application Licensing v.1.29
v1.0.27
Updated dependencies.
- Confluence XML v9.82.3
- XWiki Pro Macros 1.26.15
v1.0.26
Updated dependencies.
- Confluence Migrator Pro v1.33.1
- Confluence XML v9.82.0
v1.0.25
Updated dependencies.
- Confluence Migrator Pro v1.32.5
- Confluence XML v9.81.2
- XWiki Pro Macros 1.26.7
v1.0.24
Updated dependencies.
- Confluence Migrator Pro v1.32.0
- Confluence XML v9.80.0
v1.0.23
Updated dependencies.
- Confluence Migrator Pro v1.31.1
- Confluence XML v9.77.1
v1.0.22
Updated dependencies.
- Confluence Migrator Pro v1.31.0
- Confluence XML v9.79.0
- Pro Macros v1.26.3
- Task Manager 1.31.0
v1.0.21
Updated dependencies.
- Confluence Migrator Pro v1.29.5
v1.0.20
Updated dependencies.
* Confluence Migrator Pro v1.29.4
* Confluence XML v9.77.3
v1.0.19
Updated dependencies.
- Task Manager Application v3.6.6
- XWiki Pro v13.13.0
- Confluence XML v9.77.2
v1.0.18
Updated dependencies:
- Task Manager Application v3.6.6
- XWiki Pro v13.13.0
- Confluence XML v9.77.2
v1.0.17
Updated dependencies
- Confluence Migrator Pro v1.29.0
- Confluence XML v9.75.0
v1.0.16
Updated dependencies
- Task Manager Application v3.6.3
v1.0.15
Updated dependencies
- Confluence Migrator Pro v1.28.3
- Pro Macros v1.25.5
- Blog Application v9.13.11
- Confluence XML v9.74.0
v1.0.14
Updated dependencies
- Confluence Migrator Pro v1.28.2
- Confluence XML v9.69.0
v1.0.13
Updated dependencies
- Confluence Migrator Pro v1.28.0
- Pro Macros v1.25.3
- Task Manager Application v3.6.2
- Licensing Application v1.27
v1.0.12
Updated dependencies
- Confluence Migrator Pro v1.27.11
- Pro Macros v1.25.2
v1.0.11
Updated dependencies
- Confluence Migrator Pro v1.27.10
v1.0.10
Updated dependencies
- Confluence Migrator Pro v1.27.8
v1.0.9
Updated dependencies
- Confluence Migrator Pro v1.27.7
- Pro Macros v1.25.1
v1.0.8
Updated dependencies
- Confluence Migrator Pro v1.27.6
- Pro Macros v1.24.0
v1.0.7
Updated dependencies
- Confluence Migrator Pro v1.27.4
v1.0.6
Updated dependencies
- Confluence Migrator Pro v1.27.3
v1.0.5
Updated dependencies
- Confluence Migrator Pro v1.27.2
- Pro Macros v1.23,2
- PDF Viewer v2.5.6
v1.0.4
Updated dependencies
- Confluence Migrator Pro v1.27.0
- Pro Macros v1.23.1
v1.0.3
Updated dependencies
- Confluence Migrator Pro v1.24.5
v1.0.2
Updated dependencies
- Confluence Migrator Pro v1.24.4
- Pro Macros v1.22.3
- Task Manager Application v3.5.1
- PDF Viewer v2.5.5
Extension details
License
- GNU Lesser General Public License 2.1
Sources
Issues
Type
- xar
Developed by
Compatibility
- Requires 13.10 or above.
Dependencies
- com.xwiki.confluencepro:application-confluence-migrator-pro-ui 1.41.1
- com.xwiki.pro:xwiki-pro-macros-confluence-bridges-ui 1.30.1
- com.xwiki.task:application-task-ui 3.10.2
- org.xwiki.contrib.blog:application-blog-ui 9.15.9
- com.xwiki.licensing:application-licensing-licensor-api 1.32.1