Confluence Migrator Pro

Last modified by Raphaël Jakse on 2026/05/29 13:53

Confluence Migrator Pro

The Confluence Migrator Pro is an all-in-one toolkit that allows you to migrate and reorganise your data in only a few minutes! The migrator is available for any deployment method, whether it is on your server or in the XWiki Cloud. Try it now.

migrator-41.png
CategoryApplication
Active Installs0
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Minimal XWiki version supportedfalse
SourcesIssues

As of August 2024, the Confluence Migrator Application (Pro) can be tested and purchased only as part of the Confluence Migration Toolkit, in order to ensure all instruments needed to successfully migrate are available on your instance, such as Pro Macros, Confluence Bridge Macros, Task Manager (Pro), Diagram (Pro), Calendar (Pro) and many others. The Confluence Migration Toolkit includes support for all Pro Applications. 
 

If you have already purchased the Confluence Migrator Application (Pro) (before August 2024), you can renew your license from your XWiki instance. 

If you are just starting with XWiki, please install the Confluence Migration Toolkit for the fastest route to your successful migration!

Migrate your Confluence data, users, permissions, attachments and metadata in just a few minutes using the multi space migrator. Page history is preserved, but attachment history is not preserved at the moment. 

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

The application will take you through the few steps that are needed to complete the migration of a Confluence space. Please follow the instructions in the "Documentation" tab for a full breakdown of each step. 

Information

The Confluence Migrator Pro license and support is included in the Confluence Migration Toolkit. In trial mode you will be able to import 30 pages per migration. 

Migrating spaces and pages from Confluence

Prerequisites

  • an XWiki instance with administrator rights
  • access to your XWiki instance's configuration files (if you are running XWiki on premise)
  • Confluence Migrator Pro, Pro Macros and Task Manager Pro installed on your XWiki instance
  • if you wish to migrate Blog posts too, install the Blog Application as well
  • 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 Migrator Pro, 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. 

migrator-pro-preprequisites.png

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. 

Information

Note that if you are using a trial, you will be able to import one space and up to 200 pages per migration. All the other functionalities (prerequisites, import configuration, migration report, simultaneous migrations etc.) are available in the trial version. In order to unlock the full capabilities please obtain a license.

migrator-pro-data-import.png

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. 

migrator-pro-set-title.png

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: 

migrator-2.png

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. 

migrator-pro-fs-config.png

Warning

Confluence favorites are by default migrated to favorites in the Favorites Application (which will need to be installed if you want to use them). These favorites are public. Please disable this option if you don't want favorites to be made public. 

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. 

migrator-pro-analyser.png

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. 

migrator-pro-list-spaces.png

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.

migrator-pro-import-step.png

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.

migrator-4.png

Starting with Confluence Migrator Pro version 1.27.8, the "Restart the migration" button is removed due to redundancy with the copy parameters feature. If you would like to re-execute a migration (e.g. "Migration 2 for Space-123"), please choose the parameters of the previous migration ("Migration 2 for Space-123") in "Step 2 - Choose an export package" and then select the package that you wish to use ("Space-123.zip" in our example). 

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.

migrator-pro-migration-status.png

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 nameDescriptionExample valueDefault value
Import archived documentsConfluence 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 attachmentsIf 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: clean up right after the filter stream is done.
  • ASYNC: same, but asynchronously.
  • NO: don't clean up at all
 

SYNC

ASYNC in the Confluence Migrator Pro Application

Produce rendering events for the contentParse 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

  • user, space and document references from the Confluence names to the XWiki names. This includes user id mapping and group mapping described below, which will not be applicable if this parameter is set to false.
  • The confluence syntax to XWiki syntax

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.

frN/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 historySet this to false if you want to  discard previous revisions of documents (for performance, space or import speed concerns) true
Home redirectWhen 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 countif 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.

  • [4242,] - only read object id 4242 and all the following ones
  • (4242,] - same, but exclude object id 4242
  • [,4242] - read all objects until object id 4242 included
  • [,4242) - same, but exclude 4242
  • [4242,2424], [3456,1234] - read objects between 4242 and 2424 both included, then ignore objects until 5656 and read objects between 5656 and 1234 both included (notice how IDs may look disordered)
 
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 favoritesImport Confluence favorites into the Favorites Application. Requires the Favorites Application to be installed.  true 
Translated content supportWhether 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
Warning

This parameter defines whether permissions set in Confluence should be migrated into XWiki.

Importing users and groups is not mandatory; rights will be imported without. However, if you disable user or group import to import them using another method, for the correct rights to apply to the correct users and groups, you will need to create the users and the groups with the exact same names that are in Confluence, or that are specified in the User id mapping and Group name mapping parameters (as these two parameters will be respected by the right migration even if groups and users are not imported).

 

 true
RootThe 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:

  • NONE – no protection: Existing spaces may be partially overwritten. No new space is created.
  • NONCONFLUENCE – protects only spaces not imported from Confluence: Conflicting non Confluence spaces cause a new space to be created using the Space renaming format. Confluence imported spaces may be overwritten.
  • ANY – full protection: Any conflicting space triggers the creation of a new space using the Space renaming format.
 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 tagsSet 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=MyGroupadministrators=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.

Information

Users are only present in full Confluence export packages and are not present in space export packages.

Information

Only the user profiles won't be imported from the package if this option is set to false. Permissions will still be imported for users, unless you also disable permission import. 

 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.

Information

Groups are only present in full Confluence export packages and are not present in space export packages.

Information

Only the groups won't be imported from the package if this option is set to false. Permissions will still be imported for groups, unless you also disable permission import. 

 true
Users wikiThe wiki where users and groups are located.

You can specify here the wiki in which users and groups are located.
If applicable, users and groups will be imported in this wiki. Any user reference, including ones in permission objects, will contain this wiki.
This is most useful in a multi wiki environment when importing confluence spaces in a subwiki, but users are located in the main wiki (xwiki), in which case, set this to "xwiki". 

 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 MappingThis 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 TypeThe 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 impliedSERVER 

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:

migrator-pro-imported-macros.png

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.

Warning

We are in the process of migrating that table to the Confluence macro documentation.

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  Yesmapped 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  YesMacro is migrated to "contentbylabel" with parameters, obtaining the same list of links to pages. The visual result is not identical.
widget  PartialEmbed 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  YesXWiki 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  YesDiagram 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  YesMessage 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  YesView 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  YesConfluence 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 permissionXWiki right
VIEW

