Adding a Configuration UI for your Plugin

Purpose of the Configuration UI

A plugin can present configurable settings to Atlassian instance administrators. This is useful where your plugin requires configuration or user-specific settings to work.

Here are some examples of plugins which provide a configuration UI:

• The Google Maps plugin for Confluence requires a Google API Key from Google, which needs to be configured on each server before it will work properly.
• The WebDAV plugin for Confluence provides a configuration screen that is available both from the UPM and from a web item in the Administration menu.

In Configuring the Plugin Descriptor, we tell you how to create the XML descriptor file for your plugin. In Plugin Modules, we tell you how to define the modules within your plugin. Below is information on defining the links to the configuration UI for your plugin.

Adding a Configuration Link for the Entire Plugin

To add a configuration link for your plugin as a whole, place a single param element with the name configure.url within the plugin-info element at the top of the plugin descriptor:

1
2
<plugin-info>
    <description>A macro which displays Google maps within a Confluence page.</description>
    <vendor name="Atlassian Software Systems Pty Ltd" url="http://www.atlassian.com/"/>
    <version>0.1</version>
    <param name="configure.url">/admin/plugins/gmaps/configurePlugin.action</param>
</plugin-info>

This param element causes a button with the Configure label to appear in the details view for the plugin in the 'Manage Add-ons' page. The URL value identifies the page the contains the configuration form. For more information about implementing a configuration UI, see the Creating an Admin Configuration Form tutorial.

Notes

• Configuration links are relative to the application.
• The configuration URL is a link to a separate page, which you have defined using one of the following:
  • A new Struts action that you have defined via a Struts plugin module.
  • Or a servlet defined via a Servlet plugin module.
• Not all applications support configuration links, so you may need to create a web item link in the administration menu to link to your configuration page.

RELATED TOPICS

Writing Confluence Plugins

• Creating your Plugin Descriptor
• Accessing Confluence Components from Plugin Modules
• Including Javascript and CSS resources
• Adding Plugin and Module Resources
• Adding a Configuration UI for your Plugin
• Using Standard Page Decorators
• Making your Plugin Modules State Aware
• Form Token Handling
• Converting a Plugin to Plugin Framework 2
• Enabling TinyMCE Plugins

Information sourced from Plugin Framework documentation