WIP: FAQ- HTML Macro for Confluence Cloud

Overview

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

FAQ

What happens to content when you uninstall an HTML plugin in Confluence Cloud?

Composition for Confluence requires an active app subscription, so uninstalling this information will be lost on the front end but 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>

Is the hosting infrastructure for the HTML Macro plugin the same as that for other Appfire apps like Create On Transition for Jira?

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.
SUPPORT-87374 - Getting issue details... STATUS

Is it possible to determine the number of users/groups using an app available to all users in our Jira instance?

Unfortunately, there isn't a direct way to track the exact number of users utilizing 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. Please refer to the steps outlined in the screenshot below to gain insights into the plugin's usage patterns.

Or you can perform an advanced search for the macro name (see below), giving you a general idea of how many pages it has been used on. This won’t 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 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 will need to add the below search after your instance URL. The first will give you all pages that have the HTML macro on it 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

Can the HTML Macro for Confluence Cloud be migrated to a new cloud instance?

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

How to do cloud to cloud migration?

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

Export the Confluence spaces from the source instance.
Import the Confluence spaces into the target instance.
Verify that the HTML for Confluence is working as expected.

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