VIEW on the corresponding page and its children (in a XWikiGlobalRights object on the WebPreferences document corresponding to the page)

EDITEDIT 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 permissionXWiki right
VIEWSPACEVIEW

EDITSPACE
EDITBLOG
Note: in the Confluence UI, this is what is called "Add" page right

EDIT
REMOVEBLOG
REMOVEPAGE
DELETE
COMMENTCOMMENT

ADMINISTRATECONFLUENCE
SYSTEMADMINISTRATOR
SETPAGEPERMISSIONS
SETSPACEPERMISSIONS

ADMIN
(other)(ignored)

Note that Confluence propose many fine-grained permission for which XWiki doesn'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.

Warning

In XWiki, some rights imply others. For instance, a user having DELETE right on a page automatically and implicitly has VIEW rights. The Confluence permission to XWiki right conversion is generally naive and doesn't take this in account, which can lead to right escalation upon migration in some specific instances. For instance, if a user has a REMOVEPAGE permission on a space but doesn't have VIEWSPACE right, the conversion will grant them VIEW right on the space.

In the same spirit, a COMMENT permission will be converted to a COMMENT right regardless whether a user has VIEW right on the corresponding pages. COMMENT doesn't implicitly give VIEW right, so this conversion is technically correct, but it can lead to confusing display on right management tools.

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.

Page restriction right in Confluence and migration to XWiki

In Confluence there are page restriction rights at space level. This right is converted to admin right in XWiki, for the page tree corresponding to the Confluence space in XWiki. This means that all user having page restriction right but not admin right on Confluence will endup having admin right for the corresponding page tree in XWiki. The difference is that, in Confluence, a user with page restriction rights cannot see or change restrictions for a page that is restricted away from them (thus not having access to it at all, de facto), while in XWiki the admin right at the level of a page tree can see all the pages in that page tree, even if these pages have further view or edit access rules set on them; the admin right is not deniable in XWiki, and it is cumulative on inheritance (as opposed to other rights which are "interrupted" by inheritance).

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 elementXWiki elementRemarks
UserUser profile in the XWiki spaceConfluence 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.
GroupsGoups in the XWiki spaceGroup 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.
LabelsTags (XWiki.TagClass objects)

Each label has its own XWiki tags object.

  • Page labels are set as tags on the document
  • Space labels are set as tags on the space home page
  • Attachment labels are dropped

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.
CommentsComments (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.

  • A confluence space is something at the root of the instance that contains a document tree, among other things
  • A XWiki space is just one level in the tree and is not necessarily at the root

Confluence users might be confused by this subtle semantic difference and could cause misunderstandings between us and the clients.

Space descriptionNothingThe space descriptions are discarded. We don't have such a thing in XWIki
Space Home pageXWiki WebHome DocumentSpace home pages are migrated to the top level WebHome page in the migrated space.
Space documentXWiki 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).

Content marked as deleted, archived or draft is not imported. If the locale parameter is set, it will be used for the locale of all imported documents.

These properties will be set from the Confluence page object property:

  • The parent
  • The revision
  • The revision comment

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 historyXWiki document revisionsOptional and by default.
Space PermissionsXWiki rights objects in a WebPreferences documentSee Confluence to XWiki permission mapping. 
Document PermissionsXWiki rights objects in the document
Blog space Same as space
Blog descriptorXWiki 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 postsXWiki Document with a Blog.BlogPostClass objectBlog 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
AttachmentAttachment

If the actual attachment file is not found in the export package, the attachment won't be imported at all.
The attachment size is taken from the confluence export XML file if present, fallback to the actual file content size if not found.

Confluence XML 9.78.0+ 

Attachments history is imported.

Confluence object idConverted 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).

If the "Store Confluence details" is set to true, confluence detail are stored in a Confluence.Code.ConfluencePageClass object (id : the page id, url: the reconstructed confluence url, space: the space key).

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.

1 - welcome.png

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".

1754314577456-217.png

Give a name to your batch, select the exports you want to migrate, and click on "Create the batch".

3 - create batch.png

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)

4 - created.png

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.

5 - run.png

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).

6 - running.png

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.

Warning

For performance reasons, the status of migrations is not updated in real time. This is because you can run several dozens, if not hundreds, of migration in one batch and querying the wiki for the status of a hundred of migrations would not be nice to your server.

7 - status.png

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.

postmigfixes.png

Then, click on the "Manage broken links and missing Confluence references". You land on the reference fixer home page:

referencefixer.png

Click on "Create a reference fixing session":

newreferencefixingsession.png

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":

beforerunningreferencefixing.png

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:

afterrunningreferencefixing.png

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

Insert a noticeable, clickable button on your XWiki page to highlight links and create call to actions.

Parameters

NameDescriptionDefault
labelThe label of the button.-
urlA link or a page reference.-
colorThe color of the button.White
widthThe 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.-
newTabDenotes whether the page will be opened in a new page or not.false
iconIcon associated with the button, placed before the label.

Examples

{{button label="Store" url="http://store.xwiki.com"/}}

