Confluence User Macro Dynamic Parameter Descriptions

[Jonathan Martin]

I've persisted some plugin configuration data using the PluginSettingsFactory interface. I'm able to access the values of this data in my com.atlassian.confluence.macro.Macro implementation class by injecting the PluginSettingsFactory interface.

However, I'd like to use some of this configuration data in the description of one of the parameters for the form displayed on my user macro.

I've looked into using AJS.MacroBrowser.setMacroJsOverride("<macro-name>", jsOverrides) on the client. This allows me to manipulate the description field but I need to have access to the configurable data.

Is there anyway I can get to the PluginSettingsFactory data in my client JS? Or better yet, is there any way I could manipulate the parameter description before the form is rendered on the server?

I've been searching the Google, Confluence API and reference docs for half a day. I'm sure there's a simple solution just not sure what it is.

Any help is greatly appreciated.

[Jonathan Martin · Accepted solution]

I was able to read through the code mentioned under the "Transforms that do variable injection" heading and can now access my configurable data on the client.

https://developer.atlassian.com/display/DOCS/Stateless+web-resource+transforms+and+conditions

[Jonathan Martin]

I am able to access the data I need but now would like the data to only be available in the context of my plugin. Otherwise I'm hitting the database with every request when the data isn't needed in every request. Right now I'm using the atl.general context as follows:

<web-resource key="product-blueprint-plugin-data">
 <context>atl.general</context>
        <dependency>com.atlassian.plugins.atlassian-plugins-webresource-plugin:data</dependency>
        <data key="product-blueprint-plugin-data" class="<my-root-package>.confluence.plugins.productblueprint.ProductBlueprintPluginDataProvider" />
        <resource type="download" name="product-blueprint-plugin-data.js" location="<my-root-path>/confluence/plugins/productblueprint/js/plugin-data.js" />
</web-resource>

I found that this article under the "Introducing new contexts" heading mentions referencing a new context in a Velocity template. However, it appears that doing this doesn't include the macro's param form as part of the context so I can't access my data.

Any help would be greatly appreciated.

[Jonathan Martin]

I should have read a little further in the article mentioned above. There are some more specific Confluence contexts. I settled on the "macro-browser" context. It still looks like it's called with every page just not as many times as with the "atl.general" context.

It'd be nice if there was a context for the "macro-preivew" dialog.