FAQs: HTML Macro for Confluence Cloud App

Owned by Priyal Jaiswal
Last updated: May 23, 2024 by Amith Mathur
2 min read

Overview

This article provides answers to a few frequently asked questions regarding the HTML Macro for the Confluence Cloud app.

FAQ

HTML Macro for Confluence Cloud requires an active app subscription, so uninstalling it will lose this information on the front end, but it will be made available on the back end in the page’s storage format.

The body of the macro will not be lost if the plugin is not installed. It is Storage Format markup that is persisted by Confluence.

View the Storage Format for a page containing an HTML macro, and you can see that:

<ac:structured-macro ac:name="html-macro" ac:schema-version="1" data-layout="default" ac:macro-id="2be30073-6c34-41aa-9a35-bcc801e8eac8"><ac:plain-text-body><![CDATA[<b>Hello</b>]]></ac:plain-text-body></ac:structured-macro>

The HTML Macro is currently hosted in the United States, and yes, the Create On Transition app is also hosted in the U.S. However, it will soon have multi-region support.

Unfortunately, there isn't a direct way to track the exact number of users using this plugin, as it is embedded within Confluence pages. However, you can monitor the frequency of its usage and the specific pages where it is employed. Refer to the steps outlined in the screenshot below to gain insights into the app’s usage patterns.

image-20240506-051143.png

Or you can perform an advanced search for the macro name (see below), which will give you a general idea of how many pages it has been used on. This will not consider pages you can’t see or if the app is used multiple times on a page.

ac:name="html-macro"

 

Here is another process provided by Atlassian to search the usage of macros via API; refer to the below documents:

https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/ https://developer.atlassian.com/cloud/confluence/rest/intro/#status-code

To use the API search function, you must add the below search after your instance URL. The first will give you all pages with the HTML macro up to the 1st 25 uses. The second raises the limit to 250.

/wiki/rest/api/content/search?cql=macro=%27html-macro%27 /wiki/rest/api/content/search?cql=macro=%27html-macro%27&limit=250

 

Yes, it is possible to migrate the HTML Macro for Confluence Cloud from one cloud instance to another

Prerequisites:

  • Install the HTML Macro for Confluence Cloud on both sites.

  • Provide a separate license for HTML Macro for Confluence Cloud in each Cloud site.

Steps

  1. Export the Confluence spaces from the source instance.

  2. Import the Confluence spaces into the target instance.

  3. Verify that the HTML for Confluence is working as expected.

  • Test your migration in a non-production environment before migrating your live instance.