{{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 

demo-button-macro.png

Contributors

Contributors macro shows the contributors of a given page based on defined parameters.

Parameters

ParameterNameDefaultDescription
includeIncludeauthors
  • authors - includes users who edited the page(s).
  • comments - includes people who commented to the page(s)

Several values can be given, separated by commas. Values "labels" and "watches" are not supported in this bridge macro.

orderOrdercount

Possibles values:

  • count - order by number of contributions
  • name - order contributors by name alphabetically
  • update - order by last contribution date
reverseReversefalsereverse the order specified in the order parameter.
limitLimitno limitShow at most the given number of contributors.
modeModeinline

Possible values are:

  • inline - a comma-separated list
  • list - a bullet list.
showCountShow countfalseShow the contribution count for each user.
showLastTimeShow last timefalseShow the last contribution time for each user.
pagePagecurrentThe page for which to list the contributions. If both page and space are empty, the current page is used.
spacesSpacescurrent

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.

scopeScopespecified page only

Possible values:

  • children - include direct children of the specified pages
  • descendants - include all children of the specified pages
  • (blank) - include only the specified pages
showPagesShow PagesfalseShow the list of pages used to build the list of contributors
noneFoundMessageNone Found Messagedefault message

The message to show when no contributors are found.

Examples

{{contributors showCount="true" spaces="Sandbox" scope="descendents" showPages="true" mode="list"/}}

Results in

contributors-demo.png

Content Report Table

This macro provides a content report in a table format based on tags .

Parameters

ParameterDescriptionRequiredDefault
labelsThe tags to report on, separated by comma.Yes 
spacesThe space (parent page) names to report on, separated by a comma and a blank space (e.g: "Test, XWiki")No 
maxResultsMaximum Number of results (pages).No20

Examples

{{content-report-table maxResults="10" spaces="DEMO" labels="tech,xwiki"/}}

Results in:

ContentReport.png

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

ParameterDescriptionDefault
hiddenIf true, the content of the macro will be hidden.false
nameThe name of the excerpt, for named includes.false
allowUnprivilegedIncludeAllow this excerpt to be seen even for people who don't have view rights on this page when includedfalse

Example

{{excerpt}}
|=Title1|=Title2|=Title3
|Text1|Text2|Text3
{{/excerpt}}

Results in:

excerpt-html.png

Example of hidden excerpt:

{{excerpt hidden="true"}}
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

ParameterDescriptionMandatory
0The page to includeYes

Example

{{excerpt-include 0="Excerpt.WebHome" name="someName"/}}

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

{{expand title="Expand this section to learn more"}}
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:

1677173833281-292.png

Microsoft Stream

Warning

⚠️ Deprecation Notice

The Microsoft Stream Macro will be removed at the end of July 2026, as Microsoft no longer offers this product.

This macro provides a way for embedding a Microsoft Stream video in a page.

Parameters

 Parameter  Name  Description  RequiredDefault
urlURLThe URL to the Microsoft Stream video.Yes 
widthWidthThe viewer width. Can be specified either in pixels (for example, 400px) or as a percentage of the available page width (for example, 50%).No500px
heightHeightThe viewer height. Can be specified either in pixels (for example, 400px) or as a percentage of the available page height (for example, 50%).No300px
alignmentAlignmentPosition of the video relatively to its container. Accepted values are left, center and right.No 
startStart AtStart video at a specific time (use HH:MM:SS as time format).No00:00:00
showinfoShow InfoShow the video info on thumbnail.Notrue
autoplayAuto PlayWhether the video should start automatically or if the user must play it.Nofalse
textWrapText WrapWrap text around the video. This applies only to left and right alignment.Notrue

Example

{{msStream url="https://web.microsoftstream.com/video/2113" width="700px" alignment="right" showinfo="true" start="00:05:04"/}}

Results in:

1695642164386-534.png

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 radius8px 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

{{panel}}
Content of the panel
{{/panel}}

Results in:

panel-simple.png

Simple panel with border and size

{{panel borderColor="black" width="50%"}}
Content of the panel
{{/panel}}

Results in:

panel-bordered.png

Panel with title and colors

{{panel bgColor="#dbf4ff" titleBGColor="#2a8af7" titleColor="#ffffff" width="50%" title="Title of the panel"}}
Content of the panel
{{/panel}}

Results in:

panel-title-colors.png

Panel with title and colors and border

{{panel bgColor="#dbf4ff" borderColor="#2a8af7" titleBGColor="#2a8af7" titleColor="#ffffff" title="Title of the panel"}}
Content of the panel
{{/panel}}

Results in:

panel-bordered-title-color.png

Panel with bootstrap classes

{{panel classes="col-sm-12" bgColor="#dbf4ff" titleBGColor="#2a8af7" titleColor="#ffffff" title="Title of the panel"}}
Content of the panel
{{/panel}}

Results in:

panel-bootstrap.png

Profile Picture

Display avatars of the members of a team.

Parameters

 Parameter  Name  Description
 User  User  The reference to the user.

Examples

{{profile-picture User="XWiki.Admin" /}}

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.

ParameterNameDescriptionRequiredDefault
matchUsingMatch usingSet if we must match all contraints or only one. If set to "all", then all items set must match.NoAny
authenticationTypeAuthentication type

The type of user to match, using authentication type: 

  • None - No authentication type is chosen. 
  • Authenticated - The user is logged in. 
  • Anonymous - The user is not logged in.
NoNone
usersUsersThe list of user(s) to match.No-
groupsGroupsThe list of user group(s) to match.No-
displayTypeDisplay type

The type of display to show this content. I could be: 

  • None: don't take into account for this parameter. 
  • Default: Show on screen (when the content is not printed). 
  • Printable: Show when it's printed. Will be enabled for PDF or ODT export.
NoNone

Examples

{{show-if authenticationType="AUTHENTICATED"}}
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 nameThe text of the status. If not specified, the color name will be displayed (e.g.:"Grey").
 colour  Color GreyThe color of the status (text color and background color). The following colors are available: "Blue", "Green", "Grey", "Purple", "Red" and "Yellow".
 subtle  Subtle FalseThe 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="Task"/}}

{{status title="Improvement" colour="Green" subtle="true"/}}

status-demo.png

Tab and Tab-group

Create tab in your page content. Tab-group is the container for the tab elements.

Parameters for Tab

ParameterNameDescriptionRequiredDefault
labelLabelLabel for the tab.Yes-
defaultDefaultIf true, this tab will be the first show by default.Nofalse
idIdA unique ID for this tabNo-
cssClassCSS classThe custom CSS class for the tab.No-
cssStyleCSS StyleCustom CSS style values.No-
nextAfterNext afterThe number of seconds this tab will stay visible before moving to the next one. If not set, no transition will be done automatically.No-
effectTypeEffect typeThe transition animation for this tabNoNone
effectDurationEffect durationThe transition animation duration to apply on change of tab.No0

Parameters for Tab-group

ParameterNameDescriptionRequiredDefault
idIdThe id of the elementNoRandom
tabLocationTab locationThe location of the element.No-
widthWidthThe width of the main element with the CSS unitNo-
heightHeightThe height of the main element with the CSS unitNo-
cssClassCSS ClassA custom css class to decorate the tabsNo-
nextAfterNext afterThe number of seconds this tab will stay visible before moving to the next one. If not set, no transition will be done automaticallyNo0
loopCardsLoop cardsIf true, the tab will loop back to the beginning from the last tab.Nofalse
effectTypeEffect typeThe transition animation between each tabNoNone
effectDurationEffect durationThe transition animation duration to apply on change of tabNo0

