How to migrate a macro 3x to 4x in existing content


A customer just migrated from a 3.5 to a 5.8 version of Confluence.

Unfortunately the macro migration failed and the wiki pages now contain the old version of the macro:

  <ac:structured-macro ac:macro-id="08531f28-34b3-41b9-8297-0a85e7b1be97" ac:name="mockup" ac:schema-version="1">
    <ac:parameter ac:name="1">28</ac:parameter>
    <ac:parameter ac:name="">test</ac:parameter>

And this is how it should look like in order for the plugin content to be displayed properly:

<ac:structured-macro ac:macro-id="08531f28-34b3-41b9-8297-0a85e7b1be97" ac:name="mockup" ac:schema-version="1"> 
<ac:parameter ac:name="Version">28</ac:parameter>
<ac:parameter ac:name="Name">test</ac:parameter>


Unfortunately the rolling back to 3.5 is not an option.

Is there a way to convert the macro in existing content outside the migration process (e.g. some sort of script)?

2 answers

1 accepted

3 votes
Stephen Deutsch Community Champion Oct 08, 2015

Since the macro values are dynamic, it could be that a standard search/replace might not work.  However, Confluence's storage format is (more or less) valid XML, so you can use the browser engine to parse it via Javascript.  This is what I was able to throw together, but I can't guarantee it will work on all pages:

    url: contextPath + "/rest/api/content/" + AJS.params.pageId + "?,version,ancestors",
    success: function(response) {
        bodyText = "&lt;xml&gt;" + + "&lt;/xml&gt;";
        xmlBodyText = bodyText
        xmlDoc = jQuery.parseXML(xmlBodyText);
        xml = jQuery(xmlDoc);
        macro = xml.find('ac--structured-macro[ac--name="mockup"]');
        jQuery(macro).each(function() {
            jQuery(this).find("ac--parameter").eq(0).attr("ac--name", "Version");
            jQuery(this).find("ac--parameter").eq(1).attr("ac--name", "Name");
        ser = new XMLSerializer();
        newBodyText = ser.serializeToString(xml[0]);
        newBodyText = newBodyText
            .split("/&gt;").join(" /&gt;")
            .split("qquuoott").join("&amp;quot;"); = newBodyText;
        response.version.number += 1;
            contentType: 'application/json',
            type: 'PUT',
            url: contextPath + "/rest/api/content/" + AJS.params.pageId,
            data: JSON.stringify(response),
            success: function(response) {
            error: function(response) {

You can paste this JS in the browser console, and it should be able to replace the macro parameters in the page with the proper values.  It only works on a page-by-page basis, but it should be easily adaptable to search for all pages containing the macro.

EDIT: Forgot to include "ancestors" in the URL string (needed in order to keep the same place in the page hierarchy)

Thanks Stephen! I will pass the info to the customer. Great support!

You could try using the Search and Replace plugin or Bob Swift's How to globally search and modify content to replace the parameters with the correctly named ones.

If you decide to use the plugin, feel free to ask for more help here.

Best, Lukas

Suggest an answer

Log in or Sign up to answer
How to earn badges on the Atlassian Community

How to earn badges on the Atlassian Community

Badges are a great way to show off community activity, whether you’re a newbie or a Champion.

Learn more
Community showcase
Published Thursday in Confluence

Three common content challenges + how to manage them

An efficient enterprise content management system, or ECM, is a must-have for companies that create work online (cough   cough, all companies). If content calendars, marketing plans, and bu...

92 views 0 6
Read article

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you