Examples

{{tab-group}}
{{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}}

1757693275678-111.png

1757693297482-322.png

Taglist

A macro that will show a list with all the tags that are present on your instance.

Parameters

ParameterDescriptionRequiredDefault
spacesComma-separated list of spaces that are used to filter the tags.No 
excludedTagsComma-separated list of tag that are excluded from the final output.No 

Example Usage

{{tagList
  spaces='Sandbox'
  excludedTags='content-report'
/}}

1734603263099-310.png

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 AuthThe 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

{{team/}}

Results in: 

team-all-users.png

All users, no LDAP or OpenIDC requirements, bigger

{{team requireExternalAuth="false" size="100" /}}

Results in: 

team-all-users-bigger.png

All users, no LDAP or OpenIDC requirements, some colors

{{team requireExternalAuth="false" letterAvatarBgColor="#05C" letterAvatarFontColor="#FFA"/}}

Results in: 

teams-color-icon.png

All users, with LDAP or OpenIDC requirements

{{team requireExternalAuth="true" /}}

All users with names, disable tools

{{team showUsernames="true" disableTools="true"/}}

Results in: 

teams-users-with-names.png

All users with names, disable letter avatars, only in the main wiki

{{team showUsernames="true" disableLetterAvatars="true" scope="global"/}}

Results in: 

teams-avatars-main-wiki.png

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

ParameterDescriptionRequiredDefault
typesComma-separated list of types (page, blogpost, comment or attachment), possibly prefixed with "-".Noall types
spacesComma-separated list of spaces, possibly prefixed with "+" or "-", or special value like @self, @global or @all.No@self
authorComma-separated list of authors.No 
labelsComma-separated list of tags, possibly prefixed with "+" or "-".No 
maxMaximum number of results.No  15
themeAppearance of the macro (concise, social, sidebar).No  concise
widthWidth of the macro in percentage.No  100%
hideHeadingWhether to hide the text "Recently Updated" as titleNo  false
showProfilePicWhether to show the profile picture of usersNo  false

Example

{{recently-updated spaces="Sandbox" types="page, attachments" max="10" showProfilePic="true" hideHeading="true" theme="social"/}}

Results in:

1677176326677-954.png

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

{{userList users="XWiki.JohnDoe,XWiki.StefanaNazare,XWiki.MarySmith" properties="avatar,username"/}}

Results in:

user-list-simple.png

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

{{userProfile reference="XWiki.MarySmith"/}}

Results in:

user-profile.png

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. 

Note: In order for the view-file macro to function as expected, you need to have an office server setup. Please refer to our documentation for more details on how to setup an office server for XWiki. 

Parameters

ParameterDescriptionRequiredDefault
displayKind of display. "button" for a button, "thumbnail" for a thumbnail, "full" to render the document in placenothumbnail (button in inline mode)
nameThe attachment reference to displayif att-filename is not given 
widthThe width of the view in % or px (e.g. 100%, 100px)no100% for the full view or 100px for the thumbnail
heightThe height of the view in % or px (e.g. 100%, 100px)no1000px for the full view or 100px for the thumbnail
att-filenameAlias of name, here for compatibility reasonsIf name is not given

Example

{{view-file name="XWikiLogo.png"/}}

{{view-file display="button" name="migration-gif-2.mp4"/}}

{{view-file display="full" name="XWikiSAS.pdf" height="600"/}}

Results in

view-file-examples.png

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.

Information

If you import metadata set values (not only metadata set definitions), you need to migrate the corresponding Confluence space using Confluence Migrator Pro before importing the metadata.

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.

migrator.png

Click on the "Browse" button to select a json file to migrate. When the file is uploaded, click on "Select Package".

migration-creation.png

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.

migration-before-start.png

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.

 migration-report.png

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 false 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.

step1.png

Install the Extension

Search for the extension you wish to install and use the Install button to install it.

step2.png

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.

step3.png

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:

step4.png

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 Unlimited
Gold

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.42.1

  • #418: Accessibility improvements related to collapsible sections
  • Translation updates

Update dependency on Confluence-XML to version 9.94.1 (which prevents tasks with a UUID from outputting that UUID raw in the document )

 

v1.42.0

  • #454: Rendering migration reports uses a log of resources and cause OOM crashes on huge migrations
  • #451: Group import - attachment filename not taken into account
  • #452: Group import and calendar import - CSV file with BOM not supported
  • #428: Retrieve the missing task from the exported CSV

Update Confluence-XML to version 9.94.0

v1.41.3

This release includes an important fix related to the licensor.

v1.41.2

  • #447: Improve request handling in Group import and in Calendar import tools
  • #443: Improve group import script to handle user and group formatting
  • #444: Use confluence API for user and group formatting and conversion for Calendar import

v1.41.1

Fixes:

  • #441: The batch migration tool unconditionally sets the useLinkMapping property to true on migrations
  • #443: Abusive modification of the cached document in the reference fixer

v1.41.0

#437: Remove the advanced user check for displaying logs

The minimal supported version of XWiki is now 15.10

v1.40.1

#438: Disable link mapping on Oracle database

v1.40.0

Cosmetic and accessibility improvements:

  • #417: Fold lengthy sections in the migration reports
  • #416: Migration report - make it easy to find out which pages contain which unsupported macro
  • #419: Messed up dl elements potentially causing accessibility issues

Translation: the UI is now available in French.

Update Confluence XML to version 9.92.0, which, among other improvements, improves migrations of inline comments to annotations and fixes an import issue that can cause missing pages after migration.

v1.39.0

  • #414: Store metadata for migrated metadata sets

v1.38.0

Fixes and improvements:

  • #405: Migrate ui-tabs to tab-group and ui-tab to tab
  • #406: Add fold and unfold buttons to the document tree in migration reports

Update dependency on Confluence XML to version 9.91.0

v1.37.0

Fixes and improvements:

  • #402: Update limit for trial
  • #403: Convert ui-button to button
  • #397: Migrate Covectors tabs and tab groups
  • #396: Warn users trying to import PDF, CSV & DOCX files
    Update dependency on Confluence XML to version 9.90.0

 

v1.36.1

Update dependency on Confluence XML to version 9.89.1

v1.36.0

Fixes and improvements:

  • #154: application makes use of the internal AbstractMacroConverter API of confluence-xml
  • #321: Convert the display parameter in view-file
  • #370: Migration reports list the current space tree instead of only and all the pages that were imported
  • #374: Add a migrator for Metadata (for Confluence)
  • #384: Add a dependency to the favorites default package to support favorites migration
  • #387: Convert ui-expand to expand
  • #393: Migrate horizontal-tab-group and horizontal-tab-item to tab-group and tab
  • #320: Warn or straight up refuse to migrate spaces that would overwrite well known space

Update dependency on Confluence XML to version 9.89.0

v1.35.7

Fixes and improvements:

  • #367: Calendar migration - Improve migration of recurrent events
  • #269: Javascript error in the console when uploading an export

Update Task Application to v3.9.3 

v1.35.6

Fix:

  • #355: Calendar migration - WebPreferences page not correctly configured

Update dependency on the Confluence XML package to version 9.88.4

v1.35.5

Fixes and improvements:

  • #354: Tasks and Tasklist macros have extraneous empty lines

Update dependency on Confluence XML to version 9.88.3

v1.35.4

Bugs:

  • 359 Abusive modification of the cached document [xwiki:ConfluenceMigratorPro.Code.MigratedMacrosDocsJSON()]

v1.35.3

Misc:

  • 314 Improve accessibility 

Technical Issues:

  • 375 Remove import related to Apache Commons Lang 2

v1.35.2

Update dependency on Confluence-XML to version 9.88.0. This version supports migration of translated documents and favorites.

v1.35.1

Convert task macro to the checkbox macro instead of the taskbox macro.

v1.35.0

Neww features:

  • #341 Add a script to migrate confluence calendar to XWiki

v1.34.10

Improvements:

#352 Support migration of tasks to checkboxes

v1.34.9

Bugs fixed:

  • #349 The diagram conversion crashes when the diagram name is missing from the bridge macro

Update dependency on the Confluence XML package to version 9.87.1

v1.34.8

Bugs fixed:

  • #348 Don't duplicate diagrams when converting them #348

v1.34.7

Bugs fixed:

  • #347 Diagram conversion: support confluence_gliffy's pageid parameter

v1.34.6

Bugs fixed:

  • #346 Tasklist macro is not always migrated properly from confluence

Update dependency on the Confluence XML package to version 9.87.0

v1.34.5

Improvments:

  • #327In reports, show which versions were used during a migration and whether it was a trial migration #327
  • #328Make the trial license warning prominent #328
  • #337  Reference fixer: autodetect broken link type in exhaustive mode
  • #338Reference fixer: Don't try to convert attachment and mailto references in broken link mode

v1.34.4

  • #324: Failed page id confluence reference conversions are not logged in migration reports
  • #325: Add a way to exhaustively browse migrated pages when fixing Confluence references for a migration

Update dependency on the Confluence XML package to version 9.83.1

v1.34.3

  • #322: When migrating the labelist macro, the space parameter is not correctly set when using a root.

v1.34.2

Update dependency on the Confluence XML package to version 9.83.0

v1.34.1

Update dependency on the Confluence XML package to version 9.82.8

v1.34.0

  • #317: Convert tasklist macro into task macros
  • #319: The diagram converter fails to convert diagrams because its doesn't retrieve the attachment contents correctly
  • #315: Fix the 30 page TRIAL limit
  • #313: Diagram Converter: only the last specifed migration is taken in account
  • #312: Collision detection is not run in default settings
  • #309: Improve auibutton macro converter
  • #303: Override the prolinkmappping Confluence resolver in the old Pro Macros extension
  • #289: The listlabels to tagList conversion has several issues wrt the conversion of the spaces parameter
  • #295: Provide an experimental diagram conversion post migration fix 

Update dependency on the Confluence XML package to version 9.82.6

v1.33.1

Update dependency on the Confluence XML package to version 9.82.0

v1.33.0

  • #300: Batch stats computation fails with a class cast exception
  • #292: The prefilled parameter form should be available to all migration creation methods
  • #290: Macro counts in migration reports and batch statistics

v1.32.5

Update dependency on the Confluence XML package to version 9.81.2

v1.32.4

  • #290: Macro counts in migration reports and batch statistics
  • #292: The prefilled parameter form should be available to all migration creation methods

v1.32.3

  • Fixed a small typo

v1.32.2

  • #275: Move the batch creation code from groovy to java
  • #279: Remove the useless dry-run batch creation feature
  • #281: Correct styling for Batch sources
  • #288: The link batch fixes are saved in the wrong space 

v1.32.1

  • #283: Convert excel's file parameter to view-file's name parameter 
  • #284: Fix links in Gliffy diagrams

Update dependency on the Confluence XML package to version 9.81.0

v1.32.0

  • #263: UI improvements
  • #277: Log and report unhandled parameters and parameter values during macro conversions
  • #278: Save failed reference counts in the reference fixer as TSV

Update dependency on the Confluence XML package to version 9.80.0

v1.31.1

Update dependency on the Confluence XML package to version 9.79.1.

v1.31.0

  • #271: Extra ')' in the SQL statement in getShortestReferenceForSpaceByReference in LinkMappingStore.java
  • #272: Unconverted Confluence space references are not logged in migration reports
  • #274: Support template migration
  • #264: Integrate batch migration functionality
  • #268: Allow importing attachments and attachment history to already migrated content
  • #251: confluencepro_linkmapping_by_id does not exist with postgres

Update dependency on the Confluence XML package to version 9.79.0.

v1.30.1

Bugs fixed:

  • #267 Reference are not fixed in comments

v1.30.0

Bugs fixed:

  • #266 Some task macros are migrated with additional newlines before them

Tasks done:

  • #216 Make it mandatory to run Confluence Migrator Pro from the main wiki, or test whether it works fine when run from a subwiki and support this

v1.29.5

  • #260: Resource types (doc:) are incorrectly added to converted macro parameters when fixing references
  • #261: Handle references prefixed with "document:" in macro parameters when reference fixing
  • #262: Output wiki-local references when fixing references

v1.29.4

  • #259: Reference fixer's broken links mode breaks all the links

Update dependency on the Confluence XML package to version 9.77.3.

v1.29.3

  • #258: Reference fixer: handle links with anchors

Update dependency on the Confluence XML package to version 9.77.0.

v1.29.2

  • #255: Bring a few fixes and improvements to the reference fixer
  • #153: Broken link on migrator start page when having a trial license
  • #253: Support children macro ordering feature

Update dependency on the Confluence XML package to version 9.76.2.

v1.29.1

Improvements:

  • #248: Work around XWIKI-22791 so costly tag cloud is not computed in migration live tables

Bugs fixed:

  • #249: A typo in className makes the migration live data slower than necessary #249

v1.29.0

New features:

  • #247: Provide a broken link / Confluence reference fixer

Tasks done:

  • #246: Remove code from the prefilled unprefixed macro list

Update dependency on the Confluence XML package to version 9.75.0.

v1.28.3

  • #245: Tab and tab-group converter should convert to not inline macro
  • #244: Show-if/hide-if converter - check enum value in case insensitive way

Update dependency on the Confluence XML package to version 9.74.0.

v1.28.2

  • #242: Errors related to old revisions are not actually filtered out from reports
  • #243: Migration reports incorrectly show the number of revisions instead of the number of revisions

Update dependency on the Confluence XML package to version 9.69.0.

v1.28.1

  • #241: Cannot display full logs anymore

Update dependency on the Confluence XML package to version 9.68.0.

v1.28.0

  • #240: Limit use of the link mapping feature to the strict minimum and use a more optimized storage

Update dependency on the Confluence XML package to version 9.67.0.

v1.27.11

  • #237: Hide by default issues related to old document revisions in the summary of migration reports
  • #238: The "other issues" section is not displayed in migration reports
  • #239: Adapt the migration report to the new Confluence references 
  • #236: Disable mention notifications during migration
  • #234: Fix again show-if/hide-if migration 

Update dependency on the Confluence XML package to version 9.66.0.

v1.27.10

Update dependency on the Confluence XML package to version 9.65.0.

v1.27.9

Bugs fixed

  • #233 When starting a migration, default parameter values are not used when the parameters are not specified

v1.27.8

Bugs fixed

  • #228 When restarting migrations, various defaults are not applied and the link mapping is not used, resulting in broken links and macros
  • #229 Confluence Migrator Pro can ask questions even when questions are to be skipped
  • #230 Memory leak caused by job statuses being stored indefinitely in ConfluenceMigrationScriptService (field lastJobMap)
  • #231 Parameters set in the migration page do not apply
  • #232 Migration reports lack XWiki menus

Update dependency on the Confluence XML package to version 9.64.0.

v1.27.7

Bugs fixed

  • #226 Reports display space names without using the naming strategy
  • #227 Multiexcerpt-include macros are incorrectly migrated to excerpt-include with a panel

v1.27.6

Improvement

  • #223 Hide the full logs by default in migration reports
  • #224 Stop storing the full logs in migration report pages
  • #225 Limit log display during migrations

Update dependency on the Confluence XML package to version 9.63.2.

v1.27.5

Improvement

  • #201 Display waiting migrations as pending
  • #218 Allow (un)folding all items in a report section #218
  • #222 Report reference collisions (when several pages get the same XWiki reference) when computing the link mapping #222

Update dependency on the Confluence XML package to version 9.63.1.

v1.27.4

Bugs fixed

  • #107 Remove direct uses of PageIdentifier objects coming from Confluence-XML logs

Update dependency on the Confluence XML package to version 9.63.0.

v1.27.3

Bugs fixed

  • #212 Fix migration of parameter for tab and tab-group macro
  • #214 Migration created from a batch are automatically run when visited #214

Update dependency on the Confluence XML package to version 9.62.0.

v1.27.2

Bugs fixed

  • #210 Personal spaces containing titles are not correctly linked from the migration page

Improvement

  • #211 List missing users and groups when migrating permissions

Update dependency on the Confluence XML package to version 9.61.0.

v1.27.1

Improvement

  • #209 Make sure migration jobs run in the order they were created #209

v1.27.0

Bugs fixed

  • #206 The Live data migration table title filter shows nothing

Improvement

  • #208 Saving the macro usage statistics causes OOMs and huge slow downs at the end of migrations

New Feature

  • #205 Allow migrating to a subwiki
  • #207 Handle migration for card and deck macro

Update dependency on the Confluence XML package to version 9.60.0.

v1.26.0

Bugs fixed

  • #195 Fix migration of show-if/hide-if macro

Improvement

  • #203 Support multi-except and multi-except-include (old names for the related, already supported multiexerpt macro

Update dependency on the Confluence XML package to version 9.59.0.

v1.25.0

Improvements

  • #200 Make started migrations wait for the other running migrations to finish

Update dependency on the Confluence XML package to version 9.57.0.

v1.24.5

Update dependency on the Confluence XML package to version [[9.56.0>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Confluence/#H9.56.0]].

v1.24.4

Update dependency on the Confluence XML package to version 9.53.2.

v1.24.3

Update dependency on the Confluence XML package to version 9.53.1.

v1.24.2

  • #169: Convert navmap to content by label bridge
  • #139: Convert tasks-report-macro to task-report and support the pages parameter
  • #177: Convert excel macro into office macro

Update dependency on the Confluence XML package to version 9.53.0.

v1.24.1

  • #193: Add date to the macros prefixed by default

v1.24.0

  • #191:  Convert "userlister" to "userList"
  • #171: Convert roundrect macro to panel macro
  • #176: Convert inc-drawio to the diagram macro

Update dependency on the Confluence XML package to version 9.52.0.

v1.23.1

  • #160: Recover from a failure to get the cause of an exception when building the error logs

v1.23.0

  • #40: Confluence details are not stored by default
  • #158: Convert listlabels to tag list

Update dependency on the Confluence XML package to version 9.51.0.

v1.22.5

Update dependency on the Confluence XML package to version 9.50.2.

v1.22.4

Update dependency on the Confluence XML package to version 9.50.1.

v1.22.3

Update dependency on the Confluence XML package to version 9.50.0.

v1.22.2

Update dependency on the Confluence XML package to version 9.49.1.

v1.22.1

  • #152: Convert the "profile" macro into "userProfile" upon migration
  • #155: Convert multiexcerpt-include

v1.22.0

Bugs fixed:

  • #149 Some macros are not imported correctly

Improvements:

  • #92 Display and search the space key in addition to the space title in the the space selection screen

v1.21.6

Update dependency on the Confluence XML package to version 9.49.0.

v1.21.5

  • #145: Add a convenient way to export migration reports

v1.21.4

Update dependency on the Confluence XML package to version 9.48.2.

v1.21.3

  • #148: Don't prefix the HTML macro

v1.21.2

  • #146: Don't prefix the tip and toc macros

Update dependency on the Confluence XML package to version 9.48.1.

v1.21.1

v1.21.0

  • #142: Don't save unchanged prefilled configuration in migration documents
  • #141: Prefix all confluence macros by default with a few exceptions
  • #140: Add a converter for net-presago-stream-macro to msStream
  • #138: Add a converter for view-file, viewfile and view-* macros

Update dependency on the Confluence XML package to version 9.48.0, which notably adds support for emoji imports.

v1.20.2

Tasks done:

  • #137 Add the Task Application macro converters to the converters module

v1.20.1

  • #134: Make sure the "Users wiki" parameter correctly references global users/groups on migrated permission objects
  • #136: All modules are called "Confluence Migrator Application (Pro)"

v1.20.0

  • #132: Gather all converters into the Confluence Migrator Pro
  • #133: Convert the Multiexceprt family of macros

v1.19.1

  • #129: Selecting a package fails because of a cast error

v1.19.0

  • #126: Skip the space selection screen when there is only one space in the Confluence package
  • #127: Reports can't show migrated spaces when the space question screen was skipped 
  • #128: Allow leaving out file:// when specifying a server path as a source package

v1.18.0

  • #125: Convert pagetreesearch to locationSearch

v1.17.0

  • #123: Convert livesearch macros into search location macros

v1.16.2

Fixes:

  • #122: The state of migrations which died is misrepresented in the migration list and on the report page 

Update dependency on the Confluence XML package to version 9.47.0, which starts supporting exports from Confluence 8.X.

v1.16.1

  • #89: Stack traces are on one single line in job logs
  • #90: Stack traces from job logs are hard to copy paste
  • #120: Huge logs are causing out of memory (heap space) exceptions in migration pages

v1.16.0

  • #119: Store huge json objects in attachments instead of object fields in MigrationClass

v1.15.0

Fixes:

  • #99: Don't depend on Pro Macro's expand macro
  • #70: Get rid of the nested page migrator
  • #116: Incorrect naming of the brokenLinksPages property in MigrationClass breaks XAR import and exports of migration pages
  • #118: The Confluence page id of page affected by broken links is sometimes given instead a friendly link to the imported page
  • #117: Incorrectly resolved documents make it looks like pages where imported into the ConfluenceMigratorPro space

Update dependency on the Confluence XML package to version 9.46.0, which tries to import pages even when they contain a bad revision.

v1.14.1

Update dependency on the Confluence XML package to version 9.45.0, which fixes group rights issues due to spaces being converted to underscores in group names.

v1.14.0

New features:

  • #53: Add the ability to interrupt a migration
  • #108: Sort migrations by creation date (most recent first)

Fixes:

  • #45: Green "Migration complete" message shown when clicking on cancel
  • #101: Migrations restart when an exception is thrown in the Confluence Migrator Pro code

Update dependency on the Confluence XML package to version 9.44.0, which fix a view right propagation issue.

v1.13.2

Update dependency on the Confluence XML package to version 9.43.0, which fix a view right propagation issue.

v1.13.1

  • #111: Ignore events related to migrations not started with Confluence Migrator Pro 
  • #110: Errors should be qualified critical
  • #109: The "non-critical" qualification of issues is unfortunate 
  • #112: Support page ids in link mappings

Update dependency on the Confluence XML package to version 9.42.0, which fix a view right propagation issue.

v1.13.0

Update dependency on the Confluence XML package to version 9.41.0, which fix a view right propagation issue.

v1.12.1

  • #106: Link Mapping is updated when option " Use saved link mapping", not "Update link mapping", is  checked

v1.12.0

  • #103: Rights-only migration triggers an exception which restarts the migration
  • #104: Log contents are interpreted as XWiki syntax
  • #105: Use link mapping to avoid broken links with space exports
  • #100: Pro Macros marked as unsupported when they actually are

Update dependency on the Confluence XML package to version 9.40.0.

v1.11.14

  • #66: Hide the "Not supported macros" section if there are none

v1.11.13

  • #98: Class cast exception causing infinite migration restarts

v1.11.12

Update dependency on the Confluence XML package to version 9.39.3.

v1.11.11

Fixes:

  • #97: Broken link table is displayed as raw HTML
  • #95: NPE during some migration because of null log marker
  • #96: Space names are incorrectly escaped in the report

v1.11.10

  • #87: Dedicate a section to broken link warnings
  • #94: Visiting a migrated space from the migration report is not easy
  • #93: Missing object only output filter stream descriptor
  • #85: Space selection search usually finds nothing when upper case characters are typed
  • #63: Add detailed description for the "GROUP NAME MAPPING" field on Advanced Migration Options

Update dependency on the Confluence XML package to version 9.39.2.

This release is unusable, please upgrade to the next.

v1.11.9

Fixes:

  • #80: Group name prefix and Group name suffix output stream parameters don't work
  • #82: Add children to the macros prefixed by default
  • #83: Hide the output filter stream parameters from the UI

Update dependency on the Confluence XML package to version 9.39.1.

v1.11.8

Update dependency on the Confluence XML package to version 9.39.0.

v1.11.7

Update dependency on the Confluence XML package to version 9.38.2.

v1.11.6

Update dependency on the Confluence XML package to version 9.37.1.

v1.11.5

Fixes:

  • #79:The wrong document tree is shown in the migration report when using the root space feature 

v1.11.4

Update dependency on the Confluence XML package to version 9.37.0.

Improvements:

  • #65: Allow cleaning group pages names when migrating confluence rights

Fixes:

  • #78: MigrationClass uses wiki syntax and WYSISWG for fields storing JSON

v1.11.3

Update dependency on the Confluence XML package to version 9.36.2.

Improvements:

  • #73: Display warning and error counts Type: New Feature
  • #74: Display dates in the migration job log after it finished
  • #77: Display the imported document count

Fixes:

  • #76: Don't make the users wait for the package to be cleaned up
  • #75: When prefilling configuration from a previous migration, package selection is ignored

v1.11.2

Improvements:

  • #72 Upgrade Licensor dependency to version 1.25

v1.11.1

Update dependency on the Confluence XML package to version 9.36.1.

Improvements:

  • #71 Don't wait for the Solr queue to be empty when not using NPMIG

v1.11.0

Update dependency on the Confluence XML package to version 9.35.1 allowing:

New features:

  • #69 Directly import as nested spaces instead of using the nested page migrator by default

Bug fixes:

  • #37 Add the option to overwrite pages
  • #50 Page modification dates are not correctly migrated into XWiki
  • #54 No logs during user import
  • #62 Import Confluence regular pages as children of root spaces
  • #68 WebPreferences document is visible after import

This is an important release that changes three important  things (besides various improvements):

  • The nested page migration ("conversion") step is now skipped by default. Pages are now directly nested. This should provide important performance improvements.
  • The root pages of imported spaces are now the home Confluence page, and not the space description as it was until now. The space description was often empty, leading to a confusing state where the root of spaces was an empty page and then under it the home page, and then under the home page, regular pages.
  • You can now create a migration from a given document, effectively letting you "restart" a migration, using the "object id range" property.

v1.10.0

New feature:

  • #32 As part of the migration report of a Confluence package, list the Confluence macros that are missing in XWiki

 Update dependency on the Confluence XML package to version 9.34.1

v1.9.4

Bugs fixed:

  • #61 Selecting a package from the server is only possible when migrations have already been done

v1.9.3

New feature:

  • #60 Selecting a package from the server is only possible when migrations have already been done

Update dependency on the Confluence XML package to version 9.33.1

v1.9.2

Update dependency on the Confluence XML package to version 9.33.0.

v1.9.1

Bugs fixed:

  • #57 NPE when a page title is missing (crash)

v1.9

New feature:

  • #56 Add an option to skip questions

Update dependency on the Confluence XML package to version 9.32.0.
 

 

v1.8.3

Bugs fixed:

  • #24 The imported pages list is reported as empty when migrating on a subwiki
  • #47 Missing history comments

v1.8.2

Update dependency on the Confluence XML package to version 9.31.3

v1.8.1

Update dependency on the Confluence XML package to version 9.31.1

v1.8.0

Update dependency on the Confluence XML package to version 9.31.0, which disable migration of archived space by default, and provides parameters to enable migration of archived spaces and documents.

v1.7.9

Update dependency on the Confluence XML package to version 9.29.6, which improves performance of the step right after creating a migration and before the space selection a lot.

v1.7.8

Update dependency on the Nested Page Migrator to version 0.10.1

v1.7.7

Update dependency on the Confluence XML package to version 9.29.5

v1.7.6

Update dependency on the Confluence XML package to version 9.29.3
 

v1.7.5

  • Update dependency on the Confluence XML package to version 9.29.2
  • Fix #41

v1.7.4

Dependency upgrades: Confluence XML package to version 9.29.1 and Licensor to version 1.24.4.

v1.7.3

Fix:

  • #42: Javascript error about XWiki.FileUploader not being defined on migration pages
  • #44: Input and output filter stream parameters are not always respected

Improvements:

  • #28: Remove SORL queue line in prerequisites and make the process automatic
  • #33: Automate listener deactivation when a migration starts

Tasks:

  • #34: Remove notifications prerequisites

v1.7.2

Fix:

  • #35 Output filter property "Preserve version" is incorrectly set to false by default

v1.7.1

Fix:

v1.7.0

Improvements:

#26 Add the option to specify path to the Confluence export in the server

Tasks:

#27 Rename Step 2 in "Choose an export package"

v1.6.0

Improvements:

#17 Maintain image width and height set in Confluence

Uses version 9.29.0 of Confluence XML

Tasks:

#29 Upgrade Licensor dependency to version 1.24.3

v1.5.0

Improvements:

Uses version 9.28.0 of Confluence XML

v1.4.0

Improvements:

Uses version 9.27.0 of Confluence XML

v1.3.0

Improvements:

Uses version 9.26.0 of Confluence XML

v1.2.0

Bugs fixed:

#25 Space selection does not filter out blogs from other spaces #25

Improvements:

Uses version 9.25.0 of Confluence XML which supports blog-only migrations and adf extensions (the note macro)

v1.1.0

Bugs fixed:

#18 Cannot use the migrator on subwikis

Improvements:

#20 Support permissions migration

Tasks:

#19 Support Blog Posts migration

v1.0.1

Bugs fixed:

#14 The pro migrator is not working for free licenses
#15 The license manager fails to initialize after the Confluence Migrator Pro is installed and XWiki is restarted

 

v1.0

First version of the application containing the following functionalities:

  • homepage with prerequisites, backup packages and reports on previous migrations,
  • multi space migration,
  • run multiple migration simultaneously 
  • import configuration 
  • detailed report showing the pages imported successfully, along with the ones affected by errors

Extension details

Information

This information is only displayed to Administrators. Your users can't see this tab.

License

  • GNU Lesser General Public License 2.1

Sources

Issues

Type

  • xar

Developed by

Compatibility

  • Requires false or above.
Success

Installable with the Extension Manager

Dependencies

  • com.xwiki.confluencepro:application-confluence-migrator-pro-default 1.42.1
  • com.xwiki.confluencepro:application-confluence-migrator-pro-converters 1.42.1
  • com.xwiki.confluencepro:application-confluence-migrator-pro-reference-fixer-ui 1.42.1
  • org.xwiki.contrib.listeneradmin:application-listener-admin-ui 1.0.2
  • com.xwiki.licensing:application-licensing-licensor-api 1.32.3
  • org.xwiki.platform:xwiki-platform-rendering-macro-velocity 15.10
  • org.xwiki.platform:xwiki-platform-display-html 15.10
  • org.xwiki.platform:xwiki-platform-livedata-macro 15.10
  • org.xwiki.platform:xwiki-platform-filter-script 15.10
  • org.xwiki.contrib:scriptcomponent 1.1.1
  • org.xwiki.contrib:macro-job 2.2.2
  • com.xwiki.confluencepro:application-confluence-migrator-pro-metadata-ui 1.42.1
  • org.xwiki.contrib:application-favorites-default 1.